1 <?php
2
3 namespace PayPal\Api;
4
5 use PayPal\Common\PayPalModel;
6
7 /**
8 * Class PayoutBatchHeader
9 *
10 * Batch header resource.
11 *
12 * @package PayPal\Api
13 *
14 * @property string payout_batch_id
15 * @property string batch_status
16 * @property string time_created
17 * @property string time_completed
18 * @property \PayPal\Api\PayoutSenderBatchHeader sender_batch_header
19 * @property \PayPal\Api\Currency amount
20 * @property \PayPal\Api\Currency fees
21 * @property \PayPal\Api\Error errors
22 * @property \PayPal\Api\Links[] links
23 */
24 class PayoutBatchHeader extends PayPalModel
25 {
26 /**
27 * The PayPal-generated ID for a batch payout.
28 *
29 * @param string $payout_batch_id
30 *
31 * @return $this
32 */
33 public function setPayoutBatchId($payout_batch_id)
34 {
35 $this->payout_batch_id = $payout_batch_id;
36 return $this;
37 }
38
39 /**
40 * The PayPal-generated ID for a batch payout.
41 *
42 * @return string
43 */
44 public function getPayoutBatchId()
45 {
46 return $this->payout_batch_id;
47 }
48
49 /**
50 * The PayPal-generated batch payout status. If the batch payout passes the preliminary checks, the status is `PENDING`.
51 *
52 * @param string $batch_status
53 *
54 * @return $this
55 */
56 public function setBatchStatus($batch_status)
57 {
58 $this->batch_status = $batch_status;
59 return $this;
60 }
61
62 /**
63 * The PayPal-generated batch payout status. If the batch payout passes the preliminary checks, the status is `PENDING`.
64 *
65 * @return string
66 */
67 public function getBatchStatus()
68 {
69 return $this->batch_status;
70 }
71
72 /**
73 * The time the batch entered processing.
74 *
75 * @param string $time_created
76 *
77 * @return $this
78 */
79 public function setTimeCreated($time_created)
80 {
81 $this->time_created = $time_created;
82 return $this;
83 }
84
85 /**
86 * The time the batch entered processing.
87 *
88 * @return string
89 */
90 public function getTimeCreated()
91 {
92 return $this->time_created;
93 }
94
95 /**
96 * The time that processing for the batch was completed.
97 *
98 * @param string $time_completed
99 *
100 * @return $this
101 */
102 public function setTimeCompleted($time_completed)
103 {
104 $this->time_completed = $time_completed;
105 return $this;
106 }
107
108 /**
109 * The time that processing for the batch was completed.
110 *
111 * @return string
112 */
113 public function getTimeCompleted()
114 {
115 return $this->time_completed;
116 }
117
118 /**
119 * The original batch header as provided by the payment sender.
120 *
121 * @param \PayPal\Api\PayoutSenderBatchHeader $sender_batch_header
122 *
123 * @return $this
124 */
125 public function setSenderBatchHeader($sender_batch_header)
126 {
127 $this->sender_batch_header = $sender_batch_header;
128 return $this;
129 }
130
131 /**
132 * The sender-provided batch payout header.
133 *
134 * @return \PayPal\Api\PayoutSenderBatchHeader
135 */
136 public function getSenderBatchHeader()
137 {
138 return $this->sender_batch_header;
139 }
140
141 /**
142 * Total amount, in U.S. dollars, requested for the applicable payouts.
143 *
144 * @param \PayPal\Api\Currency $amount
145 *
146 * @return $this
147 */
148 public function setAmount($amount)
149 {
150 $this->amount = $amount;
151 return $this;
152 }
153
154 /**
155 * Total amount, in U.S. dollars, requested for the applicable payouts.
156 *
157 * @return \PayPal\Api\Currency
158 */
159 public function getAmount()
160 {
161 return $this->amount;
162 }
163
164 /**
165 * Total estimate in U.S. dollars for the applicable payouts fees.
166 *
167 * @param \PayPal\Api\Currency $fees
168 *
169 * @return $this
170 */
171 public function setFees($fees)
172 {
173 $this->fees = $fees;
174 return $this;
175 }
176
177 /**
178 * Total estimate in U.S. dollars for the applicable payouts fees.
179 *
180 * @return \PayPal\Api\Currency
181 */
182 public function getFees()
183 {
184 return $this->fees;
185 }
186
187 /**
188 * Sets Errors
189 *
190 * @param \PayPal\Api\Error $errors
191 *
192 * @return $this
193 */
194 public function setErrors($errors)
195 {
196 $this->errors = $errors;
197 return $this;
198 }
199
200 /**
201 * Gets Errors
202 *
203 * @return \PayPal\Api\Error
204 */
205 public function getErrors()
206 {
207 return $this->errors;
208 }
209
210 /**
211 * Sets Links
212 *
213 * @param \PayPal\Api\Links[] $links
214 *
215 * @return $this
216 */
217 public function setLinks($links)
218 {
219 $this->links = $links;
220 return $this;
221 }
222
223 /**
224 * Gets Links
225 *
226 * @return \PayPal\Api\Links[]
227 */
228 public function getLinks()
229 {
230 return $this->links;
231 }
232
233 /**
234 * Append Links to the list.
235 *
236 * @param \PayPal\Api\Links $links
237 * @return $this
238 */
239 public function addLink($links)
240 {
241 if (!$this->getLinks()) {
242 return $this->setLinks(array($links));
243 } else {
244 return $this->setLinks(
245 array_merge($this->getLinks(), array($links))
246 );
247 }
248 }
249
250 /**
251 * Remove Links from the list.
252 *
253 * @param \PayPal\Api\Links $links
254 * @return $this
255 */
256 public function removeLink($links)
257 {
258 return $this->setLinks(
259 array_diff($this->getLinks(), array($links))
260 );
261 }
262
263 }
264