src/Buy/Browse/V1/Model/Taxes.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);
/**
* Taxes.
*
* PHP version ^7.2 || ^8.0
*
* @category Class
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*/
/**
* Browse API.
*
* <p>The Browse API has the following resources:</p> <ul> <li><b> item_summary: </b> Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.</li> <li><b> search_by_image: </b><a href=\"https://developer.ebay.com/api-docs/static/versioning.html#experimental \" target=\"_blank\"><img src=\"/cms/img/docs/experimental-icon.svg\" class=\"legend-icon experimental-icon\" alt=\"Experimental Release\" title=\"Experimental Release\" /> (Experimental)</a> Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.</li> <li><b> item: </b> <ul><li>Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.</li> <li>Provides a bridge between the eBay legacy APIs, such as <b> Finding</b>, and the RESTful APIs, which use different formats for the item IDs.</li> </ul> </li> <li> <b> shopping_cart: </b> <a href=\"https://developer.ebay.com/api-docs/static/versioning.html#experimental \" target=\"_blank\"><img src=\"/cms/img/docs/experimental-icon.svg\" class=\"legend-icon experimental-icon\" alt=\"Experimental Release\" title=\"Experimental Release\" /> (Experimental)</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> Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart. <b> Note: </b> This resource is not available in the eBay API Explorer.</li></ul> <p>The <b> item_summary</b>, <b> search_by_image</b>, and <b> item</b> resource calls require an <a href=\"/api-docs/static/oauth-client-credentials-grant.html\">Application access token</a>. The <b> shopping_cart</b> resource calls require a <a href=\"/api-docs/static/oauth-authorization-code-grant.html\">User access token</a>.</p>
*
* The version of the OpenAPI document: v1.18.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\Buy\Browse\V1\Model;
use TNT\Ebay\Buy\Browse\V1\ObjectSerializer;
/**
* Taxes Class Doc Comment.
*
* @category Class
*
* @description The type that defines the tax fields.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class Taxes implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'Taxes';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'ebay_collect_and_remit_tax' => 'bool',
'included_in_price' => 'bool',
'shipping_and_handling_taxed' => 'bool',
'tax_jurisdiction' => '\TNT\Ebay\Buy\Browse\V1\Model\TaxJurisdiction',
'tax_percentage' => 'string',
'tax_type' => '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 = [
'ebay_collect_and_remit_tax' => null,
'included_in_price' => null,
'shipping_and_handling_taxed' => null,
'tax_jurisdiction' => null,
'tax_percentage' => null,
'tax_type' => 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 = [
'ebay_collect_and_remit_tax' => 'ebayCollectAndRemitTax',
'included_in_price' => 'includedInPrice',
'shipping_and_handling_taxed' => 'shippingAndHandlingTaxed',
'tax_jurisdiction' => 'taxJurisdiction',
'tax_percentage' => 'taxPercentage',
'tax_type' => 'taxType',
];
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @var string[]
*/
protected static $setters = [
'ebay_collect_and_remit_tax' => 'setEbayCollectAndRemitTax',
'included_in_price' => 'setIncludedInPrice',
'shipping_and_handling_taxed' => 'setShippingAndHandlingTaxed',
'tax_jurisdiction' => 'setTaxJurisdiction',
'tax_percentage' => 'setTaxPercentage',
'tax_type' => 'setTaxType',
];
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @var string[]
*/
protected static $getters = [
'ebay_collect_and_remit_tax' => 'getEbayCollectAndRemitTax',
'included_in_price' => 'getIncludedInPrice',
'shipping_and_handling_taxed' => 'getShippingAndHandlingTaxed',
'tax_jurisdiction' => 'getTaxJurisdiction',
'tax_percentage' => 'getTaxPercentage',
'tax_type' => 'getTaxType',
];
/**
* 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['ebay_collect_and_remit_tax'] = $data['ebay_collect_and_remit_tax'] ?? null;
$this->container['included_in_price'] = $data['included_in_price'] ?? null;
$this->container['shipping_and_handling_taxed'] = $data['shipping_and_handling_taxed'] ?? null;
$this->container['tax_jurisdiction'] = $data['tax_jurisdiction'] ?? null;
$this->container['tax_percentage'] = $data['tax_percentage'] ?? null;
$this->container['tax_type'] = $data['tax_type'] ?? 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 ebay_collect_and_remit_tax.
*
* @return bool|null
*/
public function getEbayCollectAndRemitTax()
{
return $this->container['ebay_collect_and_remit_tax'];
}
/**
* Sets ebay_collect_and_remit_tax.
*
* @param bool|null $ebay_collect_and_remit_tax this field is only returned if <code>true</code>, and indicates that eBay will collect tax (sales tax, Goods and Services tax, or VAT) for at least one line item in the order, and remit the tax to the taxing authority of the buyer's residence
*
* @return self
*/
public function setEbayCollectAndRemitTax($ebay_collect_and_remit_tax)
{
$this->container['ebay_collect_and_remit_tax'] = $ebay_collect_and_remit_tax;
return $this;
}
/**
* Gets included_in_price.
*
* @return bool|null
*/
public function getIncludedInPrice()
{
return $this->container['included_in_price'];
}
/**
* Sets included_in_price.
*
* @param bool|null $included_in_price this indicates if tax was applied for the cost of the item
*
* @return self
*/
public function setIncludedInPrice($included_in_price)
{
$this->container['included_in_price'] = $included_in_price;
return $this;
}
/**
* Gets shipping_and_handling_taxed.
*
* @return bool|null
*/
public function getShippingAndHandlingTaxed()
{
return $this->container['shipping_and_handling_taxed'];
}
/**
* Sets shipping_and_handling_taxed.
*
* @param bool|null $shipping_and_handling_taxed this indicates if tax is applied for the shipping cost
*
* @return self
*/
public function setShippingAndHandlingTaxed($shipping_and_handling_taxed)
{
$this->container['shipping_and_handling_taxed'] = $shipping_and_handling_taxed;
return $this;
}
/**
* Gets tax_jurisdiction.
*
* @return \TNT\Ebay\Buy\Browse\V1\Model\TaxJurisdiction|null
*/
public function getTaxJurisdiction()
{
return $this->container['tax_jurisdiction'];
}
/**
* Sets tax_jurisdiction.
*
* @param \TNT\Ebay\Buy\Browse\V1\Model\TaxJurisdiction|null $tax_jurisdiction tax_jurisdiction
*
* @return self
*/
public function setTaxJurisdiction($tax_jurisdiction)
{
$this->container['tax_jurisdiction'] = $tax_jurisdiction;
return $this;
}
/**
* Gets tax_percentage.
*
* @return string|null
*/
public function getTaxPercentage()
{
return $this->container['tax_percentage'];
}
/**
* Sets tax_percentage.
*
* @param string|null $tax_percentage the percentage of tax
*
* @return self
*/
public function setTaxPercentage($tax_percentage)
{
$this->container['tax_percentage'] = $tax_percentage;
return $this;
}
/**
* Gets tax_type.
*
* @return string|null
*/
public function getTaxType()
{
return $this->container['tax_type'];
}
/**
* Sets tax_type.
*
* @param string|null $tax_type This field indicates the type of tax that may be collected for the item. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:TaxType'>eBay API documentation</a>
*
* @return self
*/
public function setTaxType($tax_type)
{
$this->container['tax_type'] = $tax_type;
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));
}
}