src/Sell/ListingBeta/V1/Model/ItemDraft.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);
/**
* ItemDraft.
*
* PHP version ^7.2 || ^8.0
*
* @category Class
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*/
/**
* Listing 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 />Enables a seller adding an ad or item on a Partner's site to automatically create an eBay listing draft using the item details from the Partner's site.
*
* The version of the OpenAPI document: v1_beta.3.1
* 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\ListingBeta\V1\Model;
use TNT\Ebay\Sell\ListingBeta\V1\ObjectSerializer;
/**
* ItemDraft Class Doc Comment.
*
* @category Class
*
* @description The type that defines the fields for the listing details.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class ItemDraft implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'ItemDraft';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'category_id' => 'string',
'condition' => 'string',
'format' => 'string',
'pricing_summary' => '\TNT\Ebay\Sell\ListingBeta\V1\Model\PricingSummary',
'product' => '\TNT\Ebay\Sell\ListingBeta\V1\Model\Product',
'charity' => '\TNT\Ebay\Sell\ListingBeta\V1\Model\Charity',
];
/**
* 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 = [
'category_id' => null,
'condition' => null,
'format' => null,
'pricing_summary' => null,
'product' => null,
'charity' => 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 = [
'category_id' => 'categoryId',
'condition' => 'condition',
'format' => 'format',
'pricing_summary' => 'pricingSummary',
'product' => 'product',
'charity' => 'charity',
];
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @var string[]
*/
protected static $setters = [
'category_id' => 'setCategoryId',
'condition' => 'setCondition',
'format' => 'setFormat',
'pricing_summary' => 'setPricingSummary',
'product' => 'setProduct',
'charity' => 'setCharity',
];
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @var string[]
*/
protected static $getters = [
'category_id' => 'getCategoryId',
'condition' => 'getCondition',
'format' => 'getFormat',
'pricing_summary' => 'getPricingSummary',
'product' => 'getProduct',
'charity' => 'getCharity',
];
/**
* 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['category_id'] = $data['category_id'] ?? null;
$this->container['condition'] = $data['condition'] ?? null;
$this->container['format'] = $data['format'] ?? null;
$this->container['pricing_summary'] = $data['pricing_summary'] ?? null;
$this->container['product'] = $data['product'] ?? null;
$this->container['charity'] = $data['charity'] ?? 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 category_id.
*
* @return string|null
*/
public function getCategoryId()
{
return $this->container['category_id'];
}
/**
* Sets category_id.
*
* @param string|null $category_id The ID of the leaf category associated with this item. A leaf category is the lowest level in that category and has no children. <br /><br /><span class=\"tablenote\"><b>Note: </b> If you submit both a category ID and an EPID, eBay determines the best category based on the EPID and uses that. The category ID will be ignored. </span>
*
* @return self
*/
public function setCategoryId($category_id)
{
$this->container['category_id'] = $category_id;
return $this;
}
/**
* Gets condition.
*
* @return string|null
*/
public function getCondition()
{
return $this->container['condition'];
}
/**
* Sets condition.
*
* @param string|null $condition The enumeration value passed in here sets the condition of the item, such as <code>NEW</code> or <code>USED_EXCELLENT</code>. See <a href=\"/api-docs/sell/listing/types/api:ConditionEnum\">ConditionEnum</a> for the full list of supported values.<br /><br />Supported item conditions can vary by eBay category. To see which item conditions are supported for a category, you can use the <a href=\"/api-docs/sell/metadata/resources/marketplace/methods/getItemConditionPolicies\">getItemConditionPolicies</a> method of the <strong>Metadata API</strong>. <br /><br /><span class=\"tablenote\"> <strong>Note:</strong> The 'Manufacturer Refurbished' item condition is no longer a valid item condition in any eBay marketplace, and to reflect this change, the pre-existing <code>MANUFACTURER_REFURBISHED</code> enumeration value has been replaced by the <code>CERTIFIED_REFURBISHED</code> enumeration value. CR-eligible sellers should make a note to start using <code>CERTIFIED_REFURBISHED</code> from this point forward. To list an item as 'Certified Refurbished', a seller must be pre-qualified by eBay for this feature. Any seller who is not eligible for this feature will be blocked if they try to create a new listing or revise an existing listing with this item condition. <br><br> Any seller that is interested in eligibility requirements to list with 'Certified Refurbished' should see the <a href=\"https://pages.ebay.com/seller-center/listing-and-marketing/certified-refurbished-program.html\" target=\"_blank\">Certified refurbished program</a> page in Seller Center. </span><br /><br /><span class=\"tablenote\"> <strong>Note:</strong> As of September 1, 2021, <code>SELLER_REFURBISHED</code> can no longer be used as a condition value in the <strong>Cell Phones & Smartphones</strong> category (category ID 9355) for the following marketplaces: US, Canada, UK, Germany, and Australia. The <code>SELLER_REFURBISHED</code> item condition will be replaced by one of three new refurbished values, which include <code>EXCELLENT_REFURBISHED</code> (condition ID 2010), <code>VERY_GOOD_REFURBISHED</code>, and <code>GOOD_REFURBISHED</code> (condition ID 2030). To use any of these new refurbished item conditions in category 9355, sellers must go through an application and qualification process. Any seller who is not eligible to use these new refurbished item conditions in category 9355 will get an error if they try to create an item draft with any of these three new item conditions. </span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/listing/types/api:ConditionEnum'>eBay API documentation</a>
*
* @return self
*/
public function setCondition($condition)
{
$this->container['condition'] = $condition;
return $this;
}
/**
* Gets format.
*
* @return string|null
*/
public function getFormat()
{
return $this->container['format'];
}
/**
* Sets format.
*
* @param string|null $format The format of the listing. <br><br><b>Valid Values: </b> <code>FIXED_PRICE</code> and <code>AUCTION</code> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/listing/types/api:ListingFormatEnum'>eBay API documentation</a>
*
* @return self
*/
public function setFormat($format)
{
$this->container['format'] = $format;
return $this;
}
/**
* Gets pricing_summary.
*
* @return \TNT\Ebay\Sell\ListingBeta\V1\Model\PricingSummary|null
*/
public function getPricingSummary()
{
return $this->container['pricing_summary'];
}
/**
* Sets pricing_summary.
*
* @param \TNT\Ebay\Sell\ListingBeta\V1\Model\PricingSummary|null $pricing_summary pricing_summary
*
* @return self
*/
public function setPricingSummary($pricing_summary)
{
$this->container['pricing_summary'] = $pricing_summary;
return $this;
}
/**
* Gets product.
*
* @return \TNT\Ebay\Sell\ListingBeta\V1\Model\Product|null
*/
public function getProduct()
{
return $this->container['product'];
}
/**
* Sets product.
*
* @param \TNT\Ebay\Sell\ListingBeta\V1\Model\Product|null $product product
*
* @return self
*/
public function setProduct($product)
{
$this->container['product'] = $product;
return $this;
}
/**
* Gets charity.
*
* @return \TNT\Ebay\Sell\ListingBeta\V1\Model\Charity|null
*/
public function getCharity()
{
return $this->container['charity'];
}
/**
* Sets charity.
*
* @param \TNT\Ebay\Sell\ListingBeta\V1\Model\Charity|null $charity charity
*
* @return self
*/
public function setCharity($charity)
{
$this->container['charity'] = $charity;
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));
}
}