src/Sell/Account/V2/Model/Rate.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);
/**
* Rate.
*
* PHP version ^7.2 || ^8.0
*
* @category Class
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*/
/**
* Rate Table API.
*
* This API allows sellers to retrieve and manage their custom shipping rate tables.
*
* The version of the OpenAPI document: 2.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\Account\V2\Model;
use TNT\Ebay\Sell\Account\V2\ObjectSerializer;
/**
* Rate Class Doc Comment.
*
* @category Class
*
* @description This container details shipping rate information identified by a unique rate ID. A successful call returns the requested shipping rate information.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class Rate implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'Rate';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'additional_cost' => '\TNT\Ebay\Sell\Account\V2\Model\Amount',
'rate_id' => 'string',
'shipping_category' => 'string',
'shipping_cost' => '\TNT\Ebay\Sell\Account\V2\Model\Amount',
'shipping_region_names' => 'string[]',
'shipping_service_code' => '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 = [
'additional_cost' => null,
'rate_id' => null,
'shipping_category' => null,
'shipping_cost' => null,
'shipping_region_names' => null,
'shipping_service_code' => 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 = [
'additional_cost' => 'additionalCost',
'rate_id' => 'rateId',
'shipping_category' => 'shippingCategory',
'shipping_cost' => 'shippingCost',
'shipping_region_names' => 'shippingRegionNames',
'shipping_service_code' => 'shippingServiceCode',
];
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @var string[]
*/
protected static $setters = [
'additional_cost' => 'setAdditionalCost',
'rate_id' => 'setRateId',
'shipping_category' => 'setShippingCategory',
'shipping_cost' => 'setShippingCost',
'shipping_region_names' => 'setShippingRegionNames',
'shipping_service_code' => 'setShippingServiceCode',
];
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @var string[]
*/
protected static $getters = [
'additional_cost' => 'getAdditionalCost',
'rate_id' => 'getRateId',
'shipping_category' => 'getShippingCategory',
'shipping_cost' => 'getShippingCost',
'shipping_region_names' => 'getShippingRegionNames',
'shipping_service_code' => 'getShippingServiceCode',
];
/**
* 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['additional_cost'] = $data['additional_cost'] ?? null;
$this->container['rate_id'] = $data['rate_id'] ?? null;
$this->container['shipping_category'] = $data['shipping_category'] ?? null;
$this->container['shipping_cost'] = $data['shipping_cost'] ?? null;
$this->container['shipping_region_names'] = $data['shipping_region_names'] ?? null;
$this->container['shipping_service_code'] = $data['shipping_service_code'] ?? 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 additional_cost.
*
* @return \TNT\Ebay\Sell\Account\V2\Model\Amount|null
*/
public function getAdditionalCost()
{
return $this->container['additional_cost'];
}
/**
* Sets additional_cost.
*
* @param \TNT\Ebay\Sell\Account\V2\Model\Amount|null $additional_cost additional_cost
*
* @return self
*/
public function setAdditionalCost($additional_cost)
{
$this->container['additional_cost'] = $additional_cost;
return $this;
}
/**
* Gets rate_id.
*
* @return string|null
*/
public function getRateId()
{
return $this->container['rate_id'];
}
/**
* Sets rate_id.
*
* @param string|null $rate_id The unique identifier for rate information.<br/><br/><span class=\"tablenote\"><strong>Note:</strong> This is a string that is automatically assigned by the system when a rate object is created.</span>
*
* @return self
*/
public function setRateId($rate_id)
{
$this->container['rate_id'] = $rate_id;
return $this;
}
/**
* Gets shipping_category.
*
* @return string|null
*/
public function getShippingCategory()
{
return $this->container['shipping_category'];
}
/**
* Sets shipping_category.
*
* @param string|null $shipping_category Indicates the level of shipping service to which the shipping rate information applies.<br/><br/>Available shipping categories are:<ul><li><b>ONE_DAY</b>: <i>This option is not supported when <b>shippingOptionType</b> is INTERNATIONAL.</i> </li><li><b>EXPEDITED</b></li><li><b>STANDARD</b></li><li><b>ECONOMY</b></li><li><b>EXPRESS</b>: <i>This option is supported only when <b>MarketplaceId</b> is <code>EBAY_DE</code> (Germany)</i></li></ul> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ShippingCategoryEnum'>eBay API documentation</a>
*
* @return self
*/
public function setShippingCategory($shipping_category)
{
$this->container['shipping_category'] = $shipping_category;
return $this;
}
/**
* Gets shipping_cost.
*
* @return \TNT\Ebay\Sell\Account\V2\Model\Amount|null
*/
public function getShippingCost()
{
return $this->container['shipping_cost'];
}
/**
* Sets shipping_cost.
*
* @param \TNT\Ebay\Sell\Account\V2\Model\Amount|null $shipping_cost shipping_cost
*
* @return self
*/
public function setShippingCost($shipping_cost)
{
$this->container['shipping_cost'] = $shipping_cost;
return $this;
}
/**
* Gets shipping_region_names.
*
* @return string[]|null
*/
public function getShippingRegionNames()
{
return $this->container['shipping_region_names'];
}
/**
* Sets shipping_region_names.
*
* @param string[]|null $shipping_region_names An array of Region names to which the shipping rate information applies.<br/><br/>Returned values may be:<ul><li>Geographical Regions (e.g., <code>Worldwide</code>, <code>Europe</code>, and <code>Middle East</code>)</li><li>Individual countries identified by a two-digit code such as <code>US</code> (United States), <code>CA</code> (Canada), and <code>GB</code> (United Kingdom)</li><li>US states and/or Canadian provinces identified by a two-digit code such as <code>NY</code> (New York) or <code>SK</code> (Saskatchewan)</li><li>Domestic Regions such as <code>AK/HI</code> (Alaska/Hawaii)</li></ul>
*
* @return self
*/
public function setShippingRegionNames($shipping_region_names)
{
$this->container['shipping_region_names'] = $shipping_region_names;
return $this;
}
/**
* Gets shipping_service_code.
*
* @return string|null
*/
public function getShippingServiceCode()
{
return $this->container['shipping_service_code'];
}
/**
* Sets shipping_service_code.
*
* @param string|null $shipping_service_code An enum value that indicates the shipping service used for the specified shipping rate. These enum values align with <b>ShippingService</b> metadata returned by a <b>GeteBayDetails</b> call with <b>DetailName</b> set to <code>shippingServiceDetails</code>.
*
* @return self
*/
public function setShippingServiceCode($shipping_service_code)
{
$this->container['shipping_service_code'] = $shipping_service_code;
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));
}
}