src/Sell/Marketing/V1/Model/Campaign.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);
/**
* Campaign.
*
* PHP version ^7.2 || ^8.0
*
* @category Class
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*/
/**
* Marketing API.
*
* <p>The <i>Marketing API </i> offers two platforms that sellers can use to promote and advertise their products:</p> <ul><li><b>Promoted Listings</b> is an eBay ad service that lets sellers set up <i>ad campaigns </i> for the products they want to promote. eBay displays the ads in search results and in other marketing modules as <b>SPONSORED</b> listings. If an item in a Promoted Listings campaign sells, the seller is assessed a Promoted Listings fee, which is a seller-specified percentage applied to the sales price. For complete details, refer to the <a href=\"/api-docs/sell/static/marketing/pl-landing.html\">Promoted Listings playbook</a>.</li><li><b>Promotions Manager</b> gives sellers a way to offer discounts on specific items as a way to attract buyers to their inventory. Sellers can set up discounts (such as \"20% off\" and other types of offers) on specific items or on an entire customer order. To further attract buyers, eBay prominently displays promotion <i>teasers</i> throughout buyer flows. For complete details, see <a href=\"/api-docs/sell/static/marketing/promotions-manager.html\">Promotions Manager</a>.</li></ul> <p><b>Marketing reports</b>, on both the Promoted Listings and Promotions Manager platforms, give sellers information that shows the effectiveness of their marketing strategies. The data gives sellers the ability to review and fine tune their marketing efforts.</p> <p class=\"tablenote\"><b>Important!</b> Sellers must have an active eBay Store subscription, and they must accept the <b>Terms and Conditions</b> before they can make requests to these APIs in the Production environment. There are also site-specific listings requirements and restrictions associated with these marketing tools, as listed in the \"requirements and restrictions\" sections for <a href=\"/api-docs/sell/marketing/static/overview.html#PL-requirements\">Promoted Listings</a> and <a href=\"/api-docs/sell/marketing/static/overview.html#PM-requirements\">Promotions Manager</a>.</p> <p>The table below lists all the Marketing API calls grouped by resource.</p>
*
* The version of the OpenAPI document: v1.14.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\Marketing\V1\Model;
use TNT\Ebay\Sell\Marketing\V1\ObjectSerializer;
/**
* Campaign Class Doc Comment.
*
* @category Class
*
* @description This type defines the fields that describe an ad campaign.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class Campaign implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'Campaign';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'alerts' => '\TNT\Ebay\Sell\Marketing\V1\Model\Alert[]',
'budget' => '\TNT\Ebay\Sell\Marketing\V1\Model\CampaignBudget',
'campaign_criterion' => '\TNT\Ebay\Sell\Marketing\V1\Model\CampaignCriterion',
'campaign_id' => 'string',
'campaign_name' => 'string',
'campaign_status' => 'string',
'end_date' => 'string',
'funding_strategy' => '\TNT\Ebay\Sell\Marketing\V1\Model\FundingStrategy',
'marketplace_id' => 'string',
'start_date' => '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 = [
'alerts' => null,
'budget' => null,
'campaign_criterion' => null,
'campaign_id' => null,
'campaign_name' => null,
'campaign_status' => null,
'end_date' => null,
'funding_strategy' => null,
'marketplace_id' => null,
'start_date' => 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 = [
'alerts' => 'alerts',
'budget' => 'budget',
'campaign_criterion' => 'campaignCriterion',
'campaign_id' => 'campaignId',
'campaign_name' => 'campaignName',
'campaign_status' => 'campaignStatus',
'end_date' => 'endDate',
'funding_strategy' => 'fundingStrategy',
'marketplace_id' => 'marketplaceId',
'start_date' => 'startDate',
];
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @var string[]
*/
protected static $setters = [
'alerts' => 'setAlerts',
'budget' => 'setBudget',
'campaign_criterion' => 'setCampaignCriterion',
'campaign_id' => 'setCampaignId',
'campaign_name' => 'setCampaignName',
'campaign_status' => 'setCampaignStatus',
'end_date' => 'setEndDate',
'funding_strategy' => 'setFundingStrategy',
'marketplace_id' => 'setMarketplaceId',
'start_date' => 'setStartDate',
];
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @var string[]
*/
protected static $getters = [
'alerts' => 'getAlerts',
'budget' => 'getBudget',
'campaign_criterion' => 'getCampaignCriterion',
'campaign_id' => 'getCampaignId',
'campaign_name' => 'getCampaignName',
'campaign_status' => 'getCampaignStatus',
'end_date' => 'getEndDate',
'funding_strategy' => 'getFundingStrategy',
'marketplace_id' => 'getMarketplaceId',
'start_date' => 'getStartDate',
];
/**
* 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['alerts'] = $data['alerts'] ?? null;
$this->container['budget'] = $data['budget'] ?? null;
$this->container['campaign_criterion'] = $data['campaign_criterion'] ?? null;
$this->container['campaign_id'] = $data['campaign_id'] ?? null;
$this->container['campaign_name'] = $data['campaign_name'] ?? null;
$this->container['campaign_status'] = $data['campaign_status'] ?? null;
$this->container['end_date'] = $data['end_date'] ?? null;
$this->container['funding_strategy'] = $data['funding_strategy'] ?? null;
$this->container['marketplace_id'] = $data['marketplace_id'] ?? null;
$this->container['start_date'] = $data['start_date'] ?? 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 alerts.
*
* @return \TNT\Ebay\Sell\Marketing\V1\Model\Alert[]|null
*/
public function getAlerts()
{
return $this->container['alerts'];
}
/**
* Sets alerts.
*
* @param \TNT\Ebay\Sell\Marketing\V1\Model\Alert[]|null $alerts this array contains alert messages for the campaign
*
* @return self
*/
public function setAlerts($alerts)
{
$this->container['alerts'] = $alerts;
return $this;
}
/**
* Gets budget.
*
* @return \TNT\Ebay\Sell\Marketing\V1\Model\CampaignBudget|null
*/
public function getBudget()
{
return $this->container['budget'];
}
/**
* Sets budget.
*
* @param \TNT\Ebay\Sell\Marketing\V1\Model\CampaignBudget|null $budget budget
*
* @return self
*/
public function setBudget($budget)
{
$this->container['budget'] = $budget;
return $this;
}
/**
* Gets campaign_criterion.
*
* @return \TNT\Ebay\Sell\Marketing\V1\Model\CampaignCriterion|null
*/
public function getCampaignCriterion()
{
return $this->container['campaign_criterion'];
}
/**
* Sets campaign_criterion.
*
* @param \TNT\Ebay\Sell\Marketing\V1\Model\CampaignCriterion|null $campaign_criterion campaign_criterion
*
* @return self
*/
public function setCampaignCriterion($campaign_criterion)
{
$this->container['campaign_criterion'] = $campaign_criterion;
return $this;
}
/**
* Gets campaign_id.
*
* @return string|null
*/
public function getCampaignId()
{
return $this->container['campaign_id'];
}
/**
* Sets campaign_id.
*
* @param string|null $campaign_id A unique eBay-assigned ID for a campaign. This ID is generated when a campaign is created.
*
* @return self
*/
public function setCampaignId($campaign_id)
{
$this->container['campaign_id'] = $campaign_id;
return $this;
}
/**
* Gets campaign_name.
*
* @return string|null
*/
public function getCampaignName()
{
return $this->container['campaign_name'];
}
/**
* Sets campaign_name.
*
* @param string|null $campaign_name A seller-defined name for the campaign. This value must be unique for the seller. <p>You can use any alphanumeric characters in the name, except the less than (<) or greater than (>) characters.</p><b>Max length: </b>80 characters
*
* @return self
*/
public function setCampaignName($campaign_name)
{
$this->container['campaign_name'] = $campaign_name;
return $this;
}
/**
* Gets campaign_status.
*
* @return string|null
*/
public function getCampaignStatus()
{
return $this->container['campaign_status'];
}
/**
* Sets campaign_status.
*
* @param string|null $campaign_status Indicates the status of the campaign, such as <code>RUNNING</code>, <code>PAUSED</code>, and <code>ENDED</code>. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/marketing/types/pls:CampaignStatusEnum'>eBay API documentation</a>
*
* @return self
*/
public function setCampaignStatus($campaign_status)
{
$this->container['campaign_status'] = $campaign_status;
return $this;
}
/**
* Gets end_date.
*
* @return string|null
*/
public function getEndDate()
{
return $this->container['end_date'];
}
/**
* Sets end_date.
*
* @param string|null $end_date The date and time the campaign ends, in UTC format (<code>yyyy-MM-ddThh:mm:ssZ</code>). If this field is omitted, the campaign will have no defined end date, and will not end until the seller makes a decision to end the campaign with an <a href=\"/api-docs/sell/marketing/resources/campaign/methods/endCampaign\">endCampaign</a> call, or if they update the campaign at a later time with an end date.
*
* @return self
*/
public function setEndDate($end_date)
{
$this->container['end_date'] = $end_date;
return $this;
}
/**
* Gets funding_strategy.
*
* @return \TNT\Ebay\Sell\Marketing\V1\Model\FundingStrategy|null
*/
public function getFundingStrategy()
{
return $this->container['funding_strategy'];
}
/**
* Sets funding_strategy.
*
* @param \TNT\Ebay\Sell\Marketing\V1\Model\FundingStrategy|null $funding_strategy funding_strategy
*
* @return self
*/
public function setFundingStrategy($funding_strategy)
{
$this->container['funding_strategy'] = $funding_strategy;
return $this;
}
/**
* Gets marketplace_id.
*
* @return string|null
*/
public function getMarketplaceId()
{
return $this->container['marketplace_id'];
}
/**
* Sets marketplace_id.
*
* @param string|null $marketplace_id The ID of the eBay marketplace where the campaign is hosted. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/marketing/types/ba:MarketplaceIdEnum'>eBay API documentation</a>
*
* @return self
*/
public function setMarketplaceId($marketplace_id)
{
$this->container['marketplace_id'] = $marketplace_id;
return $this;
}
/**
* Gets start_date.
*
* @return string|null
*/
public function getStartDate()
{
return $this->container['start_date'];
}
/**
* Sets start_date.
*
* @param string|null $start_date The date and time the campaign starts, in UTC format (<code>yyyy-MM-ddThh:mm:ssZ</code>). For display purposes, convert this time into the local time of the seller. <p>On the date specified, the service derives the keywords for each listing in the campaign, creates an ad for each listing, and associates each new ad with the campaign. The campaign starts after this process is completed. The amount of time it takes the service to start the campaign depends on the number of listings in the campaign. Call <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaign\">getCampaign</a> to check the status of the campaign.</p>
*
* @return self
*/
public function setStartDate($start_date)
{
$this->container['start_date'] = $start_date;
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));
}
}