src/Sell/Logistics/V1/Model/Rate.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);
/**
* Rate.
*
* PHP version ^7.2 || ^8.0
*
* @category Class
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*/
/**
* Logistics API.
*
* <span class=\"tablenote\"><b>Note:</b> This is a <a href=\"https://developer.ebay.com/api-docs/static/versioning.html#limited\" target=\"_blank\"> <img src=\"/cms/img/docs/partners-api.svg\" class=\"legend-icon partners-icon\" title=\"Limited Release\" alt=\"Limited Release\" />(Limited Release)</a> API available only to select developers approved by business units.</span><br /><br />The <b>Logistics API</b> resources offer the following capabilities: <ul><li><b>shipping_quote</b> – Consolidates into a list a set of live shipping rates, or quotes, from which you can select a rate to ship a package.</li> <li><b>shipment</b> – Creates a \"shipment\" for the selected shipping rate.</li></ul> Call <b>createShippingQuote</b> to get a list of live shipping rates. The rates returned are all valid for a specific time window and all quoted prices are at eBay-negotiated rates. <br><br>Select one of the live rates and using its associated <b>rateId</b>, create a \"shipment\" for the package by calling <b>createFromShippingQuote</b>. Creating a shipment completes an agreement, and the cost of the base service and any added shipping options are summed into the returned <b>totalShippingCost</b> value. This action also generates a shipping label that you can use to ship the package. The total cost of the shipment is incurred when the package is shipped using the supplied shipping label. <p class=\"tablenote\"><b>Important!</b> Sellers must set up a payment method via their eBay account before they can use the methods in this API to create a shipment and the associated shipping label.</p>
*
* The version of the OpenAPI document: v1_beta.0.0
* 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\Logistics\V1\Model;
use TNT\Ebay\Sell\Logistics\V1\ObjectSerializer;
/**
* Rate Class Doc Comment.
*
* @category Class
*
* @description This complex type contains live quote information about a shipping service that's available for a given shipping quote request, including the shipping carrier and service, delivery window, shipping cost, and additional shipping options.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class Rate implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'Rate';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'additional_options' => '\TNT\Ebay\Sell\Logistics\V1\Model\AdditionalOption[]',
'base_shipping_cost' => '\TNT\Ebay\Sell\Logistics\V1\Model\Amount',
'destination_time_zone' => 'string',
'max_estimated_delivery_date' => 'string',
'min_estimated_delivery_date' => 'string',
'pickup_networks' => 'string[]',
'pickup_slots' => '\TNT\Ebay\Sell\Logistics\V1\Model\PickupSlot[]',
'pickup_type' => 'string',
'rate_id' => 'string',
'rate_recommendation' => 'string[]',
'shipping_carrier_code' => 'string',
'shipping_carrier_name' => 'string',
'shipping_service_code' => 'string',
'shipping_service_name' => '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 = [
'additional_options' => null,
'base_shipping_cost' => null,
'destination_time_zone' => null,
'max_estimated_delivery_date' => null,
'min_estimated_delivery_date' => null,
'pickup_networks' => null,
'pickup_slots' => null,
'pickup_type' => null,
'rate_id' => null,
'rate_recommendation' => null,
'shipping_carrier_code' => null,
'shipping_carrier_name' => null,
'shipping_service_code' => null,
'shipping_service_name' => 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 = [
'additional_options' => 'additionalOptions',
'base_shipping_cost' => 'baseShippingCost',
'destination_time_zone' => 'destinationTimeZone',
'max_estimated_delivery_date' => 'maxEstimatedDeliveryDate',
'min_estimated_delivery_date' => 'minEstimatedDeliveryDate',
'pickup_networks' => 'pickupNetworks',
'pickup_slots' => 'pickupSlots',
'pickup_type' => 'pickupType',
'rate_id' => 'rateId',
'rate_recommendation' => 'rateRecommendation',
'shipping_carrier_code' => 'shippingCarrierCode',
'shipping_carrier_name' => 'shippingCarrierName',
'shipping_service_code' => 'shippingServiceCode',
'shipping_service_name' => 'shippingServiceName',
];
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @var string[]
*/
protected static $setters = [
'additional_options' => 'setAdditionalOptions',
'base_shipping_cost' => 'setBaseShippingCost',
'destination_time_zone' => 'setDestinationTimeZone',
'max_estimated_delivery_date' => 'setMaxEstimatedDeliveryDate',
'min_estimated_delivery_date' => 'setMinEstimatedDeliveryDate',
'pickup_networks' => 'setPickupNetworks',
'pickup_slots' => 'setPickupSlots',
'pickup_type' => 'setPickupType',
'rate_id' => 'setRateId',
'rate_recommendation' => 'setRateRecommendation',
'shipping_carrier_code' => 'setShippingCarrierCode',
'shipping_carrier_name' => 'setShippingCarrierName',
'shipping_service_code' => 'setShippingServiceCode',
'shipping_service_name' => 'setShippingServiceName',
];
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @var string[]
*/
protected static $getters = [
'additional_options' => 'getAdditionalOptions',
'base_shipping_cost' => 'getBaseShippingCost',
'destination_time_zone' => 'getDestinationTimeZone',
'max_estimated_delivery_date' => 'getMaxEstimatedDeliveryDate',
'min_estimated_delivery_date' => 'getMinEstimatedDeliveryDate',
'pickup_networks' => 'getPickupNetworks',
'pickup_slots' => 'getPickupSlots',
'pickup_type' => 'getPickupType',
'rate_id' => 'getRateId',
'rate_recommendation' => 'getRateRecommendation',
'shipping_carrier_code' => 'getShippingCarrierCode',
'shipping_carrier_name' => 'getShippingCarrierName',
'shipping_service_code' => 'getShippingServiceCode',
'shipping_service_name' => 'getShippingServiceName',
];
/**
* 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['additional_options'] = $data['additional_options'] ?? null;
$this->container['base_shipping_cost'] = $data['base_shipping_cost'] ?? null;
$this->container['destination_time_zone'] = $data['destination_time_zone'] ?? null;
$this->container['max_estimated_delivery_date'] = $data['max_estimated_delivery_date'] ?? null;
$this->container['min_estimated_delivery_date'] = $data['min_estimated_delivery_date'] ?? null;
$this->container['pickup_networks'] = $data['pickup_networks'] ?? null;
$this->container['pickup_slots'] = $data['pickup_slots'] ?? null;
$this->container['pickup_type'] = $data['pickup_type'] ?? null;
$this->container['rate_id'] = $data['rate_id'] ?? null;
$this->container['rate_recommendation'] = $data['rate_recommendation'] ?? null;
$this->container['shipping_carrier_code'] = $data['shipping_carrier_code'] ?? null;
$this->container['shipping_carrier_name'] = $data['shipping_carrier_name'] ?? null;
$this->container['shipping_service_code'] = $data['shipping_service_code'] ?? null;
$this->container['shipping_service_name'] = $data['shipping_service_name'] ?? 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 additional_options.
*
* @return \TNT\Ebay\Sell\Logistics\V1\Model\AdditionalOption[]|null
*/
public function getAdditionalOptions()
{
return $this->container['additional_options'];
}
/**
* Sets additional_options.
*
* @param \TNT\Ebay\Sell\Logistics\V1\Model\AdditionalOption[]|null $additional_options Contains service and pricing information for one or more shipping options that are offered by the carrier and can be purchased in addition to the base shipping service provided by this rate. Shipping options can include items such as <code>INSURANCE</code> and <code>SIGNATURE</code>.
*
* @return self
*/
public function setAdditionalOptions($additional_options)
{
$this->container['additional_options'] = $additional_options;
return $this;
}
/**
* Gets base_shipping_cost.
*
* @return \TNT\Ebay\Sell\Logistics\V1\Model\Amount|null
*/
public function getBaseShippingCost()
{
return $this->container['base_shipping_cost'];
}
/**
* Sets base_shipping_cost.
*
* @param \TNT\Ebay\Sell\Logistics\V1\Model\Amount|null $base_shipping_cost base_shipping_cost
*
* @return self
*/
public function setBaseShippingCost($base_shipping_cost)
{
$this->container['base_shipping_cost'] = $base_shipping_cost;
return $this;
}
/**
* Gets destination_time_zone.
*
* @return string|null
*/
public function getDestinationTimeZone()
{
return $this->container['destination_time_zone'];
}
/**
* Sets destination_time_zone.
*
* @param string|null $destination_time_zone The name of the time zone region, as defined in the <a href=\"http://www.iana.org/time-zones\" target=\"_blank\">IANA Time Zone Database</a>, to which the package is being shipped. <br><br>Delivery dates are calculated relative to this time zone. <br><br><span class=\"tablenote\"><strong>Note:</strong> This is different from a Coordinated Universal Time (UTC) offset. For example, the <i>America/Los_Angeles</i> time zone identifies a region with the UTC standard time offset of <code>-08:00</code>, but so do several other time zones, including <i>America/Tijuana</i>,<i>America/Dawson</i>, and <i>Pacific/Pitcairn</i>.</span>
*
* @return self
*/
public function setDestinationTimeZone($destination_time_zone)
{
$this->container['destination_time_zone'] = $destination_time_zone;
return $this;
}
/**
* Gets max_estimated_delivery_date.
*
* @return string|null
*/
public function getMaxEstimatedDeliveryDate()
{
return $this->container['max_estimated_delivery_date'];
}
/**
* Sets max_estimated_delivery_date.
*
* @param string|null $max_estimated_delivery_date The latest stated date and time the shipment will be delivered at this rate. <br><br>The time stamp is formatted as an <a href=\"https://www.iso.org/iso-8601-date-and-time-format.html\" title=\"https://www.iso.org\" target=\"_blank\">ISO 8601</a> string, which is based on the 24-hour Coordinated Universal Time (UTC) clock. <br><br><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[HH]:[MM]:[SS].[SSS]Z</code> <br><b>Example:</b> <code>2018-08-20T07:09:00.000Z</code>
*
* @return self
*/
public function setMaxEstimatedDeliveryDate($max_estimated_delivery_date)
{
$this->container['max_estimated_delivery_date'] = $max_estimated_delivery_date;
return $this;
}
/**
* Gets min_estimated_delivery_date.
*
* @return string|null
*/
public function getMinEstimatedDeliveryDate()
{
return $this->container['min_estimated_delivery_date'];
}
/**
* Sets min_estimated_delivery_date.
*
* @param string|null $min_estimated_delivery_date The estimated earliest date and time the shipment will be delivered at this rate. The time stamp is formatted as an ISO 8601 UTC string.
*
* @return self
*/
public function setMinEstimatedDeliveryDate($min_estimated_delivery_date)
{
$this->container['min_estimated_delivery_date'] = $min_estimated_delivery_date;
return $this;
}
/**
* Gets pickup_networks.
*
* @return string[]|null
*/
public function getPickupNetworks()
{
return $this->container['pickup_networks'];
}
/**
* Sets pickup_networks.
*
* @param string[]|null $pickup_networks a list of pickup networks compatible with the shipping service
*
* @return self
*/
public function setPickupNetworks($pickup_networks)
{
$this->container['pickup_networks'] = $pickup_networks;
return $this;
}
/**
* Gets pickup_slots.
*
* @return \TNT\Ebay\Sell\Logistics\V1\Model\PickupSlot[]|null
*/
public function getPickupSlots()
{
return $this->container['pickup_slots'];
}
/**
* Sets pickup_slots.
*
* @param \TNT\Ebay\Sell\Logistics\V1\Model\PickupSlot[]|null $pickup_slots a list of available pickup slots for the package
*
* @return self
*/
public function setPickupSlots($pickup_slots)
{
$this->container['pickup_slots'] = $pickup_slots;
return $this;
}
/**
* Gets pickup_type.
*
* @return string|null
*/
public function getPickupType()
{
return $this->container['pickup_type'];
}
/**
* Sets pickup_type.
*
* @param string|null $pickup_type The type of pickup or drop-off service associated with the <b>pickupSlots</b> time frames. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/logistics/types/api:PickupTypeEnum'>eBay API documentation</a>
*
* @return self
*/
public function setPickupType($pickup_type)
{
$this->container['pickup_type'] = $pickup_type;
return $this;
}
/**
* Gets rate_id.
*
* @return string|null
*/
public function getRateId()
{
return $this->container['rate_id'];
}
/**
* Sets rate_id.
*
* @param string|null $rate_id the unique eBay-assigned ID for this shipping rate
*
* @return self
*/
public function setRateId($rate_id)
{
$this->container['rate_id'] = $rate_id;
return $this;
}
/**
* Gets rate_recommendation.
*
* @return string[]|null
*/
public function getRateRecommendation()
{
return $this->container['rate_recommendation'];
}
/**
* Sets rate_recommendation.
*
* @param string[]|null $rate_recommendation A list of reasons this rate is recommended. Available values are: <ul> <li><code>BUYER_CHOSEN</code> — The rate meets or exceeds the requirements of the buyer's preferred shipping option.</li> <li><code>CHEAPEST_ON_TIME</code> — The rate is the cheapest rate available that will provide delivery within the seller's time frame commitment.</li> <li><code>EBAY_PLUS_OK</code> — The rate complies with the shipping requirements of the eBay Plus program.</li> <li><code>FASTEST_ON_TIME</code> — The rate has the fastest shipping time, and will provide delivery within the seller's time frame commitment.</li> <li><code>GUARANTEED_DELIVERY_OK</code> — The rate complies with the shipping requirements of the eBay Guaranteed Delivery program.</li></ul>
*
* @return self
*/
public function setRateRecommendation($rate_recommendation)
{
$this->container['rate_recommendation'] = $rate_recommendation;
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 code name of the shipping carrier who will provide the service identified by <b>shippingServiceCode</b>
*
* @return self
*/
public function setShippingCarrierCode($shipping_carrier_code)
{
$this->container['shipping_carrier_code'] = $shipping_carrier_code;
return $this;
}
/**
* Gets shipping_carrier_name.
*
* @return string|null
*/
public function getShippingCarrierName()
{
return $this->container['shipping_carrier_name'];
}
/**
* Sets shipping_carrier_name.
*
* @param string|null $shipping_carrier_name the common name of the shipping carrier
*
* @return self
*/
public function setShippingCarrierName($shipping_carrier_name)
{
$this->container['shipping_carrier_name'] = $shipping_carrier_name;
return $this;
}
/**
* Gets shipping_service_code.
*
* @return string|null
*/
public function getShippingServiceCode()
{
return $this->container['shipping_service_code'];
}
/**
* Sets shipping_service_code.
*
* @param string|null $shipping_service_code the code name of the shipping service to be provided by the carrier identified by <b>shippingCarrierCode</b>
*
* @return self
*/
public function setShippingServiceCode($shipping_service_code)
{
$this->container['shipping_service_code'] = $shipping_service_code;
return $this;
}
/**
* Gets shipping_service_name.
*
* @return string|null
*/
public function getShippingServiceName()
{
return $this->container['shipping_service_name'];
}
/**
* Sets shipping_service_name.
*
* @param string|null $shipping_service_name the common name of the shipping service
*
* @return self
*/
public function setShippingServiceName($shipping_service_name)
{
$this->container['shipping_service_name'] = $shipping_service_name;
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));
}
}