src/Sell/Inventory/V1/Model/Offers.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);
/**
* Offers.
*
* PHP version ^7.2 || ^8.0
*
* @category Class
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*/
/**
* Inventory API.
*
* The Inventory API is used to create and manage inventory, and then to publish and manage this inventory on an eBay marketplace. There are also methods in this API that will convert eligible, active eBay listings into the Inventory API model.
*
* The version of the OpenAPI document: 1.16.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\Inventory\V1\Model;
use TNT\Ebay\Sell\Inventory\V1\ObjectSerializer;
/**
* Offers Class Doc Comment.
*
* @category Class
*
* @description This type is used by the base response of the <strong>getOffers</strong> call, and it is an array of one or more of the seller's offers, along with pagination data.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class Offers implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'Offers';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'href' => 'string',
'limit' => 'int',
'next' => 'string',
'offers' => '\TNT\Ebay\Sell\Inventory\V1\Model\EbayOfferDetailsWithAll[]',
'prev' => 'string',
'size' => 'int',
'total' => 'int',
];
/**
* 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 = [
'href' => null,
'limit' => 'int32',
'next' => null,
'offers' => null,
'prev' => null,
'size' => 'int32',
'total' => 'int32',
];
/**
* 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 = [
'href' => 'href',
'limit' => 'limit',
'next' => 'next',
'offers' => 'offers',
'prev' => 'prev',
'size' => 'size',
'total' => 'total',
];
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @var string[]
*/
protected static $setters = [
'href' => 'setHref',
'limit' => 'setLimit',
'next' => 'setNext',
'offers' => 'setOffers',
'prev' => 'setPrev',
'size' => 'setSize',
'total' => 'setTotal',
];
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @var string[]
*/
protected static $getters = [
'href' => 'getHref',
'limit' => 'getLimit',
'next' => 'getNext',
'offers' => 'getOffers',
'prev' => 'getPrev',
'size' => 'getSize',
'total' => 'getTotal',
];
/**
* 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['href'] = $data['href'] ?? null;
$this->container['limit'] = $data['limit'] ?? null;
$this->container['next'] = $data['next'] ?? null;
$this->container['offers'] = $data['offers'] ?? null;
$this->container['prev'] = $data['prev'] ?? null;
$this->container['size'] = $data['size'] ?? null;
$this->container['total'] = $data['total'] ?? 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 href.
*
* @return string|null
*/
public function getHref()
{
return $this->container['href'];
}
/**
* Sets href.
*
* @param string|null $href this is the URL to the current page of offers
*
* @return self
*/
public function setHref($href)
{
$this->container['href'] = $href;
return $this;
}
/**
* Gets limit.
*
* @return int|null
*/
public function getLimit()
{
return $this->container['limit'];
}
/**
* Sets limit.
*
* @param int|null $limit this integer value is the number of offers that will be displayed on each results page
*
* @return self
*/
public function setLimit($limit)
{
$this->container['limit'] = $limit;
return $this;
}
/**
* Gets next.
*
* @return string|null
*/
public function getNext()
{
return $this->container['next'];
}
/**
* Sets next.
*
* @param string|null $next This is the URL to the next page of offers. This field will only be returned if there are additional offers to view.
*
* @return self
*/
public function setNext($next)
{
$this->container['next'] = $next;
return $this;
}
/**
* Gets offers.
*
* @return \TNT\Ebay\Sell\Inventory\V1\Model\EbayOfferDetailsWithAll[]|null
*/
public function getOffers()
{
return $this->container['offers'];
}
/**
* Sets offers.
*
* @param \TNT\Ebay\Sell\Inventory\V1\Model\EbayOfferDetailsWithAll[]|null $offers This container is an array of one or more of the seller's offers for the SKU value that is passed in through the required <strong>sku</strong> query parameter.<br/><br/> <span class=\"tablenote\"> <strong>Note:</strong> Currently, the Inventory API does not support the same SKU across multiple eBay marketplaces, so the <strong>getOffers</strong> call will only return one offer.</span><br/><br/><strong>Max Occurs:</strong> 25
*
* @return self
*/
public function setOffers($offers)
{
$this->container['offers'] = $offers;
return $this;
}
/**
* Gets prev.
*
* @return string|null
*/
public function getPrev()
{
return $this->container['prev'];
}
/**
* Sets prev.
*
* @param string|null $prev This is the URL to the previous page of offers. This field will only be returned if there are previous offers to view.
*
* @return self
*/
public function setPrev($prev)
{
$this->container['prev'] = $prev;
return $this;
}
/**
* Gets size.
*
* @return int|null
*/
public function getSize()
{
return $this->container['size'];
}
/**
* Sets size.
*
* @param int|null $size This integer value indicates the number of offers being displayed on the current page of results. This number will generally be the same as the <strong>limit</strong> value if there are additional pages of results to view.<br/><br/> <span class=\"tablenote\"> <strong>Note:</strong> Currently, the Inventory API does not support the same SKU across multiple eBay marketplaces, so the <strong>Get Offers</strong> call will only return one offer, so this value should always be <code>1</code>.</span>
*
* @return self
*/
public function setSize($size)
{
$this->container['size'] = $size;
return $this;
}
/**
* Gets total.
*
* @return int|null
*/
public function getTotal()
{
return $this->container['total'];
}
/**
* Sets total.
*
* @param int|null $total This integer value is the total number of offers that exist for the specified SKU value. Based on this number and on the <strong>limit</strong> value, the seller may have to toggle through multiple pages to view all offers.<br/><br/> <span class=\"tablenote\"> <strong>Note:</strong> Currently, the Inventory API does not support the same SKU across multiple eBay marketplaces, so the <strong>Get Offers</strong> call will only return one offer, so this value should always be <code>1</code>.</span>
*
* @return self
*/
public function setTotal($total)
{
$this->container['total'] = $total;
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));
}
}