src/Sell/Marketing/V1/Api/AdGroupApi.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);
/**
* AdGroupApi.
*
* 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\Api;
use GuzzleHttp\Client;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\RequestOptions;
use GuzzleHttp\ClientInterface;
use GuzzleHttp\Psr7\MultipartStream;
use GuzzleHttp\Exception\GuzzleException;
use GuzzleHttp\Exception\ConnectException;
use GuzzleHttp\Exception\RequestException;
use TNT\Ebay\Sell\Marketing\V1\ApiException;
use TNT\Ebay\Sell\Marketing\V1\Configuration;
use TNT\Ebay\Sell\Marketing\V1\HeaderSelector;
use TNT\Ebay\Sell\Marketing\V1\ObjectSerializer;
/**
* AdGroupApi Class Doc Comment.
*
* @category Class
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*/
class AdGroupApi
{
/**
* @var ClientInterface
*/
protected $client;
/**
* @var Configuration
*/
protected $config;
/**
* @var HeaderSelector
*/
protected $headerSelector;
/**
* @var int Host index
*/
protected $hostIndex;
/**
* @param ClientInterface $client
* @param Configuration $config
* @param HeaderSelector $selector
* @param int $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec
*/
public function __construct(
ClientInterface $client = null,
Configuration $config = null,
HeaderSelector $selector = null,
$hostIndex = 0
) {
$this->client = $client ?: new Client();
$this->config = $config ?: new Configuration();
$this->headerSelector = $selector ?: new HeaderSelector();
$this->hostIndex = $hostIndex;
}
/**
* Set the host index.
*
* @param int $hostIndex Host index (required)
*/
public function setHostIndex($hostIndex): void
{
$this->hostIndex = $hostIndex;
}
/**
* Get the host index.
*
* @return int Host index
*/
public function getHostIndex()
{
return $this->hostIndex;
}
/**
* @return Configuration
*/
public function getConfiguration()
{
return $this->config;
}
/**
* Operation createAdGroup.
*
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\CreateAdGroupRequest $create_ad_group_request This type defines the fields for the <b>createAdGroup</b> request. (required)
*
* @throws \TNT\Ebay\Sell\Marketing\V1\ApiException on non-2xx response
* @throws \InvalidArgumentException
*
* @return object
*/
public function createAdGroup($campaign_id, $create_ad_group_request)
{
[$response] = $this->createAdGroupWithHttpInfo($campaign_id, $create_ad_group_request);
return $response;
}
/**
* Operation createAdGroupWithHttpInfo.
*
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\CreateAdGroupRequest $create_ad_group_request This type defines the fields for the <b>createAdGroup</b> request. (required)
*
* @throws \TNT\Ebay\Sell\Marketing\V1\ApiException on non-2xx response
* @throws \InvalidArgumentException
*
* @return array of object, HTTP status code, HTTP response headers (array of strings)
*/
public function createAdGroupWithHttpInfo($campaign_id, $create_ad_group_request)
{
$request = $this->createAdGroupRequest($campaign_id, $create_ad_group_request);
try {
$options = $this->createHttpClientOption();
try {
$response = $this->client->send($request, $options);
} catch (RequestException $e) {
throw new ApiException("[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? (string) $e->getResponse()->getBody() : null, $e);
} catch (ConnectException $e) {
throw new ApiException("[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null, $e);
} catch (GuzzleException $e) {
throw new ApiException("[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null, $e);
}
$statusCode = $response->getStatusCode();
if ($statusCode < 200 || $statusCode > 299) {
throw new ApiException(sprintf('[%d] Error connecting to the API (%s)', $statusCode, (string) $request->getUri()), $statusCode, $response->getHeaders(), (string) $response->getBody());
}
switch ($statusCode) {
case 201:
if ('object' === '\SplFileObject') {
$content = $response->getBody(); // Stream goes to serializer.
} else {
$content = (string) $response->getBody();
}
return [
ObjectSerializer::deserialize($content, 'object', []),
$response->getStatusCode(),
$response->getHeaders(),
];
}
$returnType = 'object';
if ($returnType === '\SplFileObject') {
$content = $response->getBody(); // Stream goes to serializer.
} else {
$content = (string) $response->getBody();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders(),
];
} catch (ApiException $e) {
switch ($e->getCode()) {
case 201:
$data = ObjectSerializer::deserialize(
$e->getResponseBody(),
'object',
$e->getResponseHeaders()
);
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* Operation createAdGroupAsync.
*
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\CreateAdGroupRequest $create_ad_group_request This type defines the fields for the <b>createAdGroup</b> request. (required)
*
* @throws \InvalidArgumentException
*
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function createAdGroupAsync($campaign_id, $create_ad_group_request)
{
return $this->createAdGroupAsyncWithHttpInfo($campaign_id, $create_ad_group_request)
->then(
function ($response) {
return $response[0];
}
);
}
/**
* Operation createAdGroupAsyncWithHttpInfo.
*
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\CreateAdGroupRequest $create_ad_group_request This type defines the fields for the <b>createAdGroup</b> request. (required)
*
* @throws \InvalidArgumentException
*
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function createAdGroupAsyncWithHttpInfo($campaign_id, $create_ad_group_request)
{
$returnType = 'object';
$request = $this->createAdGroupRequest($campaign_id, $create_ad_group_request);
return $this->client
->sendAsync($request, $this->createHttpClientOption())
->then(
function ($response) use ($returnType) {
if ($returnType === '\SplFileObject') {
$content = $response->getBody(); // Stream goes to serializer.
} else {
$content = (string) $response->getBody();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders(),
];
},
function ($exception) {
$response = $exception->getResponse();
$statusCode = $response->getStatusCode();
throw new ApiException(sprintf('[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri()), $statusCode, $response->getHeaders(), (string) $response->getBody(), $exception instanceof \Throwable ? $exception : null);
}
);
}
/**
* Create request for operation 'createAdGroup'.
*
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\CreateAdGroupRequest $create_ad_group_request This type defines the fields for the <b>createAdGroup</b> request. (required)
*
* @throws \InvalidArgumentException
*
* @return \GuzzleHttp\Psr7\Request
*/
public function createAdGroupRequest($campaign_id, $create_ad_group_request)
{
// Verify the required parameter 'campaign_id' is set.
if ($campaign_id === null || (\is_array($campaign_id) && count($campaign_id) === 0)) {
throw new \InvalidArgumentException('Missing the required parameter $campaign_id when calling createAdGroup');
}
// Verify the required parameter 'create_ad_group_request' is set.
if ($create_ad_group_request === null || (\is_array($create_ad_group_request) && count($create_ad_group_request) === 0)) {
throw new \InvalidArgumentException('Missing the required parameter $create_ad_group_request when calling createAdGroup');
}
$resourcePath = '/ad_campaign/{campaign_id}/ad_group';
$formParams = [];
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// path params
if ($campaign_id !== null) {
$resourcePath = str_replace(
'{campaign_id}',
ObjectSerializer::toPathValue($campaign_id),
$resourcePath
);
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// For model (json/xml)
if (isset($create_ad_group_request)) {
if ($headers['Content-Type'] === 'application/json') {
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($create_ad_group_request));
} else {
$httpBody = $create_ad_group_request;
}
} elseif (count($formParams) > 0) {
if ($multipart) {
$multipartContents = [];
foreach ($formParams as $formParamName => $formParamValue) {
$formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue];
foreach ($formParamValueItems as $formParamValueItem) {
$multipartContents[] = [
'name' => $formParamName,
'contents' => $formParamValueItem,
];
}
}
// For HTTP post (form)
$httpBody = new MultipartStream($multipartContents);
} elseif ($headers['Content-Type'] === 'application/json') {
$httpBody = \GuzzleHttp\json_encode($formParams);
} else {
// For HTTP post (form)
$httpBody = ObjectSerializer::buildQuery($queryParams);
}
}
// this endpoint requires OAuth (access token)
if (! empty($this->config->getAccessToken())) {
$headers['Authorization'] = 'Bearer '.$this->config->getAccessToken();
}
// this endpoint requires OAuth (access token)
if (! empty($this->config->getAccessToken())) {
$headers['Authorization'] = 'Bearer '.$this->config->getAccessToken();
}
$defaultHeaders = [];
if ($this->config->getUserAgent()) {
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
}
$headers = array_merge(
$defaultHeaders,
$headerParams,
$headers
);
$query = ObjectSerializer::buildQuery($queryParams);
return new Request(
'POST',
$this->config->getHost().$resourcePath.($query ? "?{$query}" : ''),
$headers,
$httpBody
);
}
/**
* Operation getAdGroup.
*
* @param string $ad_group_id The ID of the ad group that shall be retrieved. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
*
* @throws \TNT\Ebay\Sell\Marketing\V1\ApiException on non-2xx response
* @throws \InvalidArgumentException
*
* @return \TNT\Ebay\Sell\Marketing\V1\Model\AdGroup
*/
public function getAdGroup($ad_group_id, $campaign_id)
{
[$response] = $this->getAdGroupWithHttpInfo($ad_group_id, $campaign_id);
return $response;
}
/**
* Operation getAdGroupWithHttpInfo.
*
* @param string $ad_group_id The ID of the ad group that shall be retrieved. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
*
* @throws \TNT\Ebay\Sell\Marketing\V1\ApiException on non-2xx response
* @throws \InvalidArgumentException
*
* @return array of \TNT\Ebay\Sell\Marketing\V1\Model\AdGroup, HTTP status code, HTTP response headers (array of strings)
*/
public function getAdGroupWithHttpInfo($ad_group_id, $campaign_id)
{
$request = $this->getAdGroupRequest($ad_group_id, $campaign_id);
try {
$options = $this->createHttpClientOption();
try {
$response = $this->client->send($request, $options);
} catch (RequestException $e) {
throw new ApiException("[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? (string) $e->getResponse()->getBody() : null, $e);
} catch (ConnectException $e) {
throw new ApiException("[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null, $e);
} catch (GuzzleException $e) {
throw new ApiException("[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null, $e);
}
$statusCode = $response->getStatusCode();
if ($statusCode < 200 || $statusCode > 299) {
throw new ApiException(sprintf('[%d] Error connecting to the API (%s)', $statusCode, (string) $request->getUri()), $statusCode, $response->getHeaders(), (string) $response->getBody());
}
switch ($statusCode) {
case 200:
if ('\TNT\Ebay\Sell\Marketing\V1\Model\AdGroup' === '\SplFileObject') {
$content = $response->getBody(); // Stream goes to serializer.
} else {
$content = (string) $response->getBody();
}
return [
ObjectSerializer::deserialize($content, '\TNT\Ebay\Sell\Marketing\V1\Model\AdGroup', []),
$response->getStatusCode(),
$response->getHeaders(),
];
}
$returnType = '\TNT\Ebay\Sell\Marketing\V1\Model\AdGroup';
if ($returnType === '\SplFileObject') {
$content = $response->getBody(); // Stream goes to serializer.
} else {
$content = (string) $response->getBody();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders(),
];
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = ObjectSerializer::deserialize(
$e->getResponseBody(),
'\TNT\Ebay\Sell\Marketing\V1\Model\AdGroup',
$e->getResponseHeaders()
);
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* Operation getAdGroupAsync.
*
* @param string $ad_group_id The ID of the ad group that shall be retrieved. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
*
* @throws \InvalidArgumentException
*
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function getAdGroupAsync($ad_group_id, $campaign_id)
{
return $this->getAdGroupAsyncWithHttpInfo($ad_group_id, $campaign_id)
->then(
function ($response) {
return $response[0];
}
);
}
/**
* Operation getAdGroupAsyncWithHttpInfo.
*
* @param string $ad_group_id The ID of the ad group that shall be retrieved. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
*
* @throws \InvalidArgumentException
*
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function getAdGroupAsyncWithHttpInfo($ad_group_id, $campaign_id)
{
$returnType = '\TNT\Ebay\Sell\Marketing\V1\Model\AdGroup';
$request = $this->getAdGroupRequest($ad_group_id, $campaign_id);
return $this->client
->sendAsync($request, $this->createHttpClientOption())
->then(
function ($response) use ($returnType) {
if ($returnType === '\SplFileObject') {
$content = $response->getBody(); // Stream goes to serializer.
} else {
$content = (string) $response->getBody();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders(),
];
},
function ($exception) {
$response = $exception->getResponse();
$statusCode = $response->getStatusCode();
throw new ApiException(sprintf('[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri()), $statusCode, $response->getHeaders(), (string) $response->getBody(), $exception instanceof \Throwable ? $exception : null);
}
);
}
/**
* Create request for operation 'getAdGroup'.
*
* @param string $ad_group_id The ID of the ad group that shall be retrieved. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
*
* @throws \InvalidArgumentException
*
* @return \GuzzleHttp\Psr7\Request
*/
public function getAdGroupRequest($ad_group_id, $campaign_id)
{
// Verify the required parameter 'ad_group_id' is set.
if ($ad_group_id === null || (\is_array($ad_group_id) && count($ad_group_id) === 0)) {
throw new \InvalidArgumentException('Missing the required parameter $ad_group_id when calling getAdGroup');
}
// Verify the required parameter 'campaign_id' is set.
if ($campaign_id === null || (\is_array($campaign_id) && count($campaign_id) === 0)) {
throw new \InvalidArgumentException('Missing the required parameter $campaign_id when calling getAdGroup');
}
$resourcePath = '/ad_campaign/{campaign_id}/ad_group/{ad_group_id}';
$formParams = [];
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// path params
if ($ad_group_id !== null) {
$resourcePath = str_replace(
'{ad_group_id}',
ObjectSerializer::toPathValue($ad_group_id),
$resourcePath
);
}
// path params
if ($campaign_id !== null) {
$resourcePath = str_replace(
'{campaign_id}',
ObjectSerializer::toPathValue($campaign_id),
$resourcePath
);
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// For model (json/xml)
if (count($formParams) > 0) {
if ($multipart) {
$multipartContents = [];
foreach ($formParams as $formParamName => $formParamValue) {
$formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue];
foreach ($formParamValueItems as $formParamValueItem) {
$multipartContents[] = [
'name' => $formParamName,
'contents' => $formParamValueItem,
];
}
}
// For HTTP post (form)
$httpBody = new MultipartStream($multipartContents);
} elseif ($headers['Content-Type'] === 'application/json') {
$httpBody = \GuzzleHttp\json_encode($formParams);
} else {
// For HTTP post (form)
$httpBody = ObjectSerializer::buildQuery($queryParams);
}
}
// this endpoint requires OAuth (access token)
if (! empty($this->config->getAccessToken())) {
$headers['Authorization'] = 'Bearer '.$this->config->getAccessToken();
}
// this endpoint requires OAuth (access token)
if (! empty($this->config->getAccessToken())) {
$headers['Authorization'] = 'Bearer '.$this->config->getAccessToken();
}
$defaultHeaders = [];
if ($this->config->getUserAgent()) {
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
}
$headers = array_merge(
$defaultHeaders,
$headerParams,
$headers
);
$query = ObjectSerializer::buildQuery($queryParams);
return new Request(
'GET',
$this->config->getHost().$resourcePath.($query ? "?{$query}" : ''),
$headers,
$httpBody
);
}
/**
* Operation getAdGroups.
*
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param string $ad_group_status A comma-separated list of ad group statuses. The results will be filtered to only include the given statuses of the ad group.<br /><br />The results might not include these ad groups if other search conditions exclude them. (optional)
* @param string $limit The number of results, from the current result set, to be returned in a single page. (optional)
* @param string $offset The number of results that will be skipped in the result set. This is used with the <b>limit</b> field to control the pagination of the output.<br /><br />For example, if the <b>offset</b> is set to <code>0</code> and the <b>limit</b> is set to <code>10</code>, the method will retrieve items 1 through 10 from the list of items returned. If the <b>offset</b> is set to <code>10</code> and the <b>limit</b> is set to <code>10</code>, the method will retrieve items 11 through 20 from the list of items returned.<br><br><b>Default</b>: <code>0</code> (optional)
*
* @throws \TNT\Ebay\Sell\Marketing\V1\ApiException on non-2xx response
* @throws \InvalidArgumentException
*
* @return \TNT\Ebay\Sell\Marketing\V1\Model\AdGroupPagedCollectionResponse
*/
public function getAdGroups($campaign_id, $ad_group_status = null, $limit = null, $offset = null)
{
[$response] = $this->getAdGroupsWithHttpInfo($campaign_id, $ad_group_status, $limit, $offset);
return $response;
}
/**
* Operation getAdGroupsWithHttpInfo.
*
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param string $ad_group_status A comma-separated list of ad group statuses. The results will be filtered to only include the given statuses of the ad group.<br /><br />The results might not include these ad groups if other search conditions exclude them. (optional)
* @param string $limit The number of results, from the current result set, to be returned in a single page. (optional)
* @param string $offset The number of results that will be skipped in the result set. This is used with the <b>limit</b> field to control the pagination of the output.<br /><br />For example, if the <b>offset</b> is set to <code>0</code> and the <b>limit</b> is set to <code>10</code>, the method will retrieve items 1 through 10 from the list of items returned. If the <b>offset</b> is set to <code>10</code> and the <b>limit</b> is set to <code>10</code>, the method will retrieve items 11 through 20 from the list of items returned.<br><br><b>Default</b>: <code>0</code> (optional)
*
* @throws \TNT\Ebay\Sell\Marketing\V1\ApiException on non-2xx response
* @throws \InvalidArgumentException
*
* @return array of \TNT\Ebay\Sell\Marketing\V1\Model\AdGroupPagedCollectionResponse, HTTP status code, HTTP response headers (array of strings)
*/
public function getAdGroupsWithHttpInfo($campaign_id, $ad_group_status = null, $limit = null, $offset = null)
{
$request = $this->getAdGroupsRequest($campaign_id, $ad_group_status, $limit, $offset);
try {
$options = $this->createHttpClientOption();
try {
$response = $this->client->send($request, $options);
} catch (RequestException $e) {
throw new ApiException("[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? (string) $e->getResponse()->getBody() : null, $e);
} catch (ConnectException $e) {
throw new ApiException("[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null, $e);
} catch (GuzzleException $e) {
throw new ApiException("[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null, $e);
}
$statusCode = $response->getStatusCode();
if ($statusCode < 200 || $statusCode > 299) {
throw new ApiException(sprintf('[%d] Error connecting to the API (%s)', $statusCode, (string) $request->getUri()), $statusCode, $response->getHeaders(), (string) $response->getBody());
}
switch ($statusCode) {
case 200:
if ('\TNT\Ebay\Sell\Marketing\V1\Model\AdGroupPagedCollectionResponse' === '\SplFileObject') {
$content = $response->getBody(); // Stream goes to serializer.
} else {
$content = (string) $response->getBody();
}
return [
ObjectSerializer::deserialize($content, '\TNT\Ebay\Sell\Marketing\V1\Model\AdGroupPagedCollectionResponse', []),
$response->getStatusCode(),
$response->getHeaders(),
];
}
$returnType = '\TNT\Ebay\Sell\Marketing\V1\Model\AdGroupPagedCollectionResponse';
if ($returnType === '\SplFileObject') {
$content = $response->getBody(); // Stream goes to serializer.
} else {
$content = (string) $response->getBody();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders(),
];
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = ObjectSerializer::deserialize(
$e->getResponseBody(),
'\TNT\Ebay\Sell\Marketing\V1\Model\AdGroupPagedCollectionResponse',
$e->getResponseHeaders()
);
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* Operation getAdGroupsAsync.
*
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param string $ad_group_status A comma-separated list of ad group statuses. The results will be filtered to only include the given statuses of the ad group.<br /><br />The results might not include these ad groups if other search conditions exclude them. (optional)
* @param string $limit The number of results, from the current result set, to be returned in a single page. (optional)
* @param string $offset The number of results that will be skipped in the result set. This is used with the <b>limit</b> field to control the pagination of the output.<br /><br />For example, if the <b>offset</b> is set to <code>0</code> and the <b>limit</b> is set to <code>10</code>, the method will retrieve items 1 through 10 from the list of items returned. If the <b>offset</b> is set to <code>10</code> and the <b>limit</b> is set to <code>10</code>, the method will retrieve items 11 through 20 from the list of items returned.<br><br><b>Default</b>: <code>0</code> (optional)
*
* @throws \InvalidArgumentException
*
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function getAdGroupsAsync($campaign_id, $ad_group_status = null, $limit = null, $offset = null)
{
return $this->getAdGroupsAsyncWithHttpInfo($campaign_id, $ad_group_status, $limit, $offset)
->then(
function ($response) {
return $response[0];
}
);
}
/**
* Operation getAdGroupsAsyncWithHttpInfo.
*
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param string $ad_group_status A comma-separated list of ad group statuses. The results will be filtered to only include the given statuses of the ad group.<br /><br />The results might not include these ad groups if other search conditions exclude them. (optional)
* @param string $limit The number of results, from the current result set, to be returned in a single page. (optional)
* @param string $offset The number of results that will be skipped in the result set. This is used with the <b>limit</b> field to control the pagination of the output.<br /><br />For example, if the <b>offset</b> is set to <code>0</code> and the <b>limit</b> is set to <code>10</code>, the method will retrieve items 1 through 10 from the list of items returned. If the <b>offset</b> is set to <code>10</code> and the <b>limit</b> is set to <code>10</code>, the method will retrieve items 11 through 20 from the list of items returned.<br><br><b>Default</b>: <code>0</code> (optional)
*
* @throws \InvalidArgumentException
*
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function getAdGroupsAsyncWithHttpInfo($campaign_id, $ad_group_status = null, $limit = null, $offset = null)
{
$returnType = '\TNT\Ebay\Sell\Marketing\V1\Model\AdGroupPagedCollectionResponse';
$request = $this->getAdGroupsRequest($campaign_id, $ad_group_status, $limit, $offset);
return $this->client
->sendAsync($request, $this->createHttpClientOption())
->then(
function ($response) use ($returnType) {
if ($returnType === '\SplFileObject') {
$content = $response->getBody(); // Stream goes to serializer.
} else {
$content = (string) $response->getBody();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders(),
];
},
function ($exception) {
$response = $exception->getResponse();
$statusCode = $response->getStatusCode();
throw new ApiException(sprintf('[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri()), $statusCode, $response->getHeaders(), (string) $response->getBody(), $exception instanceof \Throwable ? $exception : null);
}
);
}
/**
* Create request for operation 'getAdGroups'.
*
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param string $ad_group_status A comma-separated list of ad group statuses. The results will be filtered to only include the given statuses of the ad group.<br /><br />The results might not include these ad groups if other search conditions exclude them. (optional)
* @param string $limit The number of results, from the current result set, to be returned in a single page. (optional)
* @param string $offset The number of results that will be skipped in the result set. This is used with the <b>limit</b> field to control the pagination of the output.<br /><br />For example, if the <b>offset</b> is set to <code>0</code> and the <b>limit</b> is set to <code>10</code>, the method will retrieve items 1 through 10 from the list of items returned. If the <b>offset</b> is set to <code>10</code> and the <b>limit</b> is set to <code>10</code>, the method will retrieve items 11 through 20 from the list of items returned.<br><br><b>Default</b>: <code>0</code> (optional)
*
* @throws \InvalidArgumentException
*
* @return \GuzzleHttp\Psr7\Request
*/
public function getAdGroupsRequest($campaign_id, $ad_group_status = null, $limit = null, $offset = null)
{
// Verify the required parameter 'campaign_id' is set.
if ($campaign_id === null || (\is_array($campaign_id) && count($campaign_id) === 0)) {
throw new \InvalidArgumentException('Missing the required parameter $campaign_id when calling getAdGroups');
}
$resourcePath = '/ad_campaign/{campaign_id}/ad_group';
$formParams = [];
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
$queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue(
$ad_group_status,
'ad_group_status', // param base name
'string', // openApiType
'form', // style
true // explode
) ?? []);
// query params
$queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue(
$limit,
'limit', // param base name
'string', // openApiType
'form', // style
true // explode
) ?? []);
// query params
$queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue(
$offset,
'offset', // param base name
'string', // openApiType
'form', // style
true // explode
) ?? []);
// path params
if ($campaign_id !== null) {
$resourcePath = str_replace(
'{campaign_id}',
ObjectSerializer::toPathValue($campaign_id),
$resourcePath
);
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
[]
);
}
// For model (json/xml)
if (count($formParams) > 0) {
if ($multipart) {
$multipartContents = [];
foreach ($formParams as $formParamName => $formParamValue) {
$formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue];
foreach ($formParamValueItems as $formParamValueItem) {
$multipartContents[] = [
'name' => $formParamName,
'contents' => $formParamValueItem,
];
}
}
// For HTTP post (form)
$httpBody = new MultipartStream($multipartContents);
} elseif ($headers['Content-Type'] === 'application/json') {
$httpBody = \GuzzleHttp\json_encode($formParams);
} else {
// For HTTP post (form)
$httpBody = ObjectSerializer::buildQuery($queryParams);
}
}
// this endpoint requires OAuth (access token)
if (! empty($this->config->getAccessToken())) {
$headers['Authorization'] = 'Bearer '.$this->config->getAccessToken();
}
// this endpoint requires OAuth (access token)
if (! empty($this->config->getAccessToken())) {
$headers['Authorization'] = 'Bearer '.$this->config->getAccessToken();
}
$defaultHeaders = [];
if ($this->config->getUserAgent()) {
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
}
$headers = array_merge(
$defaultHeaders,
$headerParams,
$headers
);
$query = ObjectSerializer::buildQuery($queryParams);
return new Request(
'GET',
$this->config->getHost().$resourcePath.($query ? "?{$query}" : ''),
$headers,
$httpBody
);
}
/**
* Operation suggestBids.
*
* @param string $ad_group_id The ID of the ad group containing the keywords for which the bid suggestions will be provided. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\TargetedBidRequest $targeted_bid_request The data requested to retrieve the suggested bids. (required)
*
* @throws \TNT\Ebay\Sell\Marketing\V1\ApiException on non-2xx response
* @throws \InvalidArgumentException
*
* @return \TNT\Ebay\Sell\Marketing\V1\Model\TargetedBidsPagedCollection
*/
public function suggestBids($ad_group_id, $campaign_id, $targeted_bid_request)
{
[$response] = $this->suggestBidsWithHttpInfo($ad_group_id, $campaign_id, $targeted_bid_request);
return $response;
}
/**
* Operation suggestBidsWithHttpInfo.
*
* @param string $ad_group_id The ID of the ad group containing the keywords for which the bid suggestions will be provided. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\TargetedBidRequest $targeted_bid_request The data requested to retrieve the suggested bids. (required)
*
* @throws \TNT\Ebay\Sell\Marketing\V1\ApiException on non-2xx response
* @throws \InvalidArgumentException
*
* @return array of \TNT\Ebay\Sell\Marketing\V1\Model\TargetedBidsPagedCollection, HTTP status code, HTTP response headers (array of strings)
*/
public function suggestBidsWithHttpInfo($ad_group_id, $campaign_id, $targeted_bid_request)
{
$request = $this->suggestBidsRequest($ad_group_id, $campaign_id, $targeted_bid_request);
try {
$options = $this->createHttpClientOption();
try {
$response = $this->client->send($request, $options);
} catch (RequestException $e) {
throw new ApiException("[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? (string) $e->getResponse()->getBody() : null, $e);
} catch (ConnectException $e) {
throw new ApiException("[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null, $e);
} catch (GuzzleException $e) {
throw new ApiException("[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null, $e);
}
$statusCode = $response->getStatusCode();
if ($statusCode < 200 || $statusCode > 299) {
throw new ApiException(sprintf('[%d] Error connecting to the API (%s)', $statusCode, (string) $request->getUri()), $statusCode, $response->getHeaders(), (string) $response->getBody());
}
switch ($statusCode) {
case 200:
if ('\TNT\Ebay\Sell\Marketing\V1\Model\TargetedBidsPagedCollection' === '\SplFileObject') {
$content = $response->getBody(); // Stream goes to serializer.
} else {
$content = (string) $response->getBody();
}
return [
ObjectSerializer::deserialize($content, '\TNT\Ebay\Sell\Marketing\V1\Model\TargetedBidsPagedCollection', []),
$response->getStatusCode(),
$response->getHeaders(),
];
}
$returnType = '\TNT\Ebay\Sell\Marketing\V1\Model\TargetedBidsPagedCollection';
if ($returnType === '\SplFileObject') {
$content = $response->getBody(); // Stream goes to serializer.
} else {
$content = (string) $response->getBody();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders(),
];
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = ObjectSerializer::deserialize(
$e->getResponseBody(),
'\TNT\Ebay\Sell\Marketing\V1\Model\TargetedBidsPagedCollection',
$e->getResponseHeaders()
);
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* Operation suggestBidsAsync.
*
* @param string $ad_group_id The ID of the ad group containing the keywords for which the bid suggestions will be provided. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\TargetedBidRequest $targeted_bid_request The data requested to retrieve the suggested bids. (required)
*
* @throws \InvalidArgumentException
*
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function suggestBidsAsync($ad_group_id, $campaign_id, $targeted_bid_request)
{
return $this->suggestBidsAsyncWithHttpInfo($ad_group_id, $campaign_id, $targeted_bid_request)
->then(
function ($response) {
return $response[0];
}
);
}
/**
* Operation suggestBidsAsyncWithHttpInfo.
*
* @param string $ad_group_id The ID of the ad group containing the keywords for which the bid suggestions will be provided. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\TargetedBidRequest $targeted_bid_request The data requested to retrieve the suggested bids. (required)
*
* @throws \InvalidArgumentException
*
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function suggestBidsAsyncWithHttpInfo($ad_group_id, $campaign_id, $targeted_bid_request)
{
$returnType = '\TNT\Ebay\Sell\Marketing\V1\Model\TargetedBidsPagedCollection';
$request = $this->suggestBidsRequest($ad_group_id, $campaign_id, $targeted_bid_request);
return $this->client
->sendAsync($request, $this->createHttpClientOption())
->then(
function ($response) use ($returnType) {
if ($returnType === '\SplFileObject') {
$content = $response->getBody(); // Stream goes to serializer.
} else {
$content = (string) $response->getBody();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders(),
];
},
function ($exception) {
$response = $exception->getResponse();
$statusCode = $response->getStatusCode();
throw new ApiException(sprintf('[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri()), $statusCode, $response->getHeaders(), (string) $response->getBody(), $exception instanceof \Throwable ? $exception : null);
}
);
}
/**
* Create request for operation 'suggestBids'.
*
* @param string $ad_group_id The ID of the ad group containing the keywords for which the bid suggestions will be provided. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\TargetedBidRequest $targeted_bid_request The data requested to retrieve the suggested bids. (required)
*
* @throws \InvalidArgumentException
*
* @return \GuzzleHttp\Psr7\Request
*/
public function suggestBidsRequest($ad_group_id, $campaign_id, $targeted_bid_request)
{
// Verify the required parameter 'ad_group_id' is set.
if ($ad_group_id === null || (\is_array($ad_group_id) && count($ad_group_id) === 0)) {
throw new \InvalidArgumentException('Missing the required parameter $ad_group_id when calling suggestBids');
}
// Verify the required parameter 'campaign_id' is set.
if ($campaign_id === null || (\is_array($campaign_id) && count($campaign_id) === 0)) {
throw new \InvalidArgumentException('Missing the required parameter $campaign_id when calling suggestBids');
}
// Verify the required parameter 'targeted_bid_request' is set.
if ($targeted_bid_request === null || (\is_array($targeted_bid_request) && count($targeted_bid_request) === 0)) {
throw new \InvalidArgumentException('Missing the required parameter $targeted_bid_request when calling suggestBids');
}
$resourcePath = '/ad_campaign/{campaign_id}/ad_group/{ad_group_id}/suggest_bids';
$formParams = [];
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// path params
if ($ad_group_id !== null) {
$resourcePath = str_replace(
'{ad_group_id}',
ObjectSerializer::toPathValue($ad_group_id),
$resourcePath
);
}
// path params
if ($campaign_id !== null) {
$resourcePath = str_replace(
'{campaign_id}',
ObjectSerializer::toPathValue($campaign_id),
$resourcePath
);
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// For model (json/xml)
if (isset($targeted_bid_request)) {
if ($headers['Content-Type'] === 'application/json') {
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($targeted_bid_request));
} else {
$httpBody = $targeted_bid_request;
}
} elseif (count($formParams) > 0) {
if ($multipart) {
$multipartContents = [];
foreach ($formParams as $formParamName => $formParamValue) {
$formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue];
foreach ($formParamValueItems as $formParamValueItem) {
$multipartContents[] = [
'name' => $formParamName,
'contents' => $formParamValueItem,
];
}
}
// For HTTP post (form)
$httpBody = new MultipartStream($multipartContents);
} elseif ($headers['Content-Type'] === 'application/json') {
$httpBody = \GuzzleHttp\json_encode($formParams);
} else {
// For HTTP post (form)
$httpBody = ObjectSerializer::buildQuery($queryParams);
}
}
// this endpoint requires OAuth (access token)
if (! empty($this->config->getAccessToken())) {
$headers['Authorization'] = 'Bearer '.$this->config->getAccessToken();
}
// this endpoint requires OAuth (access token)
if (! empty($this->config->getAccessToken())) {
$headers['Authorization'] = 'Bearer '.$this->config->getAccessToken();
}
$defaultHeaders = [];
if ($this->config->getUserAgent()) {
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
}
$headers = array_merge(
$defaultHeaders,
$headerParams,
$headers
);
$query = ObjectSerializer::buildQuery($queryParams);
return new Request(
'POST',
$this->config->getHost().$resourcePath.($query ? "?{$query}" : ''),
$headers,
$httpBody
);
}
/**
* Operation suggestKeywords.
*
* @param string $ad_group_id The ID of the ad group for which the keyword suggestions will be provided. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\TargetedKeywordRequest $targeted_keyword_request The required data to retrieve suggested keywords. (optional)
*
* @throws \TNT\Ebay\Sell\Marketing\V1\ApiException on non-2xx response
* @throws \InvalidArgumentException
*
* @return \TNT\Ebay\Sell\Marketing\V1\Model\TargetedKeywordsPagedCollection
*/
public function suggestKeywords($ad_group_id, $campaign_id, $targeted_keyword_request = null)
{
[$response] = $this->suggestKeywordsWithHttpInfo($ad_group_id, $campaign_id, $targeted_keyword_request);
return $response;
}
/**
* Operation suggestKeywordsWithHttpInfo.
*
* @param string $ad_group_id The ID of the ad group for which the keyword suggestions will be provided. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\TargetedKeywordRequest $targeted_keyword_request The required data to retrieve suggested keywords. (optional)
*
* @throws \TNT\Ebay\Sell\Marketing\V1\ApiException on non-2xx response
* @throws \InvalidArgumentException
*
* @return array of \TNT\Ebay\Sell\Marketing\V1\Model\TargetedKeywordsPagedCollection, HTTP status code, HTTP response headers (array of strings)
*/
public function suggestKeywordsWithHttpInfo($ad_group_id, $campaign_id, $targeted_keyword_request = null)
{
$request = $this->suggestKeywordsRequest($ad_group_id, $campaign_id, $targeted_keyword_request);
try {
$options = $this->createHttpClientOption();
try {
$response = $this->client->send($request, $options);
} catch (RequestException $e) {
throw new ApiException("[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? (string) $e->getResponse()->getBody() : null, $e);
} catch (ConnectException $e) {
throw new ApiException("[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null, $e);
} catch (GuzzleException $e) {
throw new ApiException("[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null, $e);
}
$statusCode = $response->getStatusCode();
if ($statusCode < 200 || $statusCode > 299) {
throw new ApiException(sprintf('[%d] Error connecting to the API (%s)', $statusCode, (string) $request->getUri()), $statusCode, $response->getHeaders(), (string) $response->getBody());
}
switch ($statusCode) {
case 200:
if ('\TNT\Ebay\Sell\Marketing\V1\Model\TargetedKeywordsPagedCollection' === '\SplFileObject') {
$content = $response->getBody(); // Stream goes to serializer.
} else {
$content = (string) $response->getBody();
}
return [
ObjectSerializer::deserialize($content, '\TNT\Ebay\Sell\Marketing\V1\Model\TargetedKeywordsPagedCollection', []),
$response->getStatusCode(),
$response->getHeaders(),
];
}
$returnType = '\TNT\Ebay\Sell\Marketing\V1\Model\TargetedKeywordsPagedCollection';
if ($returnType === '\SplFileObject') {
$content = $response->getBody(); // Stream goes to serializer.
} else {
$content = (string) $response->getBody();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders(),
];
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = ObjectSerializer::deserialize(
$e->getResponseBody(),
'\TNT\Ebay\Sell\Marketing\V1\Model\TargetedKeywordsPagedCollection',
$e->getResponseHeaders()
);
$e->setResponseObject($data);
break;
}
throw $e;
}
}
/**
* Operation suggestKeywordsAsync.
*
* @param string $ad_group_id The ID of the ad group for which the keyword suggestions will be provided. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\TargetedKeywordRequest $targeted_keyword_request The required data to retrieve suggested keywords. (optional)
*
* @throws \InvalidArgumentException
*
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function suggestKeywordsAsync($ad_group_id, $campaign_id, $targeted_keyword_request = null)
{
return $this->suggestKeywordsAsyncWithHttpInfo($ad_group_id, $campaign_id, $targeted_keyword_request)
->then(
function ($response) {
return $response[0];
}
);
}
/**
* Operation suggestKeywordsAsyncWithHttpInfo.
*
* @param string $ad_group_id The ID of the ad group for which the keyword suggestions will be provided. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\TargetedKeywordRequest $targeted_keyword_request The required data to retrieve suggested keywords. (optional)
*
* @throws \InvalidArgumentException
*
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function suggestKeywordsAsyncWithHttpInfo($ad_group_id, $campaign_id, $targeted_keyword_request = null)
{
$returnType = '\TNT\Ebay\Sell\Marketing\V1\Model\TargetedKeywordsPagedCollection';
$request = $this->suggestKeywordsRequest($ad_group_id, $campaign_id, $targeted_keyword_request);
return $this->client
->sendAsync($request, $this->createHttpClientOption())
->then(
function ($response) use ($returnType) {
if ($returnType === '\SplFileObject') {
$content = $response->getBody(); // Stream goes to serializer.
} else {
$content = (string) $response->getBody();
}
return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders(),
];
},
function ($exception) {
$response = $exception->getResponse();
$statusCode = $response->getStatusCode();
throw new ApiException(sprintf('[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri()), $statusCode, $response->getHeaders(), (string) $response->getBody(), $exception instanceof \Throwable ? $exception : null);
}
);
}
/**
* Create request for operation 'suggestKeywords'.
*
* @param string $ad_group_id The ID of the ad group for which the keyword suggestions will be provided. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\TargetedKeywordRequest $targeted_keyword_request The required data to retrieve suggested keywords. (optional)
*
* @throws \InvalidArgumentException
*
* @return \GuzzleHttp\Psr7\Request
*/
public function suggestKeywordsRequest($ad_group_id, $campaign_id, $targeted_keyword_request = null)
{
// Verify the required parameter 'ad_group_id' is set.
if ($ad_group_id === null || (\is_array($ad_group_id) && count($ad_group_id) === 0)) {
throw new \InvalidArgumentException('Missing the required parameter $ad_group_id when calling suggestKeywords');
}
// Verify the required parameter 'campaign_id' is set.
if ($campaign_id === null || (\is_array($campaign_id) && count($campaign_id) === 0)) {
throw new \InvalidArgumentException('Missing the required parameter $campaign_id when calling suggestKeywords');
}
$resourcePath = '/ad_campaign/{campaign_id}/ad_group/{ad_group_id}/suggest_keywords';
$formParams = [];
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// path params
if ($ad_group_id !== null) {
$resourcePath = str_replace(
'{ad_group_id}',
ObjectSerializer::toPathValue($ad_group_id),
$resourcePath
);
}
// path params
if ($campaign_id !== null) {
$resourcePath = str_replace(
'{campaign_id}',
ObjectSerializer::toPathValue($campaign_id),
$resourcePath
);
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json'],
['application/json']
);
}
// For model (json/xml)
if (isset($targeted_keyword_request)) {
if ($headers['Content-Type'] === 'application/json') {
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($targeted_keyword_request));
} else {
$httpBody = $targeted_keyword_request;
}
} elseif (count($formParams) > 0) {
if ($multipart) {
$multipartContents = [];
foreach ($formParams as $formParamName => $formParamValue) {
$formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue];
foreach ($formParamValueItems as $formParamValueItem) {
$multipartContents[] = [
'name' => $formParamName,
'contents' => $formParamValueItem,
];
}
}
// For HTTP post (form)
$httpBody = new MultipartStream($multipartContents);
} elseif ($headers['Content-Type'] === 'application/json') {
$httpBody = \GuzzleHttp\json_encode($formParams);
} else {
// For HTTP post (form)
$httpBody = ObjectSerializer::buildQuery($queryParams);
}
}
// this endpoint requires OAuth (access token)
if (! empty($this->config->getAccessToken())) {
$headers['Authorization'] = 'Bearer '.$this->config->getAccessToken();
}
// this endpoint requires OAuth (access token)
if (! empty($this->config->getAccessToken())) {
$headers['Authorization'] = 'Bearer '.$this->config->getAccessToken();
}
$defaultHeaders = [];
if ($this->config->getUserAgent()) {
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
}
$headers = array_merge(
$defaultHeaders,
$headerParams,
$headers
);
$query = ObjectSerializer::buildQuery($queryParams);
return new Request(
'POST',
$this->config->getHost().$resourcePath.($query ? "?{$query}" : ''),
$headers,
$httpBody
);
}
/**
* Operation updateAdGroup.
*
* @param string $ad_group_id The ID of the ad group that shall be updated. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\UpdateAdGroupRequest $update_ad_group_request This type defines the fields for the <b>UpdateAdGroup</b> request. (required)
*
* @throws \TNT\Ebay\Sell\Marketing\V1\ApiException on non-2xx response
* @throws \InvalidArgumentException
*
* @return void
*/
public function updateAdGroup($ad_group_id, $campaign_id, $update_ad_group_request)
{
$this->updateAdGroupWithHttpInfo($ad_group_id, $campaign_id, $update_ad_group_request);
}
/**
* Operation updateAdGroupWithHttpInfo.
*
* @param string $ad_group_id The ID of the ad group that shall be updated. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\UpdateAdGroupRequest $update_ad_group_request This type defines the fields for the <b>UpdateAdGroup</b> request. (required)
*
* @throws \TNT\Ebay\Sell\Marketing\V1\ApiException on non-2xx response
* @throws \InvalidArgumentException
*
* @return array of null, HTTP status code, HTTP response headers (array of strings)
*/
public function updateAdGroupWithHttpInfo($ad_group_id, $campaign_id, $update_ad_group_request)
{
$request = $this->updateAdGroupRequest($ad_group_id, $campaign_id, $update_ad_group_request);
try {
$options = $this->createHttpClientOption();
try {
$response = $this->client->send($request, $options);
} catch (RequestException $e) {
throw new ApiException("[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), $e->getResponse() ? $e->getResponse()->getHeaders() : null, $e->getResponse() ? (string) $e->getResponse()->getBody() : null, $e);
} catch (ConnectException $e) {
throw new ApiException("[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null, $e);
} catch (GuzzleException $e) {
throw new ApiException("[{$e->getCode()}] {$e->getMessage()}", (int) $e->getCode(), null, null, $e);
}
$statusCode = $response->getStatusCode();
if ($statusCode < 200 || $statusCode > 299) {
throw new ApiException(sprintf('[%d] Error connecting to the API (%s)', $statusCode, (string) $request->getUri()), $statusCode, $response->getHeaders(), (string) $response->getBody());
}
return [null, $statusCode, $response->getHeaders()];
} catch (ApiException $e) {
switch ($e->getCode()) {
}
throw $e;
}
}
/**
* Operation updateAdGroupAsync.
*
* @param string $ad_group_id The ID of the ad group that shall be updated. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\UpdateAdGroupRequest $update_ad_group_request This type defines the fields for the <b>UpdateAdGroup</b> request. (required)
*
* @throws \InvalidArgumentException
*
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function updateAdGroupAsync($ad_group_id, $campaign_id, $update_ad_group_request)
{
return $this->updateAdGroupAsyncWithHttpInfo($ad_group_id, $campaign_id, $update_ad_group_request)
->then(
function ($response) {
return $response[0];
}
);
}
/**
* Operation updateAdGroupAsyncWithHttpInfo.
*
* @param string $ad_group_id The ID of the ad group that shall be updated. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\UpdateAdGroupRequest $update_ad_group_request This type defines the fields for the <b>UpdateAdGroup</b> request. (required)
*
* @throws \InvalidArgumentException
*
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function updateAdGroupAsyncWithHttpInfo($ad_group_id, $campaign_id, $update_ad_group_request)
{
$returnType = '';
$request = $this->updateAdGroupRequest($ad_group_id, $campaign_id, $update_ad_group_request);
return $this->client
->sendAsync($request, $this->createHttpClientOption())
->then(
function ($response) {
return [null, $response->getStatusCode(), $response->getHeaders()];
},
function ($exception) {
$response = $exception->getResponse();
$statusCode = $response->getStatusCode();
throw new ApiException(sprintf('[%d] Error connecting to the API (%s)', $statusCode, $exception->getRequest()->getUri()), $statusCode, $response->getHeaders(), (string) $response->getBody(), $exception instanceof \Throwable ? $exception : null);
}
);
}
/**
* Create request for operation 'updateAdGroup'.
*
* @param string $ad_group_id The ID of the ad group that shall be updated. (required)
* @param string $campaign_id A unique eBay-assigned ID for an ad campaign that is generated when a campaign is created.<br /><br /><span class=\"tablenote\"><b>Note:</b> You can retrieve the campaign IDs for a specified seller using the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\">getCampaigns</a> method.</span> (required)
* @param \TNT\Ebay\Sell\Marketing\V1\Model\UpdateAdGroupRequest $update_ad_group_request This type defines the fields for the <b>UpdateAdGroup</b> request. (required)
*
* @throws \InvalidArgumentException
*
* @return \GuzzleHttp\Psr7\Request
*/
public function updateAdGroupRequest($ad_group_id, $campaign_id, $update_ad_group_request)
{
// Verify the required parameter 'ad_group_id' is set.
if ($ad_group_id === null || (\is_array($ad_group_id) && count($ad_group_id) === 0)) {
throw new \InvalidArgumentException('Missing the required parameter $ad_group_id when calling updateAdGroup');
}
// Verify the required parameter 'campaign_id' is set.
if ($campaign_id === null || (\is_array($campaign_id) && count($campaign_id) === 0)) {
throw new \InvalidArgumentException('Missing the required parameter $campaign_id when calling updateAdGroup');
}
// Verify the required parameter 'update_ad_group_request' is set.
if ($update_ad_group_request === null || (\is_array($update_ad_group_request) && count($update_ad_group_request) === 0)) {
throw new \InvalidArgumentException('Missing the required parameter $update_ad_group_request when calling updateAdGroup');
}
$resourcePath = '/ad_campaign/{campaign_id}/ad_group/{ad_group_id}';
$formParams = [];
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// path params
if ($ad_group_id !== null) {
$resourcePath = str_replace(
'{ad_group_id}',
ObjectSerializer::toPathValue($ad_group_id),
$resourcePath
);
}
// path params
if ($campaign_id !== null) {
$resourcePath = str_replace(
'{campaign_id}',
ObjectSerializer::toPathValue($campaign_id),
$resourcePath
);
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
[]
);
} else {
$headers = $this->headerSelector->selectHeaders(
[],
['application/json']
);
}
// For model (json/xml)
if (isset($update_ad_group_request)) {
if ($headers['Content-Type'] === 'application/json') {
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($update_ad_group_request));
} else {
$httpBody = $update_ad_group_request;
}
} elseif (count($formParams) > 0) {
if ($multipart) {
$multipartContents = [];
foreach ($formParams as $formParamName => $formParamValue) {
$formParamValueItems = is_array($formParamValue) ? $formParamValue : [$formParamValue];
foreach ($formParamValueItems as $formParamValueItem) {
$multipartContents[] = [
'name' => $formParamName,
'contents' => $formParamValueItem,
];
}
}
// For HTTP post (form)
$httpBody = new MultipartStream($multipartContents);
} elseif ($headers['Content-Type'] === 'application/json') {
$httpBody = \GuzzleHttp\json_encode($formParams);
} else {
// For HTTP post (form)
$httpBody = ObjectSerializer::buildQuery($queryParams);
}
}
// this endpoint requires OAuth (access token)
if (! empty($this->config->getAccessToken())) {
$headers['Authorization'] = 'Bearer '.$this->config->getAccessToken();
}
// this endpoint requires OAuth (access token)
if (! empty($this->config->getAccessToken())) {
$headers['Authorization'] = 'Bearer '.$this->config->getAccessToken();
}
$defaultHeaders = [];
if ($this->config->getUserAgent()) {
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
}
$headers = array_merge(
$defaultHeaders,
$headerParams,
$headers
);
$query = ObjectSerializer::buildQuery($queryParams);
return new Request(
'PUT',
$this->config->getHost().$resourcePath.($query ? "?{$query}" : ''),
$headers,
$httpBody
);
}
/**
* Create http client option.
*
* @throws \RuntimeException on file opening failure
*
* @return array of http client options
*/
protected function createHttpClientOption()
{
$options = [];
if ($this->config->getDebug()) {
$options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'ab');
if (! $options[RequestOptions::DEBUG]) {
throw new \RuntimeException('Failed to open the debug file: '.$this->config->getDebugFile());
}
}
return $options;
}
}