src/Sell/Fulfillment/V1/Model/ShippingFulfillment.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);
/**
* ShippingFulfillment.
*
* 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;
/**
* ShippingFulfillment Class Doc Comment.
*
* @category Class
*
* @description This type contains the complete details of an existing fulfillment for an order.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class ShippingFulfillment implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'ShippingFulfillment';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'fulfillment_id' => 'string',
'line_items' => '\TNT\Ebay\Sell\Fulfillment\V1\Model\LineItemReference[]',
'shipment_tracking_number' => 'string',
'shipped_date' => 'string',
'shipping_carrier_code' => '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 = [
'fulfillment_id' => null,
'line_items' => null,
'shipment_tracking_number' => null,
'shipped_date' => null,
'shipping_carrier_code' => 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 = [
'fulfillment_id' => 'fulfillmentId',
'line_items' => 'lineItems',
'shipment_tracking_number' => 'shipmentTrackingNumber',
'shipped_date' => 'shippedDate',
'shipping_carrier_code' => 'shippingCarrierCode',
];
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @var string[]
*/
protected static $setters = [
'fulfillment_id' => 'setFulfillmentId',
'line_items' => 'setLineItems',
'shipment_tracking_number' => 'setShipmentTrackingNumber',
'shipped_date' => 'setShippedDate',
'shipping_carrier_code' => 'setShippingCarrierCode',
];
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @var string[]
*/
protected static $getters = [
'fulfillment_id' => 'getFulfillmentId',
'line_items' => 'getLineItems',
'shipment_tracking_number' => 'getShipmentTrackingNumber',
'shipped_date' => 'getShippedDate',
'shipping_carrier_code' => 'getShippingCarrierCode',
];
/**
* 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['fulfillment_id'] = $data['fulfillment_id'] ?? null;
$this->container['line_items'] = $data['line_items'] ?? null;
$this->container['shipment_tracking_number'] = $data['shipment_tracking_number'] ?? null;
$this->container['shipped_date'] = $data['shipped_date'] ?? null;
$this->container['shipping_carrier_code'] = $data['shipping_carrier_code'] ?? 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 fulfillment_id.
*
* @return string|null
*/
public function getFulfillmentId()
{
return $this->container['fulfillment_id'];
}
/**
* Sets fulfillment_id.
*
* @param string|null $fulfillment_id The unique identifier of the fulfillment; for example, <code>9405509699937003457459</code>. This eBay-generated value is created with a successful <b>createShippingFulfillment</b> call.
*
* @return self
*/
public function setFulfillmentId($fulfillment_id)
{
$this->container['fulfillment_id'] = $fulfillment_id;
return $this;
}
/**
* Gets line_items.
*
* @return \TNT\Ebay\Sell\Fulfillment\V1\Model\LineItemReference[]|null
*/
public function getLineItems()
{
return $this->container['line_items'];
}
/**
* Sets line_items.
*
* @param \TNT\Ebay\Sell\Fulfillment\V1\Model\LineItemReference[]|null $line_items this array contains a list of one or more line items (and purchased quantity) to which the fulfillment applies
*
* @return self
*/
public function setLineItems($line_items)
{
$this->container['line_items'] = $line_items;
return $this;
}
/**
* Gets shipment_tracking_number.
*
* @return string|null
*/
public function getShipmentTrackingNumber()
{
return $this->container['shipment_tracking_number'];
}
/**
* Sets shipment_tracking_number.
*
* @param string|null $shipment_tracking_number The tracking number provided by the shipping carrier for the package shipped in this fulfillment. This field is returned if available.
*
* @return self
*/
public function setShipmentTrackingNumber($shipment_tracking_number)
{
$this->container['shipment_tracking_number'] = $shipment_tracking_number;
return $this;
}
/**
* Gets shipped_date.
*
* @return string|null
*/
public function getShippedDate()
{
return $this->container['shipped_date'];
}
/**
* Sets shipped_date.
*
* @param string|null $shipped_date The date and time that the fulfillment package was shipped. This timestamp is in ISO 8601 format, which uses the 24-hour Universal Coordinated Time (UTC) clock. This field should only be returned if the package has been shipped.<br /><br /><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code> <br /><b>Example:</b> <code>2015-08-04T19:09:02.768Z</code>
*
* @return self
*/
public function setShippedDate($shipped_date)
{
$this->container['shipped_date'] = $shipped_date;
return $this;
}
/**
* Gets shipping_carrier_code.
*
* @return string|null
*/
public function getShippingCarrierCode()
{
return $this->container['shipping_carrier_code'];
}
/**
* Sets shipping_carrier_code.
*
* @param string|null $shipping_carrier_code The eBay code identifying the shipping carrier for this fulfillment. This field is returned if available. <br /><br /><span class=\"tablenote\"><strong>Note:</strong> The Trading API's <b>ShippingCarrierCodeType</b> enumeration type contains the most current list of eBay shipping carrier codes and the countries served by each carrier. See <a href=\"https://developer.ebay.com/Devzone/XML/docs/Reference/eBay/types/ShippingCarrierCodeType.html \" target=\"_blank\">ShippingCarrierCodeType</a>.</span>
*
* @return self
*/
public function setShippingCarrierCode($shipping_carrier_code)
{
$this->container['shipping_carrier_code'] = $shipping_carrier_code;
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));
}
}