Added readme and minor fixes for tn option orders (#61)

* Added readme and minor fixes for tn option orders

* added user agent (#62)

* Added php user agent header

* Updated version

* Removed version increase to bundle in 1 release

Author: jmulford-bw

README.md

@@ -19,6 +19,7 @@ PHP Client library for Bandwidth's Phone Number Dashboard (AKA: Dashboard, Iris)
 | 2.2.0 | Added `csrs` endpoints |
 | 2.3.0 | Added `loas` endpoints for ImportTnOrders |
 | 2.4.0 | Added Emergency Calling Notification, Emergeny Notification Group, Emergency Notification Endpoint, and Alternate End User Identity methods |
+| 2.5.0 | Added `PortOutPasscode` for TnOption orders |
 
 ## Supported PHP Versions
 
@@ -589,20 +590,77 @@ $billingReport->file(['stream' => true, 'sink' => $outFile]);
 
 ## TN Options
 
-### Create New TN Options (Async request)
+### Get TN Option Orders
+```PHP
+$tnoptions = $account->tnoptions();
+$response = $tnoptions->getList();
+print_r($response[0]->OrderId);
+```
+
+### GET TN Option Order
+```PHP
+$tnoptions = $account->tnoptions();
+$response = $tnoptions->tnoption("order_id");
+print_r($response->OrderCreateDate);
+```
+
+### Get TN Option Order (error)
+```PHP
+$tnoptions = $account->tnoptions();
+$response = $tnoptions->tnoption("error_order_id");
+print_r($response->ErrorList->Error->Description); //note: Error could be an array or a single object
+//depending on how many errors are returned
+```
+
+### Create Portout Passcode
+```PHP
+$tnoptions = $account->tnoptions();
+$data = array(
+    "TnOptionGroups" => array(
+        "TnOptionGroup" => array(
+            "PortOutPasscode" => "12abd38",
+            "TelephoneNumbers" => array(
+                "TelephoneNumber" => "2018551020"
+            )
+        ),
+    )
+);
+$response = $tnoptions->create($data);
+print_r($response->OrderCreateDate);
+```
+
+### Create Call Forward Number
+```PHP
+$tnoptions = $account->tnoptions();
+$data = array(
+    "TnOptionGroups" => array(
+        "TnOptionGroup" => array(
+            "CallForward" => "2018551022",
+            "TelephoneNumbers" => array(
+                "TelephoneNumber" => "2018551020"
+            )
+        ),
+    )
+);
+$response = $tnoptions->create($data);
+print_r($response->OrderCreateDate);
+```
+
+### Enable SMS
 ```PHP
 $tnoptions = $account->tnoptions();
 $data = array(
     "TnOptionGroups" => array(
         "TnOptionGroup" => array(
-            "CallForward" => "<FORWARD_NUMBER>",
+            "Sms" => "on",
             "TelephoneNumbers" => array(
-                "TelephoneNumber" => "<UPDATE_NUMBER>"
+                "TelephoneNumber" => "2018551020"
             )
         ),
     )
 );
-$tnoptions->create($data);
+$response = $tnoptions->create($data);
+print_r($response->OrderCreateDate);
 ```
 
 ## Hosted Messaging Functions

composer.json

@@ -4,7 +4,7 @@
     "description": "Bandwidth's Iris SDK for PHP",
     "keywords": ["iris","sdk","php"],
     "homepage": "http://dev.bandwidth.com",
-    "reference": "v2.4.0",
+    "reference": "v2.5.0",
     "license": "MIT",
     "authors": [
     ],

core/Client.php

@@ -147,6 +147,10 @@ public function __construct($login, $password, $options = [])
             $client_options['handler'] = $options['handler'];
         }
 
+        $options['headers'] = array(
+            'User-Agent' => 'PHP-Bandwidth-Iris'
+        );
+
         $this->client = new \GuzzleHttp\Client($options);
     }
 

src/TnOptionModel.php

@@ -77,6 +77,7 @@ final class TnOption extends RestEntry{
         "CreatedByUser" => array("type" => "string"),
         "ErrorList" => array("type" => "\Iris\ErrorList"),
         "TnOptionGroups" => array("type" => "\Iris\TnOptionGroups"),
+        "PortOutPasscode" => array("type" => "string")
     );
 
 

src/simpleModels/TnOptionGroups.php

@@ -25,9 +25,10 @@ class TnOptionGroup {
         "CallingNameDisplay" => array("type" => "string"),
         "Protected" => array("type" => "string"),
         "Sms" => array("type" => "string"),
-        "FinalDestinationURI " => array("type" => "string")
+        "FinalDestinationURI " => array("type" => "string"),
+        "PortOutPasscode" => array("type" => "string")
     );
     public function __construct($data) {
         $this->set_data($data);
     }
-}
+}