Skip to content

Commit 88e011a

Browse files
committed
Add inline comments to Balance and Hlr
1 parent 867e14c commit 88e011a

File tree

2 files changed

+63
-0
lines changed

2 files changed

+63
-0
lines changed

src/MessageBird/Objects/Balance.php

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,24 @@
99
*/
1010
class Balance extends Base
1111
{
12+
/**
13+
* Your payment method. Possible values are: prepaid & postpaid
14+
*
15+
* @var string
16+
*/
1217
public $payment;
18+
19+
/**
20+
* Your payment type. Possible values are: credits & euros
21+
*
22+
* @var string
23+
*/
1324
public $type;
25+
26+
/**
27+
* The amount of balance of the payment type. When postpaid is your payment method, the amount will be 0.
28+
*
29+
* @var float
30+
*/
1431
public $amount;
1532
}

src/MessageBird/Objects/Hlr.php

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,60 @@ class Hlr extends Base
1515
const STATUS_UNKNOWN = 'unknown';
1616
const STATUS_FAILED = 'failed';
1717

18+
/**
19+
* An unique random ID which is created on the MessageBird platform and is returned upon creation of the object.
20+
*
21+
* @var string
22+
*/
1823
protected $id;
24+
25+
/**
26+
* The URL of the created object.
27+
*
28+
* @var string
29+
*/
1930
protected $href;
2031

32+
/**
33+
* The msisdns you want to do a network query on
34+
*
35+
* @var int
36+
*/
2137
public $msisdn;
38+
39+
/**
40+
* The MCCMNC code of the network provider. (http://en.wikipedia.org/wiki/Mobile_country_code)
41+
*
42+
* @var int
43+
*/
2244
public $network;
45+
46+
/**
47+
* A client reference. Here you can put your own reference,
48+
* like your internal reference.
49+
*
50+
* @var string
51+
*/
2352
public $reference;
53+
54+
/**
55+
* The status of the msisdns. Possible values: sent, absent, active, unknown, and failed
56+
*
57+
* @var string
58+
*/
2459
public $status;
2560

61+
/**
62+
* The date and time of the creation of the hlr in RFC3339 format (Y-m-d\TH:i:sP)
63+
*
64+
* @var string
65+
*/
2666
protected $createdDatetime;
67+
68+
/**
69+
* The datum time of the last status in RFC3339 format (Y-m-d\TH:i:sP)
70+
*
71+
* @var string
72+
*/
2773
protected $statusDatetime;
2874
}

0 commit comments

Comments
 (0)