-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy pathBillingAgreementsApi.php
502 lines (450 loc) · 22 KB
/
BillingAgreementsApi.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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
<?php
/**
* BillingAgreementsApi
* 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;
use \CyberSource\Authentication\Util\MLEUtility;
use \Exception;
/**
* BillingAgreementsApi Class Doc Comment
*
* @category Class
* @package CyberSource
* @author Swagger Codegen team
* @link https://github.com/swagger-api/swagger-codegen
*/
class BillingAgreementsApi
{
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(get_class($this)), $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 BillingAgreementsApi
*/
public function setApiClient(\CyberSource\ApiClient $apiClient)
{
$this->apiClient = $apiClient;
return $this;
}
/**
* Operation billingAgreementsDeRegistration
*
* Modify a Billing Agreement
*
* @param \CyberSource\Model\ModifyBillingAgreement $modifyBillingAgreement (required)
* @param string $id ID for de-registration or cancellation of Billing Agreement (required)
* @throws \CyberSource\ApiException on non-2xx response
* @return array of \CyberSource\Model\PtsV2ModifyBillingAgreementPost201Response, HTTP status code, HTTP response headers (array of strings)
*/
public function billingAgreementsDeRegistration($modifyBillingAgreement, $id)
{
self::$logger->info('CALL TO METHOD billingAgreementsDeRegistration STARTED');
list($response, $statusCode, $httpHeader) = $this->billingAgreementsDeRegistrationWithHttpInfo($modifyBillingAgreement, $id);
self::$logger->info('CALL TO METHOD billingAgreementsDeRegistration ENDED');
self::$logger->close();
return [$response, $statusCode, $httpHeader];
}
/**
* Operation billingAgreementsDeRegistrationWithHttpInfo
*
* Modify a Billing Agreement
*
* @param \CyberSource\Model\ModifyBillingAgreement $modifyBillingAgreement (required)
* @param string $id ID for de-registration or cancellation of Billing Agreement (required)
* @throws \CyberSource\ApiException on non-2xx response
* @return array of \CyberSource\Model\PtsV2ModifyBillingAgreementPost201Response, HTTP status code, HTTP response headers (array of strings)
*/
public function billingAgreementsDeRegistrationWithHttpInfo($modifyBillingAgreement, $id)
{
// verify the required parameter 'modifyBillingAgreement' is set
if ($modifyBillingAgreement === null) {
self::$logger->error("InvalidArgumentException : Missing the required parameter $modifyBillingAgreement when calling billingAgreementsDeRegistration");
throw new \InvalidArgumentException('Missing the required parameter $modifyBillingAgreement when calling billingAgreementsDeRegistration');
}
// verify the required parameter 'id' is set
if ($id === null) {
self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling billingAgreementsDeRegistration");
throw new \InvalidArgumentException('Missing the required parameter $id when calling billingAgreementsDeRegistration');
}
// parse inputs
$resourcePath = "/pts/v2/billing-agreements/{id}";
$httpBody = '';
$queryParams = [];
$headerParams = [];
$formParams = [];
$_header_accept = $this->apiClient->selectHeaderAccept(['application/hal+json;charset=utf-8']);
if (!is_null($_header_accept)) {
$headerParams['Accept'] = $_header_accept;
}
$headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(['application/json;charset=utf-8']);
// path params
if ($id !== null) {
$resourcePath = str_replace(
"{" . "id" . "}",
$this->apiClient->getSerializer()->toPathValue($id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($modifyBillingAgreement)) {
$_tempBody = $modifyBillingAgreement;
}
$sdkTracker = new \CyberSource\Utilities\Tracking\SdkTracker();
$modelClassLocation = explode('\\', '\CyberSource\Model\ModifyBillingAgreement');
$_tempBody = $sdkTracker->insertDeveloperIdTracker($_tempBody, end($modelClassLocation), $this->apiClient->merchantConfig->getRunEnvironment(), $this->apiClient->merchantConfig->getDefaultDeveloperId());
// 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)
}
//MLE check and mle encryption for req body
$isMLESupportedByCybsForApi = true;
if (MLEUtility::checkIsMLEForAPI($this->apiClient->merchantConfig, $isMLESupportedByCybsForApi, "billingAgreementsDeRegistration,billingAgreementsDeRegistrationWithHttpInfo")) {
try {
$httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody);
} catch (Exception $e) {
self::$logger->error("Failed to encrypt request body: $e");
throw new ApiException("Failed to encrypt request body : " . $e->getMessage());
}
}
// Logging
self::$logger->debug("Resource : PATCH $resourcePath");
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\PtsV2ModifyBillingAgreementPost201Response");
// make the API Call
try {
list($response, $statusCode, $httpHeader) = $this->apiClient->callApi(
$resourcePath,
'PATCH',
$queryParams,
$httpBody,
$headerParams,
'\CyberSource\Model\PtsV2ModifyBillingAgreementPost201Response',
'/pts/v2/billing-agreements/{id}'
);
self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader));
return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\PtsV2ModifyBillingAgreementPost201Response', $httpHeader), $statusCode, $httpHeader];
} catch (ApiException $e) {
switch ($e->getCode()) {
case 201:
$data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\PtsV2ModifyBillingAgreementPost201Response', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
case 400:
$data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\PtsV2CreateBillingAgreementPost400Response', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
case 502:
$data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\PtsV2CreateBillingAgreementPost502Response', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
self::$logger->error("ApiException : $e");
throw $e;
}
}
/**
* Operation billingAgreementsIntimation
*
* Standing Instruction intimation
*
* @param \CyberSource\Model\IntimateBillingAgreement $intimateBillingAgreement (required)
* @param string $id ID for intimation of Billing Agreement (required)
* @throws \CyberSource\ApiException on non-2xx response
* @return array of \CyberSource\Model\PtsV2CreditsPost201Response1, HTTP status code, HTTP response headers (array of strings)
*/
public function billingAgreementsIntimation($intimateBillingAgreement, $id)
{
self::$logger->info('CALL TO METHOD billingAgreementsIntimation STARTED');
list($response, $statusCode, $httpHeader) = $this->billingAgreementsIntimationWithHttpInfo($intimateBillingAgreement, $id);
self::$logger->info('CALL TO METHOD billingAgreementsIntimation ENDED');
self::$logger->close();
return [$response, $statusCode, $httpHeader];
}
/**
* Operation billingAgreementsIntimationWithHttpInfo
*
* Standing Instruction intimation
*
* @param \CyberSource\Model\IntimateBillingAgreement $intimateBillingAgreement (required)
* @param string $id ID for intimation of Billing Agreement (required)
* @throws \CyberSource\ApiException on non-2xx response
* @return array of \CyberSource\Model\PtsV2CreditsPost201Response1, HTTP status code, HTTP response headers (array of strings)
*/
public function billingAgreementsIntimationWithHttpInfo($intimateBillingAgreement, $id)
{
// verify the required parameter 'intimateBillingAgreement' is set
if ($intimateBillingAgreement === null) {
self::$logger->error("InvalidArgumentException : Missing the required parameter $intimateBillingAgreement when calling billingAgreementsIntimation");
throw new \InvalidArgumentException('Missing the required parameter $intimateBillingAgreement when calling billingAgreementsIntimation');
}
// verify the required parameter 'id' is set
if ($id === null) {
self::$logger->error("InvalidArgumentException : Missing the required parameter $id when calling billingAgreementsIntimation");
throw new \InvalidArgumentException('Missing the required parameter $id when calling billingAgreementsIntimation');
}
// parse inputs
$resourcePath = "/pts/v2/billing-agreements/{id}/intimations";
$httpBody = '';
$queryParams = [];
$headerParams = [];
$formParams = [];
$_header_accept = $this->apiClient->selectHeaderAccept(['application/hal+json;charset=utf-8']);
if (!is_null($_header_accept)) {
$headerParams['Accept'] = $_header_accept;
}
$headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(['application/json;charset=utf-8']);
// path params
if ($id !== null) {
$resourcePath = str_replace(
"{" . "id" . "}",
$this->apiClient->getSerializer()->toPathValue($id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($intimateBillingAgreement)) {
$_tempBody = $intimateBillingAgreement;
}
$sdkTracker = new \CyberSource\Utilities\Tracking\SdkTracker();
$modelClassLocation = explode('\\', '\CyberSource\Model\IntimateBillingAgreement');
$_tempBody = $sdkTracker->insertDeveloperIdTracker($_tempBody, end($modelClassLocation), $this->apiClient->merchantConfig->getRunEnvironment(), $this->apiClient->merchantConfig->getDefaultDeveloperId());
// 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)
}
//MLE check and mle encryption for req body
$isMLESupportedByCybsForApi = true;
if (MLEUtility::checkIsMLEForAPI($this->apiClient->merchantConfig, $isMLESupportedByCybsForApi, "billingAgreementsIntimation,billingAgreementsIntimationWithHttpInfo")) {
try {
$httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody);
} catch (Exception $e) {
self::$logger->error("Failed to encrypt request body: $e");
throw new ApiException("Failed to encrypt request body : " . $e->getMessage());
}
}
// Logging
self::$logger->debug("Resource : POST $resourcePath");
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\PtsV2CreditsPost201Response1");
// make the API Call
try {
list($response, $statusCode, $httpHeader) = $this->apiClient->callApi(
$resourcePath,
'POST',
$queryParams,
$httpBody,
$headerParams,
'\CyberSource\Model\PtsV2CreditsPost201Response1',
'/pts/v2/billing-agreements/{id}/intimations'
);
self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader));
return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\PtsV2CreditsPost201Response1', $httpHeader), $statusCode, $httpHeader];
} catch (ApiException $e) {
switch ($e->getCode()) {
case 201:
$data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\PtsV2CreditsPost201Response1', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
case 400:
$data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\PtsV2CreateBillingAgreementPost400Response', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
case 502:
$data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\PtsV2CreateBillingAgreementPost502Response', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
self::$logger->error("ApiException : $e");
throw $e;
}
}
/**
* Operation billingAgreementsRegistration
*
* Create a Billing Agreement
*
* @param \CyberSource\Model\CreateBillingAgreement $createBillingAgreement (required)
* @throws \CyberSource\ApiException on non-2xx response
* @return array of \CyberSource\Model\PtsV2CreateBillingAgreementPost201Response, HTTP status code, HTTP response headers (array of strings)
*/
public function billingAgreementsRegistration($createBillingAgreement)
{
self::$logger->info('CALL TO METHOD billingAgreementsRegistration STARTED');
list($response, $statusCode, $httpHeader) = $this->billingAgreementsRegistrationWithHttpInfo($createBillingAgreement);
self::$logger->info('CALL TO METHOD billingAgreementsRegistration ENDED');
self::$logger->close();
return [$response, $statusCode, $httpHeader];
}
/**
* Operation billingAgreementsRegistrationWithHttpInfo
*
* Create a Billing Agreement
*
* @param \CyberSource\Model\CreateBillingAgreement $createBillingAgreement (required)
* @throws \CyberSource\ApiException on non-2xx response
* @return array of \CyberSource\Model\PtsV2CreateBillingAgreementPost201Response, HTTP status code, HTTP response headers (array of strings)
*/
public function billingAgreementsRegistrationWithHttpInfo($createBillingAgreement)
{
// verify the required parameter 'createBillingAgreement' is set
if ($createBillingAgreement === null) {
self::$logger->error("InvalidArgumentException : Missing the required parameter $createBillingAgreement when calling billingAgreementsRegistration");
throw new \InvalidArgumentException('Missing the required parameter $createBillingAgreement when calling billingAgreementsRegistration');
}
// parse inputs
$resourcePath = "/pts/v2/billing-agreements";
$httpBody = '';
$queryParams = [];
$headerParams = [];
$formParams = [];
$_header_accept = $this->apiClient->selectHeaderAccept(['application/hal+json;charset=utf-8']);
if (!is_null($_header_accept)) {
$headerParams['Accept'] = $_header_accept;
}
$headerParams['Content-Type'] = $this->apiClient->selectHeaderContentType(['application/json;charset=utf-8']);
// body params
$_tempBody = null;
if (isset($createBillingAgreement)) {
$_tempBody = $createBillingAgreement;
}
$sdkTracker = new \CyberSource\Utilities\Tracking\SdkTracker();
$modelClassLocation = explode('\\', '\CyberSource\Model\CreateBillingAgreement');
$_tempBody = $sdkTracker->insertDeveloperIdTracker($_tempBody, end($modelClassLocation), $this->apiClient->merchantConfig->getRunEnvironment(), $this->apiClient->merchantConfig->getDefaultDeveloperId());
// 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)
}
//MLE check and mle encryption for req body
$isMLESupportedByCybsForApi = true;
if (MLEUtility::checkIsMLEForAPI($this->apiClient->merchantConfig, $isMLESupportedByCybsForApi, "billingAgreementsRegistration,billingAgreementsRegistrationWithHttpInfo")) {
try {
$httpBody = MLEUtility::encryptRequestPayload($this->apiClient->merchantConfig, $httpBody);
} catch (Exception $e) {
self::$logger->error("Failed to encrypt request body: $e");
throw new ApiException("Failed to encrypt request body : " . $e->getMessage());
}
}
// Logging
self::$logger->debug("Resource : POST $resourcePath");
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\PtsV2CreateBillingAgreementPost201Response");
// make the API Call
try {
list($response, $statusCode, $httpHeader) = $this->apiClient->callApi(
$resourcePath,
'POST',
$queryParams,
$httpBody,
$headerParams,
'\CyberSource\Model\PtsV2CreateBillingAgreementPost201Response',
'/pts/v2/billing-agreements'
);
self::$logger->debug("Response Headers :\n" . \CyberSource\Utilities\Helpers\ListHelper::toString($httpHeader));
return [$this->apiClient->getSerializer()->deserialize($response, '\CyberSource\Model\PtsV2CreateBillingAgreementPost201Response', $httpHeader), $statusCode, $httpHeader];
} catch (ApiException $e) {
switch ($e->getCode()) {
case 201:
$data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\PtsV2CreateBillingAgreementPost201Response', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
case 400:
$data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\PtsV2CreateBillingAgreementPost400Response', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
case 502:
$data = $this->apiClient->getSerializer()->deserialize($e->getResponseBody(), '\CyberSource\Model\PtsV2CreateBillingAgreementPost502Response', $e->getResponseHeaders());
$e->setResponseObject($data);
break;
}
self::$logger->error("ApiException : $e");
throw $e;
}
}
}