src/Sell/Account/V1/Model/SalesTax.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);
/**
* SalesTax.
*
* 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;
/**
* SalesTax Class Doc Comment.
*
* @category Class
*
* @description This type is used to provide sales tax settings for a specific tax jurisdiction.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class SalesTax implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'SalesTax';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'country_code' => 'string',
'sales_tax_jurisdiction_id' => 'string',
'sales_tax_percentage' => 'string',
'shipping_and_handling_taxed' => 'bool',
];
/**
* 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 = [
'country_code' => null,
'sales_tax_jurisdiction_id' => null,
'sales_tax_percentage' => null,
'shipping_and_handling_taxed' => 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 = [
'country_code' => 'countryCode',
'sales_tax_jurisdiction_id' => 'salesTaxJurisdictionId',
'sales_tax_percentage' => 'salesTaxPercentage',
'shipping_and_handling_taxed' => 'shippingAndHandlingTaxed',
];
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @var string[]
*/
protected static $setters = [
'country_code' => 'setCountryCode',
'sales_tax_jurisdiction_id' => 'setSalesTaxJurisdictionId',
'sales_tax_percentage' => 'setSalesTaxPercentage',
'shipping_and_handling_taxed' => 'setShippingAndHandlingTaxed',
];
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @var string[]
*/
protected static $getters = [
'country_code' => 'getCountryCode',
'sales_tax_jurisdiction_id' => 'getSalesTaxJurisdictionId',
'sales_tax_percentage' => 'getSalesTaxPercentage',
'shipping_and_handling_taxed' => 'getShippingAndHandlingTaxed',
];
/**
* 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['country_code'] = $data['country_code'] ?? null;
$this->container['sales_tax_jurisdiction_id'] = $data['sales_tax_jurisdiction_id'] ?? null;
$this->container['sales_tax_percentage'] = $data['sales_tax_percentage'] ?? null;
$this->container['shipping_and_handling_taxed'] = $data['shipping_and_handling_taxed'] ?? 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 country_code.
*
* @return string|null
*/
public function getCountryCode()
{
return $this->container['country_code'];
}
/**
* Sets country_code.
*
* @param string|null $country_code The country code enumeration value identifies the country to which this sales tax rate applies. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum'>eBay API documentation</a>
*
* @return self
*/
public function setCountryCode($country_code)
{
$this->container['country_code'] = $country_code;
return $this;
}
/**
* Gets sales_tax_jurisdiction_id.
*
* @return string|null
*/
public function getSalesTaxJurisdictionId()
{
return $this->container['sales_tax_jurisdiction_id'];
}
/**
* Sets sales_tax_jurisdiction_id.
*
* @param string|null $sales_tax_jurisdiction_id a unique ID that identifies the sales tax jurisdiction to which the salest tax rate applies (for example, a state within the United States)
*
* @return self
*/
public function setSalesTaxJurisdictionId($sales_tax_jurisdiction_id)
{
$this->container['sales_tax_jurisdiction_id'] = $sales_tax_jurisdiction_id;
return $this;
}
/**
* Gets sales_tax_percentage.
*
* @return string|null
*/
public function getSalesTaxPercentage()
{
return $this->container['sales_tax_percentage'];
}
/**
* Sets sales_tax_percentage.
*
* @param string|null $sales_tax_percentage The sales tax rate that will be applied to sales price. The <b>shippingAndHandlingTaxed</b> value will indicate whether or not sales tax is also applied to shipping and handling charges<br><br>Although it is a string, a percentage value is returned here, such as <code>7.75</code>
*
* @return self
*/
public function setSalesTaxPercentage($sales_tax_percentage)
{
$this->container['sales_tax_percentage'] = $sales_tax_percentage;
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 if returned as <code>true</code>, sales tax is also applied to shipping and handling charges, and not just the total sales price of the order
*
* @return self
*/
public function setShippingAndHandlingTaxed($shipping_and_handling_taxed)
{
$this->container['shipping_and_handling_taxed'] = $shipping_and_handling_taxed;
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));
}
}