src/Sell/Account/V1/Model/Address.php
<?php
/**
* This file is part of the trollandtoad/ebay-sdk-php package.
*
* MIT License
*
* Copyright (c) 2022 Brandon Clothier
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/
declare(strict_types=1);
/**
* Address.
*
* PHP version ^7.2 || ^8.0
*
* @category Class
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*/
/**
* Account API.
*
* The <b>Account API</b> gives sellers the ability to configure their eBay seller accounts, including the seller's policies (eBay business policies and seller-defined custom policies), opt in and out of eBay seller programs, configure sales tax tables, and get account information. <br/><br/>For details on the availability of the methods in this API, see <a href=\"/api-docs/sell/account/overview.html#requirements\">Account API requirements and restrictions</a>.
*
* The version of the OpenAPI document: v1.9.0
* Generated by: https://openapi-generator.tech
* OpenAPI Generator version: 5.4.0
*/
/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
namespace TNT\Ebay\Sell\Account\V1\Model;
use TNT\Ebay\Sell\Account\V1\ObjectSerializer;
/**
* Address Class Doc Comment.
*
* @category Class
*
* @description This type is used to define the physical address of an inventory location.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class Address implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'Address';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'address_line1' => 'string',
'address_line2' => 'string',
'city' => 'string',
'country' => 'string',
'county' => 'string',
'postal_code' => 'string',
'state_or_province' => 'string',
];
/**
* Array of property to format mappings. Used for (de)serialization.
*
* @var string[]
*
* @phpstan-var array<string, string|null>
*
* @psalm-var array<string, string|null>
*/
protected static $openAPIFormats = [
'address_line1' => null,
'address_line2' => null,
'city' => null,
'country' => null,
'county' => null,
'postal_code' => null,
'state_or_province' => null,
];
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @return array
*/
public static function openAPITypes()
{
return self::$openAPITypes;
}
/**
* Array of property to format mappings. Used for (de)serialization.
*
* @return array
*/
public static function openAPIFormats()
{
return self::$openAPIFormats;
}
/**
* Array of attributes where the key is the local name,
* and the value is the original name.
*
* @var string[]
*/
protected static $attributeMap = [
'address_line1' => 'addressLine1',
'address_line2' => 'addressLine2',
'city' => 'city',
'country' => 'country',
'county' => 'county',
'postal_code' => 'postalCode',
'state_or_province' => 'stateOrProvince',
];
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @var string[]
*/
protected static $setters = [
'address_line1' => 'setAddressLine1',
'address_line2' => 'setAddressLine2',
'city' => 'setCity',
'country' => 'setCountry',
'county' => 'setCounty',
'postal_code' => 'setPostalCode',
'state_or_province' => 'setStateOrProvince',
];
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @var string[]
*/
protected static $getters = [
'address_line1' => 'getAddressLine1',
'address_line2' => 'getAddressLine2',
'city' => 'getCity',
'country' => 'getCountry',
'county' => 'getCounty',
'postal_code' => 'getPostalCode',
'state_or_province' => 'getStateOrProvince',
];
/**
* Array of attributes where the key is the local name,
* and the value is the original name.
*
* @return array
*/
public static function attributeMap()
{
return self::$attributeMap;
}
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @return array
*/
public static function setters()
{
return self::$setters;
}
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @return array
*/
public static function getters()
{
return self::$getters;
}
/**
* The original name of the model.
*
* @return string
*/
public function getModelName()
{
return self::$openAPIModelName;
}
/**
* Associative array for storing property values.
*
* @var mixed[]
*/
protected $container = [];
/**
* Constructor.
*
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
{
$this->container['address_line1'] = $data['address_line1'] ?? null;
$this->container['address_line2'] = $data['address_line2'] ?? null;
$this->container['city'] = $data['city'] ?? null;
$this->container['country'] = $data['country'] ?? null;
$this->container['county'] = $data['county'] ?? null;
$this->container['postal_code'] = $data['postal_code'] ?? null;
$this->container['state_or_province'] = $data['state_or_province'] ?? null;
}
/**
* Show all the invalid properties with reasons.
*
* @return array invalid properties with reasons
*/
public function listInvalidProperties()
{
$invalidProperties = [];
return $invalidProperties;
}
/**
* Validate all the properties in the model
* return true if all passed.
*
* @return bool True if all properties are valid
*/
public function valid()
{
return count($this->listInvalidProperties()) === 0;
}
/**
* Gets address_line1.
*
* @return string|null
*/
public function getAddressLine1()
{
return $this->container['address_line1'];
}
/**
* Sets address_line1.
*
* @param string|null $address_line1 The first line of a street address. This field is required for store inventory locations that will be holding In-Store Pickup inventory. A street address is not required if the inventory location is not holding In-Store Pickup Inventory. This field will be returned if defined for an inventory location. <br/><br/><b>Max length</b>: 128
*
* @return self
*/
public function setAddressLine1($address_line1)
{
$this->container['address_line1'] = $address_line1;
return $this;
}
/**
* Gets address_line2.
*
* @return string|null
*/
public function getAddressLine2()
{
return $this->container['address_line2'];
}
/**
* Sets address_line2.
*
* @param string|null $address_line2 The second line of a street address. This field can be used for additional address information, such as a suite or apartment number. A street address is not required if the inventory location is not holding In-Store Pickup Inventory. This field will be returned if defined for an inventory location. <br/><br/><b>Max length</b>: 128
*
* @return self
*/
public function setAddressLine2($address_line2)
{
$this->container['address_line2'] = $address_line2;
return $this;
}
/**
* Gets city.
*
* @return string|null
*/
public function getCity()
{
return $this->container['city'];
}
/**
* Sets city.
*
* @param string|null $city The city in which the inventory location resides. This field is required for store inventory locations that will be holding In-Store Pickup inventory. For warehouse locations, this field is technically optional, as a <strong>postalCode</strong> can be used instead of <strong>city</strong>/<strong>stateOrProvince</strong> pair, and then the city is just derived from this postal/zip code. This field is returned if defined for an inventory location. <br/><br/><b>Max length</b>: 128
*
* @return self
*/
public function setCity($city)
{
$this->container['city'] = $city;
return $this;
}
/**
* Gets country.
*
* @return string|null
*/
public function getCountry()
{
return $this->container['country'];
}
/**
* Sets country.
*
* @param string|null $country The country in which the address resides, represented as two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html \" title=\"https://www.iso.org \" target=\"_blank\">ISO 3166</a> country code. For example, <code>US</code> represents the United States, and <code>DE</code> represents Germany. <br/><br/><b>Max length</b>: 2 For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/CountryCodeEnum\"'>eBay API documentation</a>
*
* @return self
*/
public function setCountry($country)
{
$this->container['country'] = $country;
return $this;
}
/**
* Gets county.
*
* @return string|null
*/
public function getCounty()
{
return $this->container['county'];
}
/**
* Sets county.
*
* @param string|null $county The county in which the address resides. This field is returned if defined for an inventory location.
*
* @return self
*/
public function setCounty($county)
{
$this->container['county'] = $county;
return $this;
}
/**
* Gets postal_code.
*
* @return string|null
*/
public function getPostalCode()
{
return $this->container['postal_code'];
}
/**
* Sets postal_code.
*
* @param string|null $postal_code The postal/zip code of the address. eBay uses postal codes to surface In-Store Pickup items within the vicinity of a buyer's location, and it also user postal codes (origin and destination) to estimate shipping costs when the seller uses calculated shipping. A <strong>city</strong>/<strong>stateOrProvince</strong> pair can be used instead of a <strong>postalCode</strong> value, and then the postal code is just derived from the city and state/province. This field is returned if defined for an inventory location. <br/><br/><b>Max length</b>: 16
*
* @return self
*/
public function setPostalCode($postal_code)
{
$this->container['postal_code'] = $postal_code;
return $this;
}
/**
* Gets state_or_province.
*
* @return string|null
*/
public function getStateOrProvince()
{
return $this->container['state_or_province'];
}
/**
* Sets state_or_province.
*
* @param string|null $state_or_province The state/province in which the inventory location resides. This field is required for store inventory locations that will be holding In-Store Pickup inventory. For warehouse locations, this field is technically optional, as a <strong>postalCode</strong> can be used instead of <strong>city</strong>/<strong>stateOrProvince</strong> pair, and then the state or province is just derived from this postal/zip code. <br/><br/><b>Max length</b>: 128
*
* @return self
*/
public function setStateOrProvince($state_or_province)
{
$this->container['state_or_province'] = $state_or_province;
return $this;
}
/**
* Returns true if offset exists. False otherwise.
*
* @param int $offset Offset
*/
public function offsetExists($offset): bool
{
return isset($this->container[$offset]);
}
/**
* Gets offset.
*
* @param int $offset Offset
*
* @return mixed|null
*/
#[\ReturnTypeWillChange]
public function offsetGet($offset)
{
return $this->container[$offset] ?? null;
}
/**
* Sets value based on offset.
*
* @param int|null $offset Offset
* @param mixed $value Value to be set
*/
public function offsetSet($offset, $value): void
{
if (null === $offset) {
$this->container[] = $value;
} else {
$this->container[$offset] = $value;
}
}
/**
* Unsets offset.
*
* @param int $offset Offset
*/
public function offsetUnset($offset): void
{
unset($this->container[$offset]);
}
/**
* Serializes the object to a value that can be serialized natively by json_encode().
*
* @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php
*
* @return mixed returns data which can be serialized by json_encode(), which is a value
* of any type other than a resource
*/
#[\ReturnTypeWillChange]
public function jsonSerialize()
{
return ObjectSerializer::sanitizeForSerialization($this);
}
/**
* Gets the string presentation of the object.
*
* @return string
*/
public function __toString()
{
return json_encode(
ObjectSerializer::sanitizeForSerialization($this),
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object.
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}