src/Sell/Fulfillment/V1/Model/DisputeEvidence.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);
/**
* DisputeEvidence.
*
* 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;
/**
* DisputeEvidence Class Doc Comment.
*
* @category Class
*
* @description This type is used by the <strong>evidence</strong> array that is returned in the <strong>getPaymentDispute</strong> response if one or more evidential documents are associated with the payment dispute.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class DisputeEvidence implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'DisputeEvidence';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'evidence_id' => 'string',
'evidence_type' => 'string',
'files' => '\TNT\Ebay\Sell\Fulfillment\V1\Model\FileInfo[]',
'line_items' => '\TNT\Ebay\Sell\Fulfillment\V1\Model\OrderLineItems[]',
'provided_date' => 'string',
'request_date' => 'string',
'respond_by_date' => 'string',
'shipment_tracking' => '\TNT\Ebay\Sell\Fulfillment\V1\Model\TrackingInfo[]',
];
/**
* 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 = [
'evidence_id' => null,
'evidence_type' => null,
'files' => null,
'line_items' => null,
'provided_date' => null,
'request_date' => null,
'respond_by_date' => null,
'shipment_tracking' => 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 = [
'evidence_id' => 'evidenceId',
'evidence_type' => 'evidenceType',
'files' => 'files',
'line_items' => 'lineItems',
'provided_date' => 'providedDate',
'request_date' => 'requestDate',
'respond_by_date' => 'respondByDate',
'shipment_tracking' => 'shipmentTracking',
];
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @var string[]
*/
protected static $setters = [
'evidence_id' => 'setEvidenceId',
'evidence_type' => 'setEvidenceType',
'files' => 'setFiles',
'line_items' => 'setLineItems',
'provided_date' => 'setProvidedDate',
'request_date' => 'setRequestDate',
'respond_by_date' => 'setRespondByDate',
'shipment_tracking' => 'setShipmentTracking',
];
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @var string[]
*/
protected static $getters = [
'evidence_id' => 'getEvidenceId',
'evidence_type' => 'getEvidenceType',
'files' => 'getFiles',
'line_items' => 'getLineItems',
'provided_date' => 'getProvidedDate',
'request_date' => 'getRequestDate',
'respond_by_date' => 'getRespondByDate',
'shipment_tracking' => 'getShipmentTracking',
];
/**
* 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['evidence_id'] = $data['evidence_id'] ?? null;
$this->container['evidence_type'] = $data['evidence_type'] ?? null;
$this->container['files'] = $data['files'] ?? null;
$this->container['line_items'] = $data['line_items'] ?? null;
$this->container['provided_date'] = $data['provided_date'] ?? null;
$this->container['request_date'] = $data['request_date'] ?? null;
$this->container['respond_by_date'] = $data['respond_by_date'] ?? null;
$this->container['shipment_tracking'] = $data['shipment_tracking'] ?? 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 evidence_id.
*
* @return string|null
*/
public function getEvidenceId()
{
return $this->container['evidence_id'];
}
/**
* Sets evidence_id.
*
* @param string|null $evidence_id Unique identifier of the evidential file set. Potentially, each evidential file set can have more than one file, that is why there is this file set identifier, and then an identifier for each file within this file set.
*
* @return self
*/
public function setEvidenceId($evidence_id)
{
$this->container['evidence_id'] = $evidence_id;
return $this;
}
/**
* Gets evidence_type.
*
* @return string|null
*/
public function getEvidenceType()
{
return $this->container['evidence_type'];
}
/**
* Sets evidence_type.
*
* @param string|null $evidence_type This enumeration value shows the type of evidential file provided. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/fulfillment/types/api:EvidenceTypeEnum'>eBay API documentation</a>
*
* @return self
*/
public function setEvidenceType($evidence_type)
{
$this->container['evidence_type'] = $evidence_type;
return $this;
}
/**
* Gets files.
*
* @return \TNT\Ebay\Sell\Fulfillment\V1\Model\FileInfo[]|null
*/
public function getFiles()
{
return $this->container['files'];
}
/**
* Sets files.
*
* @param \TNT\Ebay\Sell\Fulfillment\V1\Model\FileInfo[]|null $files this array shows the name, ID, file type, and upload date for each provided file
*
* @return self
*/
public function setFiles($files)
{
$this->container['files'] = $files;
return $this;
}
/**
* Gets line_items.
*
* @return \TNT\Ebay\Sell\Fulfillment\V1\Model\OrderLineItems[]|null
*/
public function getLineItems()
{
return $this->container['line_items'];
}
/**
* Sets line_items.
*
* @param \TNT\Ebay\Sell\Fulfillment\V1\Model\OrderLineItems[]|null $line_items this array shows one or more order line items associated with the evidential document that has been provided
*
* @return self
*/
public function setLineItems($line_items)
{
$this->container['line_items'] = $line_items;
return $this;
}
/**
* Gets provided_date.
*
* @return string|null
*/
public function getProvidedDate()
{
return $this->container['provided_date'];
}
/**
* Sets provided_date.
*
* @param string|null $provided_date The timestamp in this field shows the date/time when the seller provided a requested evidential document to eBay. <br/><br/>The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>. An example would be <code>2019-08-04T19:09:02.768Z</code>.
*
* @return self
*/
public function setProvidedDate($provided_date)
{
$this->container['provided_date'] = $provided_date;
return $this;
}
/**
* Gets request_date.
*
* @return string|null
*/
public function getRequestDate()
{
return $this->container['request_date'];
}
/**
* Sets request_date.
*
* @param string|null $request_date The timestamp in this field shows the date/time when eBay requested the evidential document from the seller in response to a payment dispute. <br/><br/>The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>. An example would be <code>2019-08-04T19:09:02.768Z</code>.
*
* @return self
*/
public function setRequestDate($request_date)
{
$this->container['request_date'] = $request_date;
return $this;
}
/**
* Gets respond_by_date.
*
* @return string|null
*/
public function getRespondByDate()
{
return $this->container['respond_by_date'];
}
/**
* Sets respond_by_date.
*
* @param string|null $respond_by_date The timestamp in this field shows the date/time when the seller was expected to provide a requested evidential document to eBay. <br/><br/>The timestamps returned here use the ISO-8601 24-hour date and time format, and the time zone used is Universal Coordinated Time (UTC), also known as Greenwich Mean Time (GMT), or Zulu. The ISO-8601 format looks like this: <em>yyyy-MM-ddThh:mm.ss.sssZ</em>. An example would be <code>2019-08-04T19:09:02.768Z</code>.
*
* @return self
*/
public function setRespondByDate($respond_by_date)
{
$this->container['respond_by_date'] = $respond_by_date;
return $this;
}
/**
* Gets shipment_tracking.
*
* @return \TNT\Ebay\Sell\Fulfillment\V1\Model\TrackingInfo[]|null
*/
public function getShipmentTracking()
{
return $this->container['shipment_tracking'];
}
/**
* Sets shipment_tracking.
*
* @param \TNT\Ebay\Sell\Fulfillment\V1\Model\TrackingInfo[]|null $shipment_tracking This array shows the shipping carrier and shipment tracking number associated with each shipment package of the order. This array is returned if the seller has provided shipment tracking information as evidence to support <code>PROOF_OF_DELIVERY</code>.
*
* @return self
*/
public function setShipmentTracking($shipment_tracking)
{
$this->container['shipment_tracking'] = $shipment_tracking;
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));
}
}