src/Buy/Browse/V1/Model/ItemReturnTerms.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);
/**
* ItemReturnTerms.
*
* 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;
/**
* ItemReturnTerms Class Doc Comment.
*
* @category Class
*
* @description The type that defines the fields for the seller's return policy.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class ItemReturnTerms implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'ItemReturnTerms';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'extended_holiday_returns_offered' => 'bool',
'refund_method' => 'string',
'restocking_fee_percentage' => 'string',
'return_instructions' => 'string',
'return_method' => 'string',
'return_period' => '\TNT\Ebay\Buy\Browse\V1\Model\TimeDuration',
'returns_accepted' => 'bool',
'return_shipping_cost_payer' => '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 = [
'extended_holiday_returns_offered' => null,
'refund_method' => null,
'restocking_fee_percentage' => null,
'return_instructions' => null,
'return_method' => null,
'return_period' => null,
'returns_accepted' => null,
'return_shipping_cost_payer' => 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 = [
'extended_holiday_returns_offered' => 'extendedHolidayReturnsOffered',
'refund_method' => 'refundMethod',
'restocking_fee_percentage' => 'restockingFeePercentage',
'return_instructions' => 'returnInstructions',
'return_method' => 'returnMethod',
'return_period' => 'returnPeriod',
'returns_accepted' => 'returnsAccepted',
'return_shipping_cost_payer' => 'returnShippingCostPayer',
];
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @var string[]
*/
protected static $setters = [
'extended_holiday_returns_offered' => 'setExtendedHolidayReturnsOffered',
'refund_method' => 'setRefundMethod',
'restocking_fee_percentage' => 'setRestockingFeePercentage',
'return_instructions' => 'setReturnInstructions',
'return_method' => 'setReturnMethod',
'return_period' => 'setReturnPeriod',
'returns_accepted' => 'setReturnsAccepted',
'return_shipping_cost_payer' => 'setReturnShippingCostPayer',
];
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @var string[]
*/
protected static $getters = [
'extended_holiday_returns_offered' => 'getExtendedHolidayReturnsOffered',
'refund_method' => 'getRefundMethod',
'restocking_fee_percentage' => 'getRestockingFeePercentage',
'return_instructions' => 'getReturnInstructions',
'return_method' => 'getReturnMethod',
'return_period' => 'getReturnPeriod',
'returns_accepted' => 'getReturnsAccepted',
'return_shipping_cost_payer' => 'getReturnShippingCostPayer',
];
/**
* 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['extended_holiday_returns_offered'] = $data['extended_holiday_returns_offered'] ?? null;
$this->container['refund_method'] = $data['refund_method'] ?? null;
$this->container['restocking_fee_percentage'] = $data['restocking_fee_percentage'] ?? null;
$this->container['return_instructions'] = $data['return_instructions'] ?? null;
$this->container['return_method'] = $data['return_method'] ?? null;
$this->container['return_period'] = $data['return_period'] ?? null;
$this->container['returns_accepted'] = $data['returns_accepted'] ?? null;
$this->container['return_shipping_cost_payer'] = $data['return_shipping_cost_payer'] ?? 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 extended_holiday_returns_offered.
*
* @return bool|null
*/
public function getExtendedHolidayReturnsOffered()
{
return $this->container['extended_holiday_returns_offered'];
}
/**
* Sets extended_holiday_returns_offered.
*
* @param bool|null $extended_holiday_returns_offered This indicates if the seller has enabled the Extended Holiday Returns feature on the item. Extended Holiday Returns are only applicable during the US holiday season, and gives buyers extra time to return an item. This 'extra time' will typically extend beyond what is set through the <b> returnPeriod</b> value.
*
* @return self
*/
public function setExtendedHolidayReturnsOffered($extended_holiday_returns_offered)
{
$this->container['extended_holiday_returns_offered'] = $extended_holiday_returns_offered;
return $this;
}
/**
* Gets refund_method.
*
* @return string|null
*/
public function getRefundMethod()
{
return $this->container['refund_method'];
}
/**
* Sets refund_method.
*
* @param string|null $refund_method An enumeration value that indicates how a buyer is refunded when an item is returned. <br><br><b> Valid Values: </b> MONEY_BACK or MERCHANDISE_CREDIT <br /><br />Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:RefundMethodEnum'>eBay API documentation</a>
*
* @return self
*/
public function setRefundMethod($refund_method)
{
$this->container['refund_method'] = $refund_method;
return $this;
}
/**
* Gets restocking_fee_percentage.
*
* @return string|null
*/
public function getRestockingFeePercentage()
{
return $this->container['restocking_fee_percentage'];
}
/**
* Sets restocking_fee_percentage.
*
* @param string|null $restocking_fee_percentage This string field indicates the restocking fee percentage that the seller has set on the item. Sellers have the option of setting no restocking fee for an item, or they can set the percentage to 10, 15, or 20 percent. So, if the cost of the item was $100, and the restocking percentage was 20 percent, the buyer would be charged $20 to return that item, so instead of receiving a $100 refund, they would receive $80 due to the restocking fee.
*
* @return self
*/
public function setRestockingFeePercentage($restocking_fee_percentage)
{
$this->container['restocking_fee_percentage'] = $restocking_fee_percentage;
return $this;
}
/**
* Gets return_instructions.
*
* @return string|null
*/
public function getReturnInstructions()
{
return $this->container['return_instructions'];
}
/**
* Sets return_instructions.
*
* @param string|null $return_instructions text written by the seller describing what the buyer needs to do in order to return the item
*
* @return self
*/
public function setReturnInstructions($return_instructions)
{
$this->container['return_instructions'] = $return_instructions;
return $this;
}
/**
* Gets return_method.
*
* @return string|null
*/
public function getReturnMethod()
{
return $this->container['return_method'];
}
/**
* Sets return_method.
*
* @param string|null $return_method An enumeration value that indicates the alternative methods for a full refund when an item is returned. This field is returned if the seller offers the buyer an item replacement or exchange instead of a monetary refund. <br><br><b> Valid Values: </b> <ul><li><b> REPLACEMENT</b> - Indicates that the buyer has the option of receiving money back for the returned item, or they can choose to have the seller replace the item with an identical item.</li> <li><b> EXCHANGE</b> - Indicates that the buyer has the option of receiving money back for the returned item, or they can exchange the item for another similar item.</li></ul> Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:ReturnMethodEnum'>eBay API documentation</a>
*
* @return self
*/
public function setReturnMethod($return_method)
{
$this->container['return_method'] = $return_method;
return $this;
}
/**
* Gets return_period.
*
* @return \TNT\Ebay\Buy\Browse\V1\Model\TimeDuration|null
*/
public function getReturnPeriod()
{
return $this->container['return_period'];
}
/**
* Sets return_period.
*
* @param \TNT\Ebay\Buy\Browse\V1\Model\TimeDuration|null $return_period return_period
*
* @return self
*/
public function setReturnPeriod($return_period)
{
$this->container['return_period'] = $return_period;
return $this;
}
/**
* Gets returns_accepted.
*
* @return bool|null
*/
public function getReturnsAccepted()
{
return $this->container['returns_accepted'];
}
/**
* Sets returns_accepted.
*
* @param bool|null $returns_accepted indicates whether the seller accepts returns for the item
*
* @return self
*/
public function setReturnsAccepted($returns_accepted)
{
$this->container['returns_accepted'] = $returns_accepted;
return $this;
}
/**
* Gets return_shipping_cost_payer.
*
* @return string|null
*/
public function getReturnShippingCostPayer()
{
return $this->container['return_shipping_cost_payer'];
}
/**
* Sets return_shipping_cost_payer.
*
* @param string|null $return_shipping_cost_payer This enumeration value indicates whether the buyer or seller is responsible for return shipping costs when an item is returned. <br><br><b> Valid Values: </b> <ul><li><b> SELLER</b> - Indicates the seller will pay for the shipping costs to return the item.</li> <li><b> BUYER</b> - Indicates the buyer will pay for the shipping costs to return the item.</li> </ul> Code so that your app gracefully handles any future changes to this list. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:ReturnShippingCostPayerEnum'>eBay API documentation</a>
*
* @return self
*/
public function setReturnShippingCostPayer($return_shipping_cost_payer)
{
$this->container['return_shipping_cost_payer'] = $return_shipping_cost_payer;
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));
}
}