Dx 995 (#58)

* Added skeleton code

* Added non file upload/download code

* Added upload/download code

* Updated readme and composer.json

* Added tests

* Fixed syntax and added get tests

* Updated readme and fixed files as needed

* Fixed file download

* removed comments since code is correct

* Reverted check on put upload since it's unnecessary

Author: jmulford-bw

README.md

@@ -17,6 +17,7 @@ PHP Client library for Bandwidth's Phone Number Dashboard (AKA: Dashboard, Iris)
 | 2.0.8 | Fixed rate center check |
 | 2.1.0 | Added `importTnOrders`, `removeImportedTnOrders`, `inserviceNumbers`, and `importTnChecker` endpoints |
 | 2.2.0 | Added `csrs` endpoints |
+| 2.3.0 | Added `loas` endpoints for ImportTnOrders |
 
 ## Supported PHP Versions
 
@@ -650,6 +651,74 @@ print_r($account->getImportTnOrder("some_id_value")->ProcessingStatus);
 print_r($account->getImportTnOrderHistory("some_id_value")->OrderHistory[0]->Status);
 ```
 
+### Get Import TN Order LOAs
+```PHP
+$response = $account->getImportTnOrderLoas("order_id");
+print_r($response->resultMessage);
+echo "\n";
+print_r($response->fileNames); //this can be a single string (if there's 1 file) or an array of strings (if there's multiple files)
+```
+
+### Upload LOA file for an Import TN Order
+Valid `mime_types` can be found on the [Dashboard API Reference](https://dev.bandwidth.com/numbers/apiReference.html) under `/accounts /{accountId} /importTnOrders /{orderid} /loas`
+
+Mime types are expected to be in the format `x/y`, such as `application/pdf` or `text/plain`
+
+```PHP
+$account->uploadImportTnOrderLoaFile("order_id", "binary_file_contents", "mime_type");
+```
+
+```PHP
+$filename = "loa.pdf";
+$file = fopen($filename, "rb") or die("Unable to open file");
+$file_contents = fread($file, filesize($filename));
+$account->uploadImportTnOrderLoaFile("order_id", $file_contents, "application/pdf");
+fclose($file);
+```
+
+### Download LOA file for an Import TN Order (bonked. come back to this)
+Note: Make sure to grab the desired file ID from the response of `$account->getImportTnOrderLoas($order_id)` in the field `$response->fileNames`
+
+```PHP
+$response = $account->downloadImportTnOrderLoaFile("order_id", "file_id");
+$file = fopen("write.pdf", "wb") or die("Unable to open file");
+fwrite($file, $response);
+fclose($file);
+```
+
+### Replace LOA file for an Import TN Order
+```PHP
+$account->replaceImportTnOrderLoaFile("order_id", "file_id", "binary_file_contents", "mime_type");
+```
+
+### Delete LOA file for an Import TN Order
+```PHP
+$account->deleteImportTnOrderLoaFile("order_id", "file_id");
+```
+
+### Get LOA file metadata for an Import TN Order
+```PHP
+$response = $account->getImportTnOrderLoaFileMetadata("order_id", "file_id");
+print_r($response->DocumentName);
+echo "\n";
+print_r($response->DocumentType);
+
+```
+
+### Update LOA file metadata for an Import TN Order
+```PHP
+$file_metadata = new \Iris\FileMetaData(array(
+    "DocumentName" => "Updated",
+    "DocumentType" => "LOA"
+));
+$account->updateImportTnOrderLoaFileMetadata("order_id", "file_id", $file_metadata);
+```
+
+### Delete LOA file metadata for an Import TN Order
+```PHP
+$account->deleteImportTnOrderLoaFileMetadata("order_id", "file_id");
+```
+
 ### Check TNs Portability
 ```PHP
 print_r($account->checkTnsPortability(array("5554443333", "5553334444"))->ImportTnCheckerPayload);

composer.json

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

core/Client.php

@@ -232,7 +232,7 @@ public function raw_file_post($url, $content, $headers = [])
         ];
         $response = $this->request('post', $url, $options, false);
 
-        if (!isset($response['Location']))
+        if (!is_array($response) || !isset($response['Location']))
         {
             return '';
         }

src/Account.php

@@ -275,6 +275,50 @@ public function getImportTnOrderHistory($id) {
         return new OrderHistoryResponse($response);
     }
 
+    public function getImportTnOrderLoas($order_id) {
+        $url = sprintf('%s/%s/%s/%s', $this->account_id, 'importtnorders', $order_id, 'loas');
+        $response = parent::_get($url);
+        return new FileListResponse($response);
+    }
+
+    public function uploadImportTnOrderLoaFile($order_id, $file_contents, $mime_type) {
+        $url = sprintf('%s/%s/%s/%s', $this->account_id, 'importtnorders', $order_id, 'loas');
+        parent::raw_file_post($url, $file_contents, array("Content-Type" => $mime_type));
+    }
+
+    public function downloadImportTnOrderLoaFile($order_id, $file_id) {
+        $url = sprintf('accounts/%s/%s/%s/%s/%s', $this->account_id, 'importtnorders', $order_id, 'loas', $file_id);
+        //using the request function directly in order to set $parse=false
+        $response = $this->client->request('get', $url, $options=[], $parse=false)->getBody()->getContents();
+        return $response;
+    }
+
+    public function replaceImportTnOrderLoaFile($order_id, $file_id, $file_contents, $mime_type) {
+        $url = sprintf('%s/%s/%s/%s/%s', $this->account_id, 'importtnorders', $order_id, 'loas', $file_id);
+        parent::raw_file_put($url, $file_contents, array("Content-Type" => $mime_type));
+    }
+
+    public function deleteImportTnOrderLoaFile($order_id, $file_id) {
+        $url = sprintf('%s/%s/%s/%s/%s', $this->account_id, 'importtnorders', $order_id, 'loas', $file_id);
+        parent::_delete($url);
+    }
+
+    public function getImportTnOrderLoaFileMetadata($order_id, $file_id) {
+        $url = sprintf('%s/%s/%s/%s/%s/%s', $this->account_id, 'importtnorders', $order_id, 'loas', $file_id, 'metadata');
+        $response = parent::_get($url);
+        return new FileMetaData($response);
+    }
+
+    public function updateImportTnOrderLoaFileMetadata($order_id, $file_id, FileMetaData $file_metadata) {
+        $url = sprintf('%s/%s/%s/%s/%s/%s', $this->account_id, 'importtnorders', $order_id, 'loas', $file_id, 'metadata');
+        parent::put($url, 'FileMetaData', $file_metadata->to_array());
+    }
+
+    public function deleteImportTnOrderLoaFileMetadata($order_id, $file_id) {
+        $url = sprintf('%s/%s/%s/%s/%s/%s', $this->account_id, 'importtnorders', $order_id, 'loas', $file_id, 'metadata');
+        parent::_delete($url);
+    }
+
     public function checkTnsPortability($tns) {
         $url = sprintf('%s/%s', $this->account_id, 'importTnChecker');
         $payload = new ImportTnCheckerPayload(array(

src/simpleModels/FileListResponse.php

@@ -0,0 +1,18 @@
+<?php
+  
+namespace Iris;
+
+class FileListResponse {
+    use BaseModel;
+
+    protected $fields = array(
+        "fileCount" => array("type" => "integer"),
+        "fileNames" => array("type" => "string"),
+        "resultCode" => array("type" => "integer"),
+        "resultMessage" => array("type" => "string")
+    );
+
+    public function __construct($data) {
+        $this->set_data($data);
+    }
+}

tests/AccountTest.php

@@ -203,6 +203,26 @@ public static function setUpBeforeClass() {
                         <LastDateModifier>2014-11-16T04:08:46.000Z</LastDateModifier>
                     </Note>
                 </Notes> "),
+            new Response(200, [], "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
+                <fileListResponse>
+                <fileCount>2</fileCount>
+                <fileNames>803f3cc5-beae-469e-bd65-e9891ccdffb9-1092874634747.pdf</fileNames>
+                <resultCode>0</resultCode>
+                <resultMessage>LOA file list successfully returned</resultMessage>
+            </fileListResponse>"),
+            new Response(200, [], "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
+                <fileListResponse>
+                <fileCount>2</fileCount>
+                <fileNames>803f3cc5-beae-469e-bd65-e9891ccdffb9-1092874634747.pdf</fileNames>
+                <fileNames>803f3cc5-beae-469e-bd65-e9891ccdffb9-1430814967669.pdf</fileNames>
+                <resultCode>0</resultCode>
+                <resultMessage>LOA file list successfully returned</resultMessage>
+            </fileListResponse>"),
+            new Response(200, [], "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
+                <FileMetaData>
+                <DocumentName>file </DocumentName>
+                <DocumentType>LOA</DocumentType>
+            </FileMetaData>"),
         ]);
 
         self::$container = [];
@@ -488,4 +508,29 @@ public function testGetCsrOrderNotes() {
         $this->assertEquals("This is a second test note", $response->Note[1]->Description);
         self::$index++;
     }
+
+    public function testGetImportTnOrderLoas() {
+        //1 element in fileNames
+        $response = self::$account->getImportTnOrderLoas("order_id");
+
+        $this->assertEquals("803f3cc5-beae-469e-bd65-e9891ccdffb9-1092874634747.pdf", $response->fileNames);
+        $this->assertEquals("LOA file list successfully returned", $response->resultMessage);
+        self::$index++;
+
+        //2 elements in fileNames
+        $response = self::$account->getImportTnOrderLoas("order_id");
+
+        $this->assertEquals("803f3cc5-beae-469e-bd65-e9891ccdffb9-1092874634747.pdf", $response->fileNames[0]);
+        $this->assertEquals("803f3cc5-beae-469e-bd65-e9891ccdffb9-1430814967669.pdf", $response->fileNames[1]);
+        $this->assertEquals("LOA file list successfully returned", $response->resultMessage);
+        self::$index++;
+    }
+
+    public function testGetImportTnOrderLoaFileMetadata() {
+        $response = self::$account->getImportTnOrderLoaFileMetadata("order_id", "file_id");
+
+        $this->assertEquals("file", $response->DocumentName);
+        $this->assertEquals("LOA", $response->DocumentType);
+        self::$index++;
+    }
 }