Completed
Pull Request — master (#18)
by Sean
15:39
created

ApplicationGateway::getMerchantPayments()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 9
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 1
CRAP Score 1

Importance

Changes 2
Bugs 0 Features 1
Metric Value
c 2
b 0
f 1
dl 0
loc 9
ccs 1
cts 1
cp 1
rs 9.6666
cc 1
eloc 6
nc 1
nop 3
crap 1
1
<?php
2
/*
3
* This file is part of the PayBreak/basket package.
4
*
5
* (c) PayBreak <[email protected]>
6
*
7
* For the full copyright and license information, please view the LICENSE
8
* file that was distributed with this source code.
9
*/
10
11
namespace PayBreak\Sdk\Gateways;
12
13
use PayBreak\Sdk\Entities\ApplicationEntity;
14
use PayBreak\Sdk\SdkException;
15
use WNowicki\Generic\ApiClient\ErrorResponseException;
16
17
/**
18
 * Application Gateway
19
 *
20
 * @author WN
21
 * @package PayBreak\Sdk\Gateways
22
 */
23
class ApplicationGateway extends AbstractGateway
24
{
25
    /**
26
     * @author WN
27
     * @param int $id
28
     * @param string $token
29
     * @return ApplicationEntity
30
     * @throws SdkException
31
     */
32 2
    public function getApplication($id, $token)
33
    {
34 2
        return ApplicationEntity::make($this->fetchDocument('/v4/applications/' . $id, $token, 'Application'));
35
    }
36
37
    /**
38
     * @author WN
39
     * @param ApplicationEntity $application
40
     * @param string $token
41
     * @return ApplicationEntity
42
     * @throws SdkException
43
     */
44
    public function initialiseApplication(ApplicationEntity $application, $token)
45
    {
46
        $api = $this->getApiFactory()->makeApiClient($token);
47
48
        try {
49
            $response = $api->post('/v4/initialize-application', $application->toArray(true));
50
51
            $application->setId($response['application']);
52
            $application->setResumeUrl($response['url']);
53
54
            return $application;
55
56
        } catch (ErrorResponseException $e) {
57
58
            $this->logWarning('ApplicationGateway::initialiseApplication[' . $e->getCode() . ']: ' . $e->getMessage());
59
            throw new SdkException($e->getMessage());
60
61
        } catch (\Exception $e) {
62
63
            $this->logError('ApplicationGateway::initialiseApplication[' . $e->getCode() . ']: ' . $e->getMessage());
64
            throw new SdkException('Problem Initialising Application on Provider API');
65
        }
66
    }
67
68
    /**
69
     * @author WN
70
     * @param int $id
71
     * @param string $token
72
     * @return bool
73
     * @throws SdkException
74
     */
75 2
    public function fulfilApplication($id, $token)
76
    {
77 2
        return $this->requestAction('/v4/applications/' . $id . '/fulfil', [], $token);
78
    }
79
80
    /**
81
     * @param int $id
82
     * @param string $description
83
     * @param string $token
84
     * @return bool
85
     * @throws SdkException
86
     */
87 2
    public function cancelApplication($id, $description, $token)
88
    {
89 2
        return $this->requestAction(
90 2
            '/v4/applications/' . $id . '/request-cancellation',
91 2
            ['description' => $description],
92
            $token
93 2
        );
94
    }
95
96
    /**
97
     * @param $token
98
     * @return array
99
     * @throws SdkException
100
     */
101
    public function getPendingCancellations($installationId, $token)
102
    {
103
        return $this->fetchDocument(
104
            '/v4/installations/' . $installationId . '/applications',
105
            $token,
106
            'Pending Cancellations',
107
            ['pending-cancellations' => true]
108
        );
109
    }
110
111
    /**
112
     * Get Merchant Payments. Filter Params can accept
113
     * - since, until : (string - ISO8601 Date Part Only)
114
     * - limit, offset : (int)
115
     *
116
     * @author SL
117
     * @param $application
118
     * @param $token
119 4
     * @param array $filterParams
120
     * @return array
121 4
     */
122 4
    public function getMerchantPayments($application, $token, array $filterParams = [])
123
    {
124
        return $this->postDocument(
125
            'applications/' . $application . '/get-merchant-payments',
126
            $filterParams,
127
            $token,
128
            'Merchant Payments'
129
        );
130
    }
131
132
    /**
133
     * Add a Merchant Payment to the given application. Amount should be supplied in pence.
134
     *
135
     * @author SL
136
     * @param string $application
137
     * @param \DateTime $effectiveDate
138
     * @param int $amount
139
     * @param string $token
140
     * @return array
141
     */
142
    public function addMerchantPayment($application, \DateTime $effectiveDate, $amount, $token)
143
    {
144
        return $this->postDocument(
145
            'applications/' . $application . '/add-merchant-payment',
146
            [
147
                'amount' => $amount,
148
                'effective_date' => $effectiveDate->format('Y-m-d'),
149
            ],
150
            $token,
151
            'Add Merchant Payment'
152
        );
153
    }
154
155
    /**
156
     * @author WN
157
     * @param string $action
158
     * @param array $data
159
     * @param string $token
160
     * @return bool
161
     * @throws SdkException
162
     */
163
    private function requestAction($action, $data, $token)
164
    {
165
        $this->postDocument($action, $data, $token, 'Application');
166
        return true;
167
    }
168
}
169