src/Sell/Finances/V1/Model/SellerFundsSummaryResponse.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);
/**
* SellerFundsSummaryResponse.
*
* PHP version ^7.2 || ^8.0
*
* @category Class
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*/
/**
* eBay Finances API.
*
* This API is used to retrieve seller payouts and monetary transaction details related to those payouts.
*
* The version of the OpenAPI document: v1.15.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\Finances\V1\Model;
use TNT\Ebay\Sell\Finances\V1\ObjectSerializer;
/**
* SellerFundsSummaryResponse Class Doc Comment.
*
* @category Class
*
* @description This type is used by the response payload of the <strong>getSellerFundsSummary</strong> method. All of the funds returned in <strong>getSellerFundsSummary</strong> are funds that have not yet been paid to the seller through a seller payout. If there are no funds that are pending, on hold, or being processed for the seller's account, no response payload is returned, and an http status code of <code>204 - No Content</code> is returned instead.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class SellerFundsSummaryResponse implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'SellerFundsSummaryResponse';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'available_funds' => '\TNT\Ebay\Sell\Finances\V1\Model\Amount',
'funds_on_hold' => '\TNT\Ebay\Sell\Finances\V1\Model\Amount',
'processing_funds' => '\TNT\Ebay\Sell\Finances\V1\Model\Amount',
'total_funds' => '\TNT\Ebay\Sell\Finances\V1\Model\Amount',
];
/**
* 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 = [
'available_funds' => null,
'funds_on_hold' => null,
'processing_funds' => null,
'total_funds' => 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 = [
'available_funds' => 'availableFunds',
'funds_on_hold' => 'fundsOnHold',
'processing_funds' => 'processingFunds',
'total_funds' => 'totalFunds',
];
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @var string[]
*/
protected static $setters = [
'available_funds' => 'setAvailableFunds',
'funds_on_hold' => 'setFundsOnHold',
'processing_funds' => 'setProcessingFunds',
'total_funds' => 'setTotalFunds',
];
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @var string[]
*/
protected static $getters = [
'available_funds' => 'getAvailableFunds',
'funds_on_hold' => 'getFundsOnHold',
'processing_funds' => 'getProcessingFunds',
'total_funds' => 'getTotalFunds',
];
/**
* 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['available_funds'] = $data['available_funds'] ?? null;
$this->container['funds_on_hold'] = $data['funds_on_hold'] ?? null;
$this->container['processing_funds'] = $data['processing_funds'] ?? null;
$this->container['total_funds'] = $data['total_funds'] ?? 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 available_funds.
*
* @return \TNT\Ebay\Sell\Finances\V1\Model\Amount|null
*/
public function getAvailableFunds()
{
return $this->container['available_funds'];
}
/**
* Sets available_funds.
*
* @param \TNT\Ebay\Sell\Finances\V1\Model\Amount|null $available_funds available_funds
*
* @return self
*/
public function setAvailableFunds($available_funds)
{
$this->container['available_funds'] = $available_funds;
return $this;
}
/**
* Gets funds_on_hold.
*
* @return \TNT\Ebay\Sell\Finances\V1\Model\Amount|null
*/
public function getFundsOnHold()
{
return $this->container['funds_on_hold'];
}
/**
* Sets funds_on_hold.
*
* @param \TNT\Ebay\Sell\Finances\V1\Model\Amount|null $funds_on_hold funds_on_hold
*
* @return self
*/
public function setFundsOnHold($funds_on_hold)
{
$this->container['funds_on_hold'] = $funds_on_hold;
return $this;
}
/**
* Gets processing_funds.
*
* @return \TNT\Ebay\Sell\Finances\V1\Model\Amount|null
*/
public function getProcessingFunds()
{
return $this->container['processing_funds'];
}
/**
* Sets processing_funds.
*
* @param \TNT\Ebay\Sell\Finances\V1\Model\Amount|null $processing_funds processing_funds
*
* @return self
*/
public function setProcessingFunds($processing_funds)
{
$this->container['processing_funds'] = $processing_funds;
return $this;
}
/**
* Gets total_funds.
*
* @return \TNT\Ebay\Sell\Finances\V1\Model\Amount|null
*/
public function getTotalFunds()
{
return $this->container['total_funds'];
}
/**
* Sets total_funds.
*
* @param \TNT\Ebay\Sell\Finances\V1\Model\Amount|null $total_funds total_funds
*
* @return self
*/
public function setTotalFunds($total_funds)
{
$this->container['total_funds'] = $total_funds;
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));
}
}