forked from cardpay/php-sdk-v3
-
Notifications
You must be signed in to change notification settings - Fork 0
/
SubscriptionFilterParameters.php
736 lines (647 loc) · 20.4 KB
/
SubscriptionFilterParameters.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
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
<?php
/**
* PHP SDK for Unlimit API v3. All rights reserved.
*/
namespace Cardpay\model;
use \ArrayAccess;
use \Cardpay\ObjectSerializer;
class SubscriptionFilterParameters implements ModelInterface, ArrayAccess
{
const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $swaggerModelName = 'SubscriptionFilterParameters';
/**
* Array of property to type mappings. Used for (de)serialization
*
* @var string[]
*/
protected static $swaggerTypes = [
'request_id' => 'string',
'max_count' => 'int',
'offset' => 'int',
'sort_order' => 'string',
'customer_id' => 'string',
'plan_id' => 'string',
'start_time' => '\DateTime',
'end_time' => '\DateTime',
'currency' => 'string',
'status' => 'string',
'type' => 'string'
];
/**
* Array of property to format mappings. Used for (de)serialization
*
* @var string[]
*/
protected static $swaggerFormats = [
'request_id' => null,
'max_count' => 'int32',
'offset' => 'int32',
'sort_order' => null,
'customer_id' => null,
'plan_id' => null,
'start_time' => 'date-time',
'end_time' => 'date-time',
'currency' => null,
'status' => null,
'type' => null
];
/**
* Array of property to type mappings. Used for (de)serialization
*
* @return array
*/
public static function swaggerTypes()
{
return self::$swaggerTypes;
}
/**
* Array of property to format mappings. Used for (de)serialization
*
* @return array
*/
public static function swaggerFormats()
{
return self::$swaggerFormats;
}
/**
* Array of attributes where the key is the local name,
* and the value is the original name
*
* @var string[]
*/
protected static $attributeMap = [
'request_id' => 'request_id',
'max_count' => 'max_count',
'offset' => 'offset',
'sort_order' => 'sort_order',
'customer_id' => 'customer_id',
'plan_id' => 'plan_id',
'start_time' => 'start_time',
'end_time' => 'end_time',
'currency' => 'currency',
'status' => 'status',
'type' => 'type'
];
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @var string[]
*/
protected static $setters = [
'request_id' => 'setRequestId',
'max_count' => 'setMaxCount',
'offset' => 'setOffset',
'sort_order' => 'setSortOrder',
'customer_id' => 'setCustomerId',
'plan_id' => 'setPlanId',
'start_time' => 'setStartTime',
'end_time' => 'setEndTime',
'currency' => 'setCurrency',
'status' => 'setStatus',
'type' => 'setType'
];
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @var string[]
*/
protected static $getters = [
'request_id' => 'getRequestId',
'max_count' => 'getMaxCount',
'offset' => 'getOffset',
'sort_order' => 'getSortOrder',
'customer_id' => 'getCustomerId',
'plan_id' => 'getPlanId',
'start_time' => 'getStartTime',
'end_time' => 'getEndTime',
'currency' => 'getCurrency',
'status' => 'getStatus',
'type' => 'getType'
];
/**
* Array of attributes where the key is the local name,
* and the value is the original name
*
* @return array
*/
public static function attributeMap()
{
return self::$attributeMap;
}
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @return array
*/
public static function setters()
{
return self::$setters;
}
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @return array
*/
public static function getters()
{
return self::$getters;
}
/**
* The original name of the model.
*
* @return string
*/
public function getModelName()
{
return self::$swaggerModelName;
}
const STATUS_ACTIVE = 'ACTIVE';
const STATUS_INACTIVE = 'INACTIVE';
const STATUS_CANCELLED = 'CANCELLED';
const STATUS_PAST_DUE = 'PAST_DUE';
const STATUS_PENDING = 'PENDING';
const STATUS_COMPLETED = 'COMPLETED';
const STATUS_CARD_EXPIRED = 'CARD_EXPIRED';
const STATUS_ACTIVATION_FAILED = 'ACTIVATION_FAILED';
const TYPE_ONECLICK = 'ONECLICK';
const TYPE_SCHEDULED = 'SCHEDULED';
const TYPE_INSTALLMENT = 'INSTALLMENT';
/**
* Gets allowable values of the enum
*
* @return string[]
*/
public function getStatusAllowableValues()
{
return [
self::STATUS_ACTIVE,
self::STATUS_INACTIVE,
self::STATUS_CANCELLED,
self::STATUS_PAST_DUE,
self::STATUS_PENDING,
self::STATUS_COMPLETED,
self::STATUS_CARD_EXPIRED,
self::STATUS_ACTIVATION_FAILED,
];
}
/**
* Gets allowable values of the enum
*
* @return string[]
*/
public function getTypeAllowableValues()
{
return [
self::TYPE_ONECLICK,
self::TYPE_SCHEDULED,
self::TYPE_INSTALLMENT,
];
}
/**
* Associative array for storing property values
*
* @var mixed[]
*/
protected $container = [];
/**
* Constructor
*
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
{
$this->container['request_id'] = isset($data['request_id']) ? $data['request_id'] : null;
$this->container['max_count'] = isset($data['max_count']) ? $data['max_count'] : null;
$this->container['offset'] = isset($data['offset']) ? $data['offset'] : null;
$this->container['sort_order'] = isset($data['sort_order']) ? $data['sort_order'] : null;
$this->container['customer_id'] = isset($data['customer_id']) ? $data['customer_id'] : null;
$this->container['plan_id'] = isset($data['plan_id']) ? $data['plan_id'] : null;
$this->container['start_time'] = isset($data['start_time']) ? $data['start_time'] : null;
$this->container['end_time'] = isset($data['end_time']) ? $data['end_time'] : null;
$this->container['currency'] = isset($data['currency']) ? $data['currency'] : null;
$this->container['status'] = isset($data['status']) ? $data['status'] : null;
$this->container['type'] = isset($data['type']) ? $data['type'] : null;
}
/**
* Show all the invalid properties with reasons.
*
* @return array invalid properties with reasons
*/
public function listInvalidProperties()
{
$invalidProperties = [];
if ($this->container['request_id'] === null) {
$invalidProperties[] = "'request_id' can't be null";
}
if ((mb_strlen($this->container['request_id']) > 50)) {
$invalidProperties[] = "invalid value for 'request_id', the character length must be smaller than or equal to 50.";
}
if ((mb_strlen($this->container['request_id']) < 1)) {
$invalidProperties[] = "invalid value for 'request_id', the character length must be bigger than or equal to 1.";
}
if (!is_null($this->container['max_count']) && ($this->container['max_count'] > 10000)) {
$invalidProperties[] = "invalid value for 'max_count', must be smaller than or equal to 10000.";
}
if (!is_null($this->container['max_count']) && ($this->container['max_count'] < 1)) {
$invalidProperties[] = "invalid value for 'max_count', must be bigger than or equal to 1.";
}
if (!is_null($this->container['offset']) && ($this->container['offset'] > 10000)) {
$invalidProperties[] = "invalid value for 'offset', must be smaller than or equal to 10000.";
}
if (!is_null($this->container['offset']) && ($this->container['offset'] < 0)) {
$invalidProperties[] = "invalid value for 'offset', must be bigger than or equal to 0.";
}
if (!is_null($this->container['sort_order']) && !preg_match("/asc|desc/", $this->container['sort_order'])) {
$invalidProperties[] = "invalid value for 'sort_order', must be conform to the pattern /asc|desc/.";
}
if (!is_null($this->container['customer_id']) && (mb_strlen($this->container['customer_id']) > 32)) {
$invalidProperties[] = "invalid value for 'customer_id', the character length must be smaller than or equal to 32.";
}
if (!is_null($this->container['customer_id']) && (mb_strlen($this->container['customer_id']) < 0)) {
$invalidProperties[] = "invalid value for 'customer_id', the character length must be bigger than or equal to 0.";
}
if (!is_null($this->container['plan_id']) && (mb_strlen($this->container['plan_id']) > 32)) {
$invalidProperties[] = "invalid value for 'plan_id', the character length must be smaller than or equal to 32.";
}
if (!is_null($this->container['plan_id']) && (mb_strlen($this->container['plan_id']) < 0)) {
$invalidProperties[] = "invalid value for 'plan_id', the character length must be bigger than or equal to 0.";
}
$allowedValues = $this->getStatusAllowableValues();
if (!is_null($this->container['status']) && !in_array($this->container['status'], $allowedValues, true)) {
$invalidProperties[] = sprintf(
"invalid value for 'status', must be one of '%s'",
implode("', '", $allowedValues)
);
}
$allowedValues = $this->getTypeAllowableValues();
if (!is_null($this->container['type']) && !in_array($this->container['type'], $allowedValues, true)) {
$invalidProperties[] = sprintf(
"invalid value for 'type', must be one of '%s'",
implode("', '", $allowedValues)
);
}
return $invalidProperties;
}
/**
* Validate all the properties in the model
* return true if all passed
*
* @return bool True if all properties are valid
*/
public function valid()
{
return count($this->listInvalidProperties()) === 0;
}
/**
* Gets request_id
*
* @return string
*/
public function getRequestId()
{
return $this->container['request_id'];
}
/**
* Sets request_id
*
* @param string $request_id Request ID
*
* @return $this
*/
public function setRequestId($request_id)
{
if ((mb_strlen($request_id) > 50)) {
throw new \InvalidArgumentException('invalid length for $request_id when calling SubscriptionFilterParameters., must be smaller than or equal to 50.');
}
if ((mb_strlen($request_id) < 1)) {
throw new \InvalidArgumentException('invalid length for $request_id when calling SubscriptionFilterParameters., must be bigger than or equal to 1.');
}
$this->container['request_id'] = $request_id;
return $this;
}
/**
* Gets max_count
*
* @return int
*/
public function getMaxCount()
{
return $this->container['max_count'];
}
/**
* Sets max_count
*
* @param int $max_count Limit number of returned subscriptions (must be less than 10000, default is 1000)
*
* @return $this
*/
public function setMaxCount($max_count)
{
if (!is_null($max_count) && ($max_count > 10000)) {
throw new \InvalidArgumentException('invalid value for $max_count when calling SubscriptionFilterParameters., must be smaller than or equal to 10000.');
}
if (!is_null($max_count) && ($max_count < 1)) {
throw new \InvalidArgumentException('invalid value for $max_count when calling SubscriptionFilterParameters., must be bigger than or equal to 1.');
}
$this->container['max_count'] = $max_count;
return $this;
}
/**
* Gets offset
*
* @return int
*/
public function getOffset()
{
return $this->container['offset'];
}
/**
* Sets offset
*
* @param int $offset Offset (must be less than 10000)
*
* @return $this
*/
public function setOffset($offset)
{
if (!is_null($offset) && ($offset > 10000)) {
throw new \InvalidArgumentException('invalid value for $offset when calling SubscriptionFilterParameters., must be smaller than or equal to 10000.');
}
if (!is_null($offset) && ($offset < 0)) {
throw new \InvalidArgumentException('invalid value for $offset when calling SubscriptionFilterParameters., must be bigger than or equal to 0.');
}
$this->container['offset'] = $offset;
return $this;
}
/**
* Gets sort_order
*
* @return string
*/
public function getSortOrder()
{
return $this->container['sort_order'];
}
/**
* Sets sort_order
*
* @param string $sort_order Sort based on order of results. 'asc' for ascending order or 'desc' for descending order (default value)
*
* @return $this
*/
public function setSortOrder($sort_order)
{
if (!is_null($sort_order) && (!preg_match("/asc|desc/", $sort_order))) {
throw new \InvalidArgumentException("invalid value for $sort_order when calling SubscriptionFilterParameters., must conform to the pattern /asc|desc/.");
}
$this->container['sort_order'] = $sort_order;
return $this;
}
/**
* Gets customer_id
*
* @return string
*/
public function getCustomerId()
{
return $this->container['customer_id'];
}
/**
* Sets customer_id
*
* @param string $customer_id Merchant identifier of customer account
*
* @return $this
*/
public function setCustomerId($customer_id)
{
if (!is_null($customer_id) && (mb_strlen($customer_id) > 32)) {
throw new \InvalidArgumentException('invalid length for $customer_id when calling SubscriptionFilterParameters., must be smaller than or equal to 32.');
}
if (!is_null($customer_id) && (mb_strlen($customer_id) < 0)) {
throw new \InvalidArgumentException('invalid length for $customer_id when calling SubscriptionFilterParameters., must be bigger than or equal to 0.');
}
$this->container['customer_id'] = $customer_id;
return $this;
}
/**
* Gets plan_id
*
* @return string
*/
public function getPlanId()
{
return $this->container['plan_id'];
}
/**
* Sets plan_id
*
* @param string $plan_id Id of plan. Use for searching scheduled subscriptions by plan
*
* @return $this
*/
public function setPlanId($plan_id)
{
if (!is_null($plan_id) && (mb_strlen($plan_id) > 32)) {
throw new \InvalidArgumentException('invalid length for $plan_id when calling SubscriptionFilterParameters., must be smaller than or equal to 32.');
}
if (!is_null($plan_id) && (mb_strlen($plan_id) < 0)) {
throw new \InvalidArgumentException('invalid length for $plan_id when calling SubscriptionFilterParameters., must be bigger than or equal to 0.');
}
$this->container['plan_id'] = $plan_id;
return $this;
}
/**
* Gets start_time
*
* @return \DateTime
*/
public function getStartTime()
{
return $this->container['start_time'];
}
/**
* Sets start_time
*
* @param \DateTime $start_time Date and time up to milliseconds (in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when requested period starts (inclusive), UTC time, default is 24 hours before 'end_time' (format: yyyy-MM-dd'T'HH:mm:ss'Z')
*
* @return $this
*/
public function setStartTime($start_time)
{
$this->container['start_time'] = $start_time;
return $this;
}
/**
* Gets end_time
*
* @return \DateTime
*/
public function getEndTime()
{
return $this->container['end_time'];
}
/**
* Sets end_time
*
* @param \DateTime $end_time Date and time up to milliseconds (in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when requested period ends (not inclusive), UTC time, must be less than 7 days after 'start_time', default is current time (format: yyyy-MM-dd'T'HH:mm:ss'Z')
*
* @return $this
*/
public function setEndTime($end_time)
{
$this->container['end_time'] = $end_time;
return $this;
}
/**
* Gets currency
*
* @return string
*/
public function getCurrency()
{
return $this->container['currency'];
}
/**
* Sets currency
*
* @param string $currency [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of transactions currency
*
* @return $this
*/
public function setCurrency($currency)
{
$this->container['currency'] = $currency;
return $this;
}
/**
* Gets status
*
* @return string
*/
public function getStatus()
{
return $this->container['status'];
}
/**
* Sets status
*
* @param string $status Status of subscription
*
* @return $this
*/
public function setStatus($status)
{
$allowedValues = $this->getStatusAllowableValues();
if (!is_null($status) && !in_array($status, $allowedValues, true)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value for 'status', must be one of '%s'",
implode("', '", $allowedValues)
)
);
}
$this->container['status'] = $status;
return $this;
}
/**
* Gets type
*
* @return string
*/
public function getType()
{
return $this->container['type'];
}
/**
* Sets type
*
* @param string $type Type of subscription. 'ONECLICK' type will be ignored.
*
* @return $this
*/
public function setType($type)
{
$allowedValues = $this->getTypeAllowableValues();
if (!is_null($type) && !in_array($type, $allowedValues, true)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value for 'type', must be one of '%s'",
implode("', '", $allowedValues)
)
);
}
$this->container['type'] = $type;
return $this;
}
/**
* Returns true if offset exists. False otherwise.
*
* @param integer $offset Offset
*
* @return boolean
*/
public function offsetExists($offset)
{
return isset($this->container[$offset]);
}
/**
* Gets offset.
*
* @param integer $offset Offset
*
* @return mixed
*/
public function offsetGet($offset)
{
return isset($this->container[$offset]) ? $this->container[$offset] : null;
}
/**
* Sets value based on offset.
*
* @param integer $offset Offset
* @param mixed $value Value to be set
*
* @return void
*/
public function offsetSet($offset, $value)
{
if (is_null($offset)) {
$this->container[] = $value;
} else {
$this->container[$offset] = $value;
}
}
/**
* Unsets offset.
*
* @param integer $offset Offset
*
* @return void
*/
public function offsetUnset($offset)
{
unset($this->container[$offset]);
}
/**
* Gets the string presentation of the object
*
* @return string
*/
public function __toString()
{
if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
return json_encode(
ObjectSerializer::sanitizeForSerialization($this),
JSON_PRETTY_PRINT
);
}
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}