src/Sell/Fulfillment/V1/Model/Error.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);
/**
* Error.
*
* PHP version ^7.2 || ^8.0
*
* @category Class
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*/
/**
* Fulfillment API.
*
* Use the Fulfillment API to complete the process of packaging, addressing, handling, and shipping each order on behalf of the seller, in accordance with the payment method and timing specified at checkout.
*
* The version of the OpenAPI document: v1.19.17
* 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\Fulfillment\V1\Model;
use TNT\Ebay\Sell\Fulfillment\V1\ObjectSerializer;
/**
* Error Class Doc Comment.
*
* @category Class
*
* @description This type contains a error or warning related to a call request.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class Error implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'Error';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'category' => 'string',
'domain' => 'string',
'error_id' => 'int',
'input_ref_ids' => 'string[]',
'long_message' => 'string',
'message' => 'string',
'output_ref_ids' => 'string[]',
'parameters' => '\TNT\Ebay\Sell\Fulfillment\V1\Model\ErrorParameter[]',
'subdomain' => '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 = [
'category' => null,
'domain' => null,
'error_id' => 'int32',
'input_ref_ids' => null,
'long_message' => null,
'message' => null,
'output_ref_ids' => null,
'parameters' => null,
'subdomain' => 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' => 'category',
'domain' => 'domain',
'error_id' => 'errorId',
'input_ref_ids' => 'inputRefIds',
'long_message' => 'longMessage',
'message' => 'message',
'output_ref_ids' => 'outputRefIds',
'parameters' => 'parameters',
'subdomain' => 'subdomain',
];
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @var string[]
*/
protected static $setters = [
'category' => 'setCategory',
'domain' => 'setDomain',
'error_id' => 'setErrorId',
'input_ref_ids' => 'setInputRefIds',
'long_message' => 'setLongMessage',
'message' => 'setMessage',
'output_ref_ids' => 'setOutputRefIds',
'parameters' => 'setParameters',
'subdomain' => 'setSubdomain',
];
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @var string[]
*/
protected static $getters = [
'category' => 'getCategory',
'domain' => 'getDomain',
'error_id' => 'getErrorId',
'input_ref_ids' => 'getInputRefIds',
'long_message' => 'getLongMessage',
'message' => 'getMessage',
'output_ref_ids' => 'getOutputRefIds',
'parameters' => 'getParameters',
'subdomain' => 'getSubdomain',
];
/**
* 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'] = $data['category'] ?? null;
$this->container['domain'] = $data['domain'] ?? null;
$this->container['error_id'] = $data['error_id'] ?? null;
$this->container['input_ref_ids'] = $data['input_ref_ids'] ?? null;
$this->container['long_message'] = $data['long_message'] ?? null;
$this->container['message'] = $data['message'] ?? null;
$this->container['output_ref_ids'] = $data['output_ref_ids'] ?? null;
$this->container['parameters'] = $data['parameters'] ?? null;
$this->container['subdomain'] = $data['subdomain'] ?? 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.
*
* @return string|null
*/
public function getCategory()
{
return $this->container['category'];
}
/**
* Sets category.
*
* @param string|null $category the context or source of this error or warning
*
* @return self
*/
public function setCategory($category)
{
$this->container['category'] = $category;
return $this;
}
/**
* Gets domain.
*
* @return string|null
*/
public function getDomain()
{
return $this->container['domain'];
}
/**
* Sets domain.
*
* @param string|null $domain The name of the domain containing the service or application. For example, <code>sell</code> is a domain.
*
* @return self
*/
public function setDomain($domain)
{
$this->container['domain'] = $domain;
return $this;
}
/**
* Gets error_id.
*
* @return int|null
*/
public function getErrorId()
{
return $this->container['error_id'];
}
/**
* Sets error_id.
*
* @param int|null $error_id A positive integer that uniquely identifies the specific error condition that occurred. Your application can use these values as error code identifiers in your customized error-handling algorithms.
*
* @return self
*/
public function setErrorId($error_id)
{
$this->container['error_id'] = $error_id;
return $this;
}
/**
* Gets input_ref_ids.
*
* @return string[]|null
*/
public function getInputRefIds()
{
return $this->container['input_ref_ids'];
}
/**
* Sets input_ref_ids.
*
* @param string[]|null $input_ref_ids A list of one or more specific request elements (if any) associated with the error or warning. The format of these strings depends on the request payload format. For JSON, use JSONPath notation.
*
* @return self
*/
public function setInputRefIds($input_ref_ids)
{
$this->container['input_ref_ids'] = $input_ref_ids;
return $this;
}
/**
* Gets long_message.
*
* @return string|null
*/
public function getLongMessage()
{
return $this->container['long_message'];
}
/**
* Sets long_message.
*
* @param string|null $long_message An expanded version of the <b>message</b> field. <br /><br /><b>Maximum length:</b> 200 characters
*
* @return self
*/
public function setLongMessage($long_message)
{
$this->container['long_message'] = $long_message;
return $this;
}
/**
* Gets message.
*
* @return string|null
*/
public function getMessage()
{
return $this->container['message'];
}
/**
* Sets message.
*
* @param string|null $message A message about the error or warning which is device agnostic and readable by end users and application developers. It explains what the error or warning is, and how to fix it (in a general sense). If applicable, the value is localized to the end user's requested locale. <br /><br /><b>Maximum length:</b> 50 characters
*
* @return self
*/
public function setMessage($message)
{
$this->container['message'] = $message;
return $this;
}
/**
* Gets output_ref_ids.
*
* @return string[]|null
*/
public function getOutputRefIds()
{
return $this->container['output_ref_ids'];
}
/**
* Sets output_ref_ids.
*
* @param string[]|null $output_ref_ids A list of one or more specific response elements (if any) associated with the error or warning. The format of these strings depends on the request payload format. For JSON, use JSONPath notation.
*
* @return self
*/
public function setOutputRefIds($output_ref_ids)
{
$this->container['output_ref_ids'] = $output_ref_ids;
return $this;
}
/**
* Gets parameters.
*
* @return \TNT\Ebay\Sell\Fulfillment\V1\Model\ErrorParameter[]|null
*/
public function getParameters()
{
return $this->container['parameters'];
}
/**
* Sets parameters.
*
* @param \TNT\Ebay\Sell\Fulfillment\V1\Model\ErrorParameter[]|null $parameters Contains a list of name/value pairs that provide additional information concerning this error or warning. Each item in the list is an input parameter that contributed to the error or warning condition.
*
* @return self
*/
public function setParameters($parameters)
{
$this->container['parameters'] = $parameters;
return $this;
}
/**
* Gets subdomain.
*
* @return string|null
*/
public function getSubdomain()
{
return $this->container['subdomain'];
}
/**
* Sets subdomain.
*
* @param string|null $subdomain The name of the domain's subsystem or subdivision. For example, <code>fulfillment</code> is a subdomain in the <code>sell</code> domain.
*
* @return self
*/
public function setSubdomain($subdomain)
{
$this->container['subdomain'] = $subdomain;
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));
}
}