src/Sell/Compliance/V1/Model/ComplianceDetail.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);
/**
* ComplianceDetail.
*
* PHP version ^7.2 || ^8.0
*
* @category Class
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*/
/**
* Compliance API.
*
* Service for providing information to sellers about their listings being non-compliant, or at risk for becoming non-compliant, against eBay listing policies.
*
* The version of the OpenAPI document: 1.4.1
* 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\Compliance\V1\Model;
use TNT\Ebay\Sell\Compliance\V1\ObjectSerializer;
/**
* ComplianceDetail Class Doc Comment.
*
* @category Class
*
* @description This type is used by each listing violation that is returned under the violations container.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class ComplianceDetail implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'ComplianceDetail';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'reason_code' => 'string',
'message' => 'string',
'variation' => '\TNT\Ebay\Sell\Compliance\V1\Model\VariationDetails',
'violation_data' => '\TNT\Ebay\Sell\Compliance\V1\Model\NameValueList[]',
'corrective_recommendations' => '\TNT\Ebay\Sell\Compliance\V1\Model\CorrectiveRecommendations',
'compliance_state' => '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 = [
'reason_code' => null,
'message' => null,
'variation' => null,
'violation_data' => null,
'corrective_recommendations' => null,
'compliance_state' => 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 = [
'reason_code' => 'reasonCode',
'message' => 'message',
'variation' => 'variation',
'violation_data' => 'violationData',
'corrective_recommendations' => 'correctiveRecommendations',
'compliance_state' => 'complianceState',
];
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @var string[]
*/
protected static $setters = [
'reason_code' => 'setReasonCode',
'message' => 'setMessage',
'variation' => 'setVariation',
'violation_data' => 'setViolationData',
'corrective_recommendations' => 'setCorrectiveRecommendations',
'compliance_state' => 'setComplianceState',
];
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @var string[]
*/
protected static $getters = [
'reason_code' => 'getReasonCode',
'message' => 'getMessage',
'variation' => 'getVariation',
'violation_data' => 'getViolationData',
'corrective_recommendations' => 'getCorrectiveRecommendations',
'compliance_state' => 'getComplianceState',
];
/**
* 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['reason_code'] = $data['reason_code'] ?? null;
$this->container['message'] = $data['message'] ?? null;
$this->container['variation'] = $data['variation'] ?? null;
$this->container['violation_data'] = $data['violation_data'] ?? null;
$this->container['corrective_recommendations'] = $data['corrective_recommendations'] ?? null;
$this->container['compliance_state'] = $data['compliance_state'] ?? 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 reason_code.
*
* @return string|null
*/
public function getReasonCode()
{
return $this->container['reason_code'];
}
/**
* Sets reason_code.
*
* @param string|null $reason_code This value states the nature of the listing violation. A reasonCode value is returned for each listing violation, and each compliance type can have several reason codes and related messages. The reasonCode values vary by compliance type. The reason codes for each compliance type are summarized below. Aspects adoption The reason codes for ASPECTS_ADOPTION compliance indicate that for the given violation, aspects listed in the violationData container are either missing from the listing or they have invalid values. The reason codes specify whether the violation is for required aspects, recommended (preferred) aspects, or soon to be required aspects. MISSING_OR_INVALID_REQUIRED_ASPECTS MISSING_OR_INVALID_PREFERRED_ASPECTS MISSING_OR_INVALID_SOON_TO_BE_REQUIRED_ASPECTS HTTPS The reason codes for HTTPS compliance identify where in the listing the violation occurs. For HTTPS policy violations, the seller will just need to remove the HTTP link (or update to HTTPS) from the listing details or product details: NON_SECURE_HTTP_LINK_IN_LISTING NON_SECURE_HTTP_LINK_IN_PRODUCT Non-eBay links The reason codes for OUTSIDE_EBAY_BUYING_AND_SELLING compliance identify the specific type of data (e.g., telephone number) that violated the policy. For each of these violations, the seller will just need to revise the listing, removing this information: UNAPPROVED_DOMAIN_WEBLINK_IN_LISTING PHONE_NUMBER_IN_LISTING EMAIL_ADDRESS_IN_LISTING Product adoption Product Adoption is not enforced at this time. Product adoption conformance Product Adoption is not enforced at this time. Returns policy The only RETURNS_POLICY reason code is UNSUPPORTED_RETURNS_PERIOD. The seller will have to revise their listing (or return business policy) with a supported return period for the site and category. The GetCategoryFeatures call of the Trading API can be used to verify the supported return periods for a particular category. For most eBay categories, the minimum return period that can be stated in a Returns Policy is 14 days for domestic and international sales, but some categories require a minimum 30-day return period.
*
* @return self
*/
public function setReasonCode($reason_code)
{
$this->container['reason_code'] = $reason_code;
return $this;
}
/**
* Gets message.
*
* @return string|null
*/
public function getMessage()
{
return $this->container['message'];
}
/**
* Sets message.
*
* @param string|null $message This field provides a textual summary of the listing violation. A message field is returned for each listing violation. This message will vary widely based on the compliance type and corresponding reason code.
*
* @return self
*/
public function setMessage($message)
{
$this->container['message'] = $message;
return $this;
}
/**
* Gets variation.
*
* @return \TNT\Ebay\Sell\Compliance\V1\Model\VariationDetails|null
*/
public function getVariation()
{
return $this->container['variation'];
}
/**
* Sets variation.
*
* @param \TNT\Ebay\Sell\Compliance\V1\Model\VariationDetails|null $variation variation
*
* @return self
*/
public function setVariation($variation)
{
$this->container['variation'] = $variation;
return $this;
}
/**
* Gets violation_data.
*
* @return \TNT\Ebay\Sell\Compliance\V1\Model\NameValueList[]|null
*/
public function getViolationData()
{
return $this->container['violation_data'];
}
/**
* Sets violation_data.
*
* @param \TNT\Ebay\Sell\Compliance\V1\Model\NameValueList[]|null $violation_data This container provides more information about the listing violation, if applicable. The type of information that appears here will vary based on the compliance type and type of violation. For example, for ASPECTS_ADOPTION violations, this container lists the missing aspect(s) or aspect(s) with invalid values.
*
* @return self
*/
public function setViolationData($violation_data)
{
$this->container['violation_data'] = $violation_data;
return $this;
}
/**
* Gets corrective_recommendations.
*
* @return \TNT\Ebay\Sell\Compliance\V1\Model\CorrectiveRecommendations|null
*/
public function getCorrectiveRecommendations()
{
return $this->container['corrective_recommendations'];
}
/**
* Sets corrective_recommendations.
*
* @param \TNT\Ebay\Sell\Compliance\V1\Model\CorrectiveRecommendations|null $corrective_recommendations corrective_recommendations
*
* @return self
*/
public function setCorrectiveRecommendations($corrective_recommendations)
{
$this->container['corrective_recommendations'] = $corrective_recommendations;
return $this;
}
/**
* Gets compliance_state.
*
* @return string|null
*/
public function getComplianceState()
{
return $this->container['compliance_state'];
}
/**
* Sets compliance_state.
*
* @param string|null $compliance_state The enumeration value returned in this field indicates if the listing violation is considered to be OUT_OF_COMPLIANCE with an eBay listing policy, or the listing is considered to be AT_RISK of becoming non-compliant against an eBay listing policy. Generally, OUT_OF_COMPLIANCE policy violations can prevent the seller from revising a listing until the underlying violation(s) can be remedied. When the compliance state is AT_RISK, the seller is not blocked from revising the listing, but the seller should correct the violation to prevent the listing from being blocked for revisions in the future. Note: This field is returned for most violations, but not all. In the case that this field is not returned, it can be assumed that the state of the listing violation is OUT_OF_COMPLIANCE. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/compliance/types/com:ComplianceStateEnum'>eBay API documentation</a>
*
* @return self
*/
public function setComplianceState($compliance_state)
{
$this->container['compliance_state'] = $compliance_state;
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));
}
}