-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy pathPaymentBatchSummariesApi.php
242 lines (222 loc) · 11.3 KB
/
PaymentBatchSummariesApi.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
<?php
/**
* PaymentBatchSummariesApi
* PHP version 5
*
* @category Class
* @package CyberSource
* @author Swagger Codegen team
* @link https://github.com/swagger-api/swagger-codegen
*/
/**
* CyberSource Merged Spec
*
* All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
*
* OpenAPI spec version: 0.0.1
*
* Generated by: https://github.com/swagger-api/swagger-codegen.git
*
*/
/**
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen
* Do not edit the class manually.
*/
namespace CyberSource\Api;
use \CyberSource\ApiClient;
use \CyberSource\ApiException;
use \CyberSource\Configuration;
use \CyberSource\ObjectSerializer;
use \CyberSource\Logging\LogFactory as LogFactory;
/**
* PaymentBatchSummariesApi Class Doc Comment
*
* @category Class
* @package CyberSource
* @author Swagger Codegen team
* @link https://github.com/swagger-api/swagger-codegen
*/
class PaymentBatchSummariesApi
{
private static $logger = null;
/**
* API Client
*
* @var \CyberSource\ApiClient instance of the ApiClient
*/
protected $apiClient;
/**
* Constructor
*
* @param \CyberSource\ApiClient|null $apiClient The api client to use
*/
public function __construct(\CyberSource\ApiClient $apiClient = null)
{
if ($apiClient === null) {
$apiClient = new ApiClient();
}
$this->apiClient = $apiClient;
if (self::$logger === null) {
self::$logger = (new LogFactory())->getLogger(\CyberSource\Utilities\Helpers\ClassHelper::getClassName(static::class), $apiClient->merchantConfig->getLogConfiguration());
}
}
/**
* Get API client
*
* @return \CyberSource\ApiClient get the API client
*/
public function getApiClient()
{
return $this->apiClient;
}
/**
* Set the API client
*
* @param \CyberSource\ApiClient $apiClient set the API client
*
* @return PaymentBatchSummariesApi
*/
public function setApiClient(\CyberSource\ApiClient $apiClient)
{
$this->apiClient = $apiClient;
return $this;
}
/**
* Operation getPaymentBatchSummary
*
* Get Payment Batch Summary Data
*
* @param \DateTime $startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)
* @param \DateTime $endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)
* @param string $organizationId Valid Organization Id (optional)
* @param string $rollUp Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant (optional)
* @param string $breakdown Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant. (optional)
* @param int $startDayOfWeek Optional - Start day of week to breakdown data for weeks in a month (optional)
* @throws \CyberSource\ApiException on non-2xx response
* @return array of \CyberSource\Model\ReportingV3PaymentBatchSummariesGet200Response, HTTP status code, HTTP response headers (array of strings)
*/
public function getPaymentBatchSummary($startTime, $endTime, $organizationId = null, $rollUp = null, $breakdown = null, $startDayOfWeek = null)
{
self::$logger->info('CALL TO METHOD getPaymentBatchSummary STARTED');
list($response, $statusCode, $httpHeader) = $this->getPaymentBatchSummaryWithHttpInfo($startTime, $endTime, $organizationId, $rollUp, $breakdown, $startDayOfWeek);
self::$logger->info('CALL TO METHOD getPaymentBatchSummary ENDED');
self::$logger->close();
return [$response, $statusCode, $httpHeader];
}
/**
* Operation getPaymentBatchSummaryWithHttpInfo
*
* Get Payment Batch Summary Data
*
* @param \DateTime $startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)
* @param \DateTime $endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required)
* @param string $organizationId Valid Organization Id (optional)
* @param string $rollUp Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant (optional)
* @param string $breakdown Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant. (optional)
* @param int $startDayOfWeek Optional - Start day of week to breakdown data for weeks in a month (optional)
* @throws \CyberSource\ApiException on non-2xx response
* @return array of \CyberSource\Model\ReportingV3PaymentBatchSummariesGet200Response, HTTP status code, HTTP response headers (array of strings)
*/
public function getPaymentBatchSummaryWithHttpInfo($startTime, $endTime, $organizationId = null, $rollUp = null, $breakdown = null, $startDayOfWeek = null)
{
// verify the required parameter 'startTime' is set
if ($startTime === null) {
self::$logger->error("InvalidArgumentException : Missing the required parameter $startTime when calling getPaymentBatchSummary");
throw new \InvalidArgumentException('Missing the required parameter $startTime when calling getPaymentBatchSummary');
}
// verify the required parameter 'endTime' is set
if ($endTime === null) {
self::$logger->error("InvalidArgumentException : Missing the required parameter $endTime when calling getPaymentBatchSummary");
throw new \InvalidArgumentException('Missing the required parameter $endTime when calling getPaymentBatchSummary');
}
// parse inputs
$resourcePath = "/reporting/v3/payment-batch-summaries";
$httpBody = '';
$queryParams = [];
$headerParams = [];
$formParams = [];
$_header_accept = $this->apiClient->selectHeaderAccept(['application/hal+json', 'text/csv', 'application/xml']);
if (!is_null($_header_accept)) {
$headerParams['Accept'] = $_header_accept;
}
$headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(['application/json;charset=utf-8']);
// query params
if ($startTime !== null) {
$queryParams['startTime'] = $this->apiClient->getSerializer()->toQueryValue($startTime);
}
// query params
if ($endTime !== null) {
$queryParams['endTime'] = $this->apiClient->getSerializer()->toQueryValue($endTime);
}
// query params
if ($organizationId !== null) {
$queryParams['organizationId'] = $this->apiClient->getSerializer()->toQueryValue($organizationId);
}
// query params
if ($rollUp !== null) {
$queryParams['rollUp'] = $this->apiClient->getSerializer()->toQueryValue($rollUp);
}
// query params
if ($breakdown !== null) {
$queryParams['breakdown'] = $this->apiClient->getSerializer()->toQueryValue($breakdown);
}
// query params
if ($startDayOfWeek !== null) {
$queryParams['startDayOfWeek'] = $this->apiClient->getSerializer()->toQueryValue($startDayOfWeek);
}
if ('GET' == 'POST') {
$_tempBody = '{}';
}
// for model (json/xml)
if (isset($_tempBody)) {
$httpBody = $_tempBody; // $_tempBody is the method argument, if present
} elseif (count($formParams) > 0) {
$httpBody = $formParams; // for HTTP post (form)
}
// Logging
self::$logger->debug("Resource : GET $resourcePath");
self::$logger->debug("Query Parameters :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($queryParams));
self::$logger->debug("Query Parameters :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($queryParams));
self::$logger->debug("Query Parameters :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($queryParams));
self::$logger->debug("Query Parameters :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($queryParams));
self::$logger->debug("Query Parameters :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($queryParams));
self::$logger->debug("Query Parameters :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($queryParams));
if (isset($httpBody)) {
if ($this->apiClient->merchantConfig->getLogConfiguration()->isMaskingEnabled()) {
$printHttpBody = \CyberSource\Utilities\Helpers\DataMasker::maskData($httpBody);
} else {
$printHttpBody = $httpBody;
}
self::$logger->debug("Body Parameter :\n" . $printHttpBody);
}
self::$logger->debug("Return Type : \CyberSource\Model\ReportingV3PaymentBatchSummariesGet200Response");
// make the API Call
try {
list($response, $statusCode, $httpHeader) = $this->apiClient->callApi(
$resourcePath,
'GET',
$queryParams,
$httpBody,
$headerParams,
'\CyberSource\Model\ReportingV3PaymentBatchSummariesGet200Response',
'/reporting/v3/payment-batch-summaries'
);
self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader));
return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\ReportingV3PaymentBatchSummariesGet200Response', $httpHeader), $statusCode, $httpHeader];
} catch (ApiException $e) {
switch ($e->getCode()) {
case 200:
$data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\ReportingV3PaymentBatchSummariesGet200Response', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
case 400:
$data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\Reportingv3ReportDownloadsGet400Response', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
self::$logger->error("ApiException : $e");
throw $e;
}
}
}