1 <?php
2
3 namespace PayPal\Api;
4
5 use PayPal\Common\PayPalModel;
6
7 /**
8 * Class AgreementDetails
9 *
10 * A resource representing the agreement details.
11 *
12 * @package PayPal\Api
13 *
14 * @property \PayPal\Api\Currency outstanding_balance
15 * @property string cycles_remaining
16 * @property string cycles_completed
17 * @property string next_billing_date
18 * @property string last_payment_date
19 * @property \PayPal\Api\Currency last_payment_amount
20 * @property string final_payment_date
21 * @property string failed_payment_count
22 */
23 class AgreementDetails extends PayPalModel
24 {
25 /**
26 * The outstanding balance for this agreement.
27 *
28 * @param \PayPal\Api\Currency $outstanding_balance
29 *
30 * @return $this
31 */
32 public function setOutstandingBalance($outstanding_balance)
33 {
34 $this->outstanding_balance = $outstanding_balance;
35 return $this;
36 }
37
38 /**
39 * The outstanding balance for this agreement.
40 *
41 * @return \PayPal\Api\Currency
42 */
43 public function getOutstandingBalance()
44 {
45 return $this->outstanding_balance;
46 }
47
48 /**
49 * Number of cycles remaining for this agreement.
50 *
51 * @param string $cycles_remaining
52 *
53 * @return $this
54 */
55 public function setCyclesRemaining($cycles_remaining)
56 {
57 $this->cycles_remaining = $cycles_remaining;
58 return $this;
59 }
60
61 /**
62 * Number of cycles remaining for this agreement.
63 *
64 * @return string
65 */
66 public function getCyclesRemaining()
67 {
68 return $this->cycles_remaining;
69 }
70
71 /**
72 * Number of cycles completed for this agreement.
73 *
74 * @param string $cycles_completed
75 *
76 * @return $this
77 */
78 public function setCyclesCompleted($cycles_completed)
79 {
80 $this->cycles_completed = $cycles_completed;
81 return $this;
82 }
83
84 /**
85 * Number of cycles completed for this agreement.
86 *
87 * @return string
88 */
89 public function getCyclesCompleted()
90 {
91 return $this->cycles_completed;
92 }
93
94 /**
95 * The next billing date for this agreement, represented as 2014-02-19T10:00:00Z format.
96 *
97 * @param string $next_billing_date
98 *
99 * @return $this
100 */
101 public function setNextBillingDate($next_billing_date)
102 {
103 $this->next_billing_date = $next_billing_date;
104 return $this;
105 }
106
107 /**
108 * The next billing date for this agreement, represented as 2014-02-19T10:00:00Z format.
109 *
110 * @return string
111 */
112 public function getNextBillingDate()
113 {
114 return $this->next_billing_date;
115 }
116
117 /**
118 * Last payment date for this agreement, represented as 2014-06-09T09:42:31Z format.
119 *
120 * @param string $last_payment_date
121 *
122 * @return $this
123 */
124 public function setLastPaymentDate($last_payment_date)
125 {
126 $this->last_payment_date = $last_payment_date;
127 return $this;
128 }
129
130 /**
131 * Last payment date for this agreement, represented as 2014-06-09T09:42:31Z format.
132 *
133 * @return string
134 */
135 public function getLastPaymentDate()
136 {
137 return $this->last_payment_date;
138 }
139
140 /**
141 * Last payment amount for this agreement.
142 *
143 * @param \PayPal\Api\Currency $last_payment_amount
144 *
145 * @return $this
146 */
147 public function setLastPaymentAmount($last_payment_amount)
148 {
149 $this->last_payment_amount = $last_payment_amount;
150 return $this;
151 }
152
153 /**
154 * Last payment amount for this agreement.
155 *
156 * @return \PayPal\Api\Currency
157 */
158 public function getLastPaymentAmount()
159 {
160 return $this->last_payment_amount;
161 }
162
163 /**
164 * Last payment date for this agreement, represented as 2015-02-19T10:00:00Z format.
165 *
166 * @param string $final_payment_date
167 *
168 * @return $this
169 */
170 public function setFinalPaymentDate($final_payment_date)
171 {
172 $this->final_payment_date = $final_payment_date;
173 return $this;
174 }
175
176 /**
177 * Last payment date for this agreement, represented as 2015-02-19T10:00:00Z format.
178 *
179 * @return string
180 */
181 public function getFinalPaymentDate()
182 {
183 return $this->final_payment_date;
184 }
185
186 /**
187 * Total number of failed payments for this agreement.
188 *
189 * @param string $failed_payment_count
190 *
191 * @return $this
192 */
193 public function setFailedPaymentCount($failed_payment_count)
194 {
195 $this->failed_payment_count = $failed_payment_count;
196 return $this;
197 }
198
199 /**
200 * Total number of failed payments for this agreement.
201 *
202 * @return string
203 */
204 public function getFailedPaymentCount()
205 {
206 return $this->failed_payment_count;
207 }
208
209 }
210