src/Sell/Logistics/V1/Model/ContactAddress.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);
/**
* ContactAddress.
*
* PHP version ^7.2 || ^8.0
*
* @category Class
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*/
/**
* Logistics API.
*
* <span class=\"tablenote\"><b>Note:</b> This is a <a href=\"https://developer.ebay.com/api-docs/static/versioning.html#limited\" target=\"_blank\"> <img src=\"/cms/img/docs/partners-api.svg\" class=\"legend-icon partners-icon\" title=\"Limited Release\" alt=\"Limited Release\" />(Limited Release)</a> API available only to select developers approved by business units.</span><br /><br />The <b>Logistics API</b> resources offer the following capabilities: <ul><li><b>shipping_quote</b> – Consolidates into a list a set of live shipping rates, or quotes, from which you can select a rate to ship a package.</li> <li><b>shipment</b> – Creates a \"shipment\" for the selected shipping rate.</li></ul> Call <b>createShippingQuote</b> to get a list of live shipping rates. The rates returned are all valid for a specific time window and all quoted prices are at eBay-negotiated rates. <br><br>Select one of the live rates and using its associated <b>rateId</b>, create a \"shipment\" for the package by calling <b>createFromShippingQuote</b>. Creating a shipment completes an agreement, and the cost of the base service and any added shipping options are summed into the returned <b>totalShippingCost</b> value. This action also generates a shipping label that you can use to ship the package. The total cost of the shipment is incurred when the package is shipped using the supplied shipping label. <p class=\"tablenote\"><b>Important!</b> Sellers must set up a payment method via their eBay account before they can use the methods in this API to create a shipment and the associated shipping label.</p>
*
* The version of the OpenAPI document: v1_beta.0.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\Logistics\V1\Model;
use TNT\Ebay\Sell\Logistics\V1\ObjectSerializer;
/**
* ContactAddress Class Doc Comment.
*
* @category Class
*
* @description This complex type specifies the details of a geographical address.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class ContactAddress implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'ContactAddress';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'address_line1' => 'string',
'address_line2' => 'string',
'city' => 'string',
'country_code' => '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_code' => 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_code' => 'countryCode',
'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_code' => 'setCountryCode',
'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_code' => 'getCountryCode',
'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_code'] = $data['country_code'] ?? 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 the street address
*
* @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 the street address. Use this field for additional address information, such as a suite or apartment number.
*
* @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 address is located
*
* @return self
*/
public function setCity($city)
{
$this->container['city'] = $city;
return $this;
}
/**
* Gets country_code.
*
* @return string|null
*/
public function getCountryCode()
{
return $this->container['country_code'];
}
/**
* Sets country_code.
*
* @param string|null $country_code The country of the address, 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. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/logistics/types/bas:CountryCodeEnum'>eBay API documentation</a>
*
* @return self
*/
public function setCountryCode($country_code)
{
$this->container['country_code'] = $country_code;
return $this;
}
/**
* Gets county.
*
* @return string|null
*/
public function getCounty()
{
return $this->container['county'];
}
/**
* Sets county.
*
* @param string|null $county The county (not country) in which the address is located. Counties typically contain multiple cities or towns.
*
* @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 code of the address
*
* @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 or province in which the address is located. States and provinces often contain multiple counties.
*
* @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));
}
}