src/Sell/Inventory/V1/Model/PriceQuantityResponse.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);
/**
* PriceQuantityResponse.
*
* 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;
/**
* PriceQuantityResponse Class Doc Comment.
*
* @category Class
*
* @description This type is used to display the result for each offer and/or inventory item that the seller attempted to update with a <strong>bulkUpdatePriceQuantity</strong> call. If any errors or warnings occur, the error/warning data is returned at the offer/inventory item level.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class PriceQuantityResponse implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'PriceQuantityResponse';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'errors' => '\TNT\Ebay\Sell\Inventory\V1\Model\Error[]',
'offer_id' => 'string',
'sku' => 'string',
'status_code' => 'int',
'warnings' => '\TNT\Ebay\Sell\Inventory\V1\Model\Error[]',
];
/**
* 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 = [
'errors' => null,
'offer_id' => null,
'sku' => null,
'status_code' => 'int32',
'warnings' => 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 = [
'errors' => 'errors',
'offer_id' => 'offerId',
'sku' => 'sku',
'status_code' => 'statusCode',
'warnings' => 'warnings',
];
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @var string[]
*/
protected static $setters = [
'errors' => 'setErrors',
'offer_id' => 'setOfferId',
'sku' => 'setSku',
'status_code' => 'setStatusCode',
'warnings' => 'setWarnings',
];
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @var string[]
*/
protected static $getters = [
'errors' => 'getErrors',
'offer_id' => 'getOfferId',
'sku' => 'getSku',
'status_code' => 'getStatusCode',
'warnings' => 'getWarnings',
];
/**
* 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['errors'] = $data['errors'] ?? null;
$this->container['offer_id'] = $data['offer_id'] ?? null;
$this->container['sku'] = $data['sku'] ?? null;
$this->container['status_code'] = $data['status_code'] ?? null;
$this->container['warnings'] = $data['warnings'] ?? 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 errors.
*
* @return \TNT\Ebay\Sell\Inventory\V1\Model\Error[]|null
*/
public function getErrors()
{
return $this->container['errors'];
}
/**
* Sets errors.
*
* @param \TNT\Ebay\Sell\Inventory\V1\Model\Error[]|null $errors this array will be returned if there were one or more errors associated with the update to the offer or inventory item record
*
* @return self
*/
public function setErrors($errors)
{
$this->container['errors'] = $errors;
return $this;
}
/**
* Gets offer_id.
*
* @return string|null
*/
public function getOfferId()
{
return $this->container['offer_id'];
}
/**
* Sets offer_id.
*
* @param string|null $offer_id The unique identifier of the offer that was updated. This field will not be returned in situations where the seller is only updating the total 'ship-to-home' quantity of an inventory item record.
*
* @return self
*/
public function setOfferId($offer_id)
{
$this->container['offer_id'] = $offer_id;
return $this;
}
/**
* Gets sku.
*
* @return string|null
*/
public function getSku()
{
return $this->container['sku'];
}
/**
* Sets sku.
*
* @param string|null $sku This is the seller-defined SKU value of the product. This field is returned whether the seller attempted to update an offer with the SKU value or just attempted to update the total 'ship-to-home' quantity of an inventory item record.<br/><br/><strong>Max Length</strong>: 50<br/>
*
* @return self
*/
public function setSku($sku)
{
$this->container['sku'] = $sku;
return $this;
}
/**
* Gets status_code.
*
* @return int|null
*/
public function getStatusCode()
{
return $this->container['status_code'];
}
/**
* Sets status_code.
*
* @param int|null $status_code The value returned in this container will indicate the status of the attempt to update the price and/or quantity of the offer (specified in the corresponding <strong>offerId</strong> field) or the attempt to update the total 'ship-to-home' quantity of an inventory item (specified in the corresponding <strong>sku</strong> field). For a completely successful update of an offer or inventory item record, a value of <code>200</code> will appear in this field. A user can view the <strong>HTTP status codes</strong> section for information on other status codes that may be returned with the <strong>bulkUpdatePriceQuantity</strong> method.
*
* @return self
*/
public function setStatusCode($status_code)
{
$this->container['status_code'] = $status_code;
return $this;
}
/**
* Gets warnings.
*
* @return \TNT\Ebay\Sell\Inventory\V1\Model\Error[]|null
*/
public function getWarnings()
{
return $this->container['warnings'];
}
/**
* Sets warnings.
*
* @param \TNT\Ebay\Sell\Inventory\V1\Model\Error[]|null $warnings this array will be returned if there were one or more warnings associated with the update to the offer or inventory item record
*
* @return self
*/
public function setWarnings($warnings)
{
$this->container['warnings'] = $warnings;
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));
}
}