src/Sell/Feed/V1/Model/OrderTaskCollection.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);
/**
* OrderTaskCollection.
*
* PHP version ^7.2 || ^8.0
*
* @category Class
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*/
/**
* Feed API.
*
* <p>The <strong>Feed API</strong> lets sellers upload input files, download reports and files including their status, filter reports using URI parameters, and retrieve customer service metrics task details.</p>
*
* The version of the OpenAPI document: v1.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\Feed\V1\Model;
use TNT\Ebay\Sell\Feed\V1\ObjectSerializer;
/**
* OrderTaskCollection Class Doc Comment.
*
* @category Class
*
* @description The type that defines the fields for a paginated result set of orders. The response consists of 0 or more sequenced <em> pages</em> where each page has 0 or more items.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class OrderTaskCollection implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'OrderTaskCollection';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'href' => 'string',
'limit' => 'int',
'next' => 'string',
'offset' => 'int',
'prev' => 'string',
'tasks' => '\TNT\Ebay\Sell\Feed\V1\Model\OrderTask[]',
'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,
'offset' => 'int32',
'prev' => null,
'tasks' => null,
'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',
'offset' => 'offset',
'prev' => 'prev',
'tasks' => 'tasks',
'total' => 'total',
];
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @var string[]
*/
protected static $setters = [
'href' => 'setHref',
'limit' => 'setLimit',
'next' => 'setNext',
'offset' => 'setOffset',
'prev' => 'setPrev',
'tasks' => 'setTasks',
'total' => 'setTotal',
];
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @var string[]
*/
protected static $getters = [
'href' => 'getHref',
'limit' => 'getLimit',
'next' => 'getNext',
'offset' => 'getOffset',
'prev' => 'getPrev',
'tasks' => 'getTasks',
'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['offset'] = $data['offset'] ?? null;
$this->container['prev'] = $data['prev'] ?? null;
$this->container['tasks'] = $data['tasks'] ?? 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 the path to the call URI that produced the current page of results
*
* @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 The value of the <strong>limit</strong> parameter submitted in the request, which is the maximum number of order tasks to return per page, from the result set. A result set is the complete set of tasks returned by the method. <p> <span class=\"tablenote\"><strong>Note:</strong> Though this parameter is not required to be submitted in the request, the parameter defaults to <code>10</code> if omitted.</span></p><p> <span class=\"tablenote\"><strong>Note:</strong> If this is the last or only page of the result set, the page may contain fewer tasks than the <strong>limit</strong> value. To determine the number of pages in a result set, divide the total value (total number of tasks matching input criteria) by this limit value, and then round up to the next integer. For example, if the <strong>total</strong> value was <code>120</code> (120 total tasks) and the <strong>limit</strong> value was <code>50</code> (show 50 tasks per page), the total number of pages in the result set is three, so the seller would have to make three separate <strong>getOrderTasks</strong> calls to view all tasks matching the input criteria.</span></p>
*
* @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 The path to the call URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.
*
* @return self
*/
public function setNext($next)
{
$this->container['next'] = $next;
return $this;
}
/**
* Gets offset.
*
* @return int|null
*/
public function getOffset()
{
return $this->container['offset'];
}
/**
* Sets offset.
*
* @param int|null $offset The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the <b>offset</b> query parameter. <p class=\"tablenote\"><strong>Note: </strong>The items in a paginated result set use a zero-based list where the first item in the list has an offset of <code>0</code>.</p>
*
* @return self
*/
public function setOffset($offset)
{
$this->container['offset'] = $offset;
return $this;
}
/**
* Gets prev.
*
* @return string|null
*/
public function getPrev()
{
return $this->container['prev'];
}
/**
* Sets prev.
*
* @param string|null $prev The path to the call URI for the previous page of results. This is returned if there is a previous page of results from the result set.
*
* @return self
*/
public function setPrev($prev)
{
$this->container['prev'] = $prev;
return $this;
}
/**
* Gets tasks.
*
* @return \TNT\Ebay\Sell\Feed\V1\Model\OrderTask[]|null
*/
public function getTasks()
{
return $this->container['tasks'];
}
/**
* Sets tasks.
*
* @param \TNT\Ebay\Sell\Feed\V1\Model\OrderTask[]|null $tasks An array of the order tasks on this page. The tasks are sorted by creation date. An empty array is returned if the filter criteria excludes all tasks.
*
* @return self
*/
public function setTasks($tasks)
{
$this->container['tasks'] = $tasks;
return $this;
}
/**
* Gets total.
*
* @return int|null
*/
public function getTotal()
{
return $this->container['total'];
}
/**
* Sets total.
*
* @param int|null $total the total number of order tasks that match the input criteria
*
* @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));
}
}