/
CardGeneratedCvc2.php
399 lines (356 loc) · 8.76 KB
/
CardGeneratedCvc2.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
<?php
namespace bunq\Model\Generated\Endpoint;
use bunq\Http\ApiClient;
use bunq\Model\Core\BunqModel;
/**
* Endpoint for generating and retrieving a new CVC2 code.
*
* @generated
*/
class CardGeneratedCvc2 extends BunqModel
{
/**
* Endpoint constants.
*/
const ENDPOINT_URL_CREATE = 'user/%s/card/%s/generated-cvc2';
const ENDPOINT_URL_READ = 'user/%s/card/%s/generated-cvc2/%s';
const ENDPOINT_URL_UPDATE = 'user/%s/card/%s/generated-cvc2/%s';
const ENDPOINT_URL_LISTING = 'user/%s/card/%s/generated-cvc2';
/**
* Field constants.
*/
const FIELD_TYPE = 'type';
/**
* Object type.
*/
const OBJECT_TYPE_GET = 'CardGeneratedCvc2';
/**
* The id of the cvc code.
*
* @var int
*/
protected $id;
/**
* The timestamp of the cvc code's creation.
*
* @var string
*/
protected $created;
/**
* The timestamp of the cvc code's last update.
*
* @var string
*/
protected $updated;
/**
* The type of generated cvc2. Can be STATIC or GENERATED.
*
* @var string
*/
protected $type;
/**
* The cvc2 code.
*
* @var string
*/
protected $cvc2;
/**
* The status of the cvc2. Can be AVAILABLE, USED, EXPIRED, BLOCKED.
*
* @var string
*/
protected $status;
/**
* Expiry time of the cvc2.
*
* @var string
*/
protected $expiryTime;
/**
* The type of generated cvc2. Can be STATIC or GENERATED.
*
* @var string|null
*/
protected $typeFieldForRequest;
/**
* @param string|null $type The type of generated cvc2. Can be STATIC or
* GENERATED.
*/
public function __construct(string $type = null)
{
$this->typeFieldForRequest = $type;
}
/**
* Generate a new CVC2 code for a card.
*
* @param int $cardId
* @param string|null $type The type of generated cvc2. Can be STATIC or
* GENERATED.
* @param string[] $customHeaders
*
* @return BunqResponseInt
*/
public static function create(int $cardId, string $type = null, array $customHeaders = []): BunqResponseInt
{
$apiClient = new ApiClient(static::getApiContext());
$apiClient->enableEncryption();
$responseRaw = $apiClient->post(
vsprintf(
self::ENDPOINT_URL_CREATE,
[static::determineUserId(), $cardId]
),
[self::FIELD_TYPE => $type],
$customHeaders
);
return BunqResponseInt::castFromBunqResponse(
static::processForId($responseRaw)
);
}
/**
* Get the details for a specific generated CVC2 code.
*
* @param int $cardId
* @param int $cardGeneratedCvc2Id
* @param string[] $customHeaders
*
* @return BunqResponseCardGeneratedCvc2
*/
public static function get(
int $cardId,
int $cardGeneratedCvc2Id,
array $customHeaders = []
): BunqResponseCardGeneratedCvc2 {
$apiClient = new ApiClient(static::getApiContext());
$responseRaw = $apiClient->get(
vsprintf(
self::ENDPOINT_URL_READ,
[static::determineUserId(), $cardId, $cardGeneratedCvc2Id]
),
[],
$customHeaders
);
return BunqResponseCardGeneratedCvc2::castFromBunqResponse(
static::fromJson($responseRaw, self::OBJECT_TYPE_GET)
);
}
/**
* @param int $cardId
* @param int $cardGeneratedCvc2Id
* @param string|null $type The type of generated cvc2. Can be STATIC or
* GENERATED.
* @param string[] $customHeaders
*
* @return BunqResponseInt
*/
public static function update(
int $cardId,
int $cardGeneratedCvc2Id,
string $type = null,
array $customHeaders = []
): BunqResponseInt {
$apiClient = new ApiClient(static::getApiContext());
$apiClient->enableEncryption();
$responseRaw = $apiClient->put(
vsprintf(
self::ENDPOINT_URL_UPDATE,
[static::determineUserId(), $cardId, $cardGeneratedCvc2Id]
),
[self::FIELD_TYPE => $type],
$customHeaders
);
return BunqResponseInt::castFromBunqResponse(
static::processForId($responseRaw)
);
}
/**
* Get all generated CVC2 codes for a card.
*
* This method is called "listing" because "list" is a restricted PHP word
* and cannot be used as constants, class names, function or method names.
*
* @param int $cardId
* @param string[] $params
* @param string[] $customHeaders
*
* @return BunqResponseCardGeneratedCvc2List
*/
public static function listing(
int $cardId,
array $params = [],
array $customHeaders = []
): BunqResponseCardGeneratedCvc2List {
$apiClient = new ApiClient(static::getApiContext());
$responseRaw = $apiClient->get(
vsprintf(
self::ENDPOINT_URL_LISTING,
[static::determineUserId(), $cardId]
),
$params,
$customHeaders
);
return BunqResponseCardGeneratedCvc2List::castFromBunqResponse(
static::fromJsonList($responseRaw, self::OBJECT_TYPE_GET)
);
}
/**
* The id of the cvc code.
*
* @return int
*/
public function getId()
{
return $this->id;
}
/**
* @deprecated User should not be able to set values via setters, use
* constructor.
*
* @param int $id
*/
public function setId($id)
{
$this->id = $id;
}
/**
* The timestamp of the cvc code's creation.
*
* @return string
*/
public function getCreated()
{
return $this->created;
}
/**
* @deprecated User should not be able to set values via setters, use
* constructor.
*
* @param string $created
*/
public function setCreated($created)
{
$this->created = $created;
}
/**
* The timestamp of the cvc code's last update.
*
* @return string
*/
public function getUpdated()
{
return $this->updated;
}
/**
* @deprecated User should not be able to set values via setters, use
* constructor.
*
* @param string $updated
*/
public function setUpdated($updated)
{
$this->updated = $updated;
}
/**
* The type of generated cvc2. Can be STATIC or GENERATED.
*
* @return string
*/
public function getType()
{
return $this->type;
}
/**
* @deprecated User should not be able to set values via setters, use
* constructor.
*
* @param string $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* The cvc2 code.
*
* @return string
*/
public function getCvc2()
{
return $this->cvc2;
}
/**
* @deprecated User should not be able to set values via setters, use
* constructor.
*
* @param string $cvc2
*/
public function setCvc2($cvc2)
{
$this->cvc2 = $cvc2;
}
/**
* The status of the cvc2. Can be AVAILABLE, USED, EXPIRED, BLOCKED.
*
* @return string
*/
public function getStatus()
{
return $this->status;
}
/**
* @deprecated User should not be able to set values via setters, use
* constructor.
*
* @param string $status
*/
public function setStatus($status)
{
$this->status = $status;
}
/**
* Expiry time of the cvc2.
*
* @return string
*/
public function getExpiryTime()
{
return $this->expiryTime;
}
/**
* @deprecated User should not be able to set values via setters, use
* constructor.
*
* @param string $expiryTime
*/
public function setExpiryTime($expiryTime)
{
$this->expiryTime = $expiryTime;
}
/**
* @return bool
*/
public function isAllFieldNull()
{
if (!is_null($this->id)) {
return false;
}
if (!is_null($this->created)) {
return false;
}
if (!is_null($this->updated)) {
return false;
}
if (!is_null($this->type)) {
return false;
}
if (!is_null($this->cvc2)) {
return false;
}
if (!is_null($this->status)) {
return false;
}
if (!is_null($this->expiryTime)) {
return false;
}
return true;
}
}