Dx 1628 added application management (#69)

jmulford-bw · web-flow · commit a990bcb5548c · 2020-11-24T09:39:49.000-05:00
* DX-1628 added application management endpoints

* Updated readme

* Bumped version

* Added check to always return a list for list items
diff --git a/README.md b/README.md
@@ -22,6 +22,7 @@ PHP Client library for Bandwidth's Phone Number Dashboard (AKA: Dashboard, Iris)
 | 2.5.0 | Added `PortOutPasscode` for TnOption orders |
 | 2.5.1 | Fixed grabbing of response header for file uploads |
 | 3.0.0 | Updated to guzzle 7. This version no longer supports verisons of PHP less than 7.2. Older versions of this package will still work on PHP versions less than 7.2 |
+| 3.1.0 | Added application management |
 
 ## Supported PHP Versions
 
@@ -1020,3 +1021,56 @@ $response = $account->getAlternateEndUserInformation();
 ```php
 $response = $account->getAlternateCallerInformation("id");
 ```
+
+## Application Management
+
+### Get Applications
+
+```php
+$response = $account->getApplications();
+print_r($response);
+```
+
+### Get Application
+
+```php
+$response = $account->getApplication("id");
+print_r($response);
+```
+
+### Create Application
+
+```php
+$data = array(
+    'ServiceType' => 'Messaging-V2',
+    'AppName' => 'sample',
+    'MsgCallbackUrl' => 'https://test.com'
+);
+$response = $account->createApplication($data);
+print_r($response);
+```
+
+### Update Application
+
+```php
+$data = array(
+    'ServiceType' => 'Messaging-V2',
+    'AppName' => 'sample',
+    'MsgCallbackUrl' => 'https://test2.com'
+);
+$response = $account->updateApplication("id", $data);
+print_r($response);
+```
+
+### Delete Application
+
+```php
+$account->deleteApplication("id");
+```
+
+### Get Application SipPeers
+
+```php
+$response = $account->getApplicationSippeers("id");
+print_r($response);
+```
diff --git a/composer.json b/composer.json
@@ -4,7 +4,7 @@
     "description": "Bandwidth's Iris SDK for PHP",
     "keywords": ["iris","sdk","php"],
     "homepage": "http://dev.bandwidth.com",
-    "reference": "v3.0.0",
+    "reference": "v3.1.0",
     "license": "MIT",
     "authors": [
     ],
diff --git a/src/Account.php b/src/Account.php
@@ -489,4 +489,49 @@ public function deleteEmergencyNotificationRecipient($id) {
         $url = sprintf('%s/%s/%s', $this->account_id, 'emergencyNotificationRecipients', $id);
         parent::_delete($url);
     }
+    
+    public function getApplications() {
+        $url = sprintf('%s/%s', $this->account_id, 'applications');
+        $data = parent::_get($url);
+        $response = $data['ApplicationList']['Application'];
+        if (array_values($response) == $response) {
+            return $response;
+        } else {
+            return [$response];
+        }
+    }
+    
+    public function getApplication($id) {
+        $url = sprintf('%s/%s/%s', $this->account_id, 'applications', $id);
+        $data = parent::_get($url);
+        return $data['Application'];
+    }
+
+    public function createApplication($application) {
+        $url = sprintf('%s/%s', $this->account_id, 'applications');
+        $data = parent::post($url, 'Application', $application);
+        return $data['Application'];
+    }
+
+    public function updateApplication($id, $application) {
+        $url = sprintf('%s/%s/%s', $this->account_id, 'applications', $id);
+        $data = parent::put($url, 'Application', $application);
+        return $data['Application'];
+    }
+
+    public function deleteApplication($id) {
+        $url = sprintf('%s/%s/%s', $this->account_id, 'applications', $id);
+        $data = parent::_delete($url);
+    }
+
+    public function getApplicationSippeers($id) {
+        $url = sprintf('%s/%s/%s/%s', $this->account_id, 'applications', $id, 'associatedsippeers');
+        $data = parent::_get($url);
+        $response = $data['AssociatedSipPeers']['AssociatedSipPeer'];
+        if (array_values($response) == $response) {
+            return $response;
+        } else {
+            return [$response];
+        }
+    }
 }
diff --git a/tests/AccountTest.php b/tests/AccountTest.php
@@ -57,6 +57,14 @@ public static function setUpBeforeClass() {
             new Response(200, [], "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><EmergencyNotificationRecipientsResponse>    <Links>        <first> -- link to first page of results -- </first>        <next> -- link to next page of results -- </next>    </Links>    <EmergencyNotificationRecipients>        <EmergencyNotificationRecipient>            <Identifier> 63865500-0904-46b1-9b4f-7bd237a26363 </Identifier>            <CreatedDate>2020-03-18T21:26:47.403Z</CreatedDate>            <LastModifiedDate>2020-03-18T21:26:47.403Z</LastModifiedDate>            <ModifiedByUser>jgilmore</ModifiedByUser>            <Description> This is a description of the emergency notification recipient. </Description>            <Type>CALLBACK</Type>            <Callback>                <Url>https://foo.bar/baz</Url>                <Credentials>                    <Username>jgilmore</Username>                </Credentials>            </Callback>        </EmergencyNotificationRecipient>        <EmergencyNotificationRecipient>            <Identifier> 63865500-0904-46b1-9b4f-7bd237a26363 </Identifier>            <CreatedDate>2020-03-22T12:13:25.782Z</CreatedDate>            <LastModifiedDate>2020-03-22T12:13:25.782Z</LastModifiedDate>            <ModifiedByUser>gfranklin</ModifiedByUser>            <Description> This is a description of the emergency notification recipient. </Description>            <Type>EMAIL</Type>            <EmailAddress>fred@gmail.com</EmailAddress>        </EmergencyNotificationRecipient>        <EmergencyNotificationRecipient>            <Identifier> 63865500-0904-46b1-9b4f-7bd237a26363 </Identifier>            <CreatedDate>2020-03-25T17:04:53.042Z</CreatedDate>            <LastModifiedDate>2020-03-25T17:04:53.042Z</LastModifiedDate>            <ModifiedByUser>msimpson</ModifiedByUser>            <Description> This is a description of the emergency notification recipient. </Description>            <Type>SMS</Type>            <Sms>                <TelephoneNumber>12015551212</TelephoneNumber>            </Sms>        </EmergencyNotificationRecipient>        <EmergencyNotificationRecipient>            <Identifier> 63865500-0904-46b1-9b4f-7bd237a26363 </Identifier>            <CreatedDate>2020-03-29T20:14:01.736Z</CreatedDate>            <LastModifiedDate>2020-03-29T20:17:53.294Z</LastModifiedDate>            <ModifiedByUser>lsimpson</ModifiedByUser>            <Description> This is a description of the emergency notification recipient. </Description>            <Type>TTS</Type>            <Tts>                <TelephoneNumber>12015551212</TelephoneNumber>            </Tts>        </EmergencyNotificationRecipient>    </EmergencyNotificationRecipients></EmergencyNotificationRecipientsResponse>"),
             new Response(200, [], "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><EmergencyNotificationRecipientsResponse>    <EmergencyNotificationRecipient>        <Identifier> 63865500-0904-46b1-9b4f-7bd237a26363 </Identifier>        <CreatedDate>2020-03-18T21:26:47.403Z</CreatedDate>        <LastModifiedDate>2020-04-01T18:32:22.316Z</LastModifiedDate>        <ModifiedByUser>jgilmore</ModifiedByUser>        <Description> This is a description of the emergency notification recipient. </Description>        <Type>CALLBACK</Type>        <Callback>            <Url>https://foo.bar/baz</Url>            <Credentials>                <Username>jgilmore</Username>            </Credentials>        </Callback>    </EmergencyNotificationRecipient></EmergencyNotificationRecipientsResponse>"),
             new Response(200, [], "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><EmergencyNotificationRecipientsResponse>    <EmergencyNotificationRecipient>        <Identifier> 63865500-0904-46b1-9b4f-7bd237a26363 </Identifier>        <CreatedDate>2020-03-18T21:26:47.403Z</CreatedDate>        <LastModifiedDate>2020-04-01T18:32:22.316Z</LastModifiedDate>        <ModifiedByUser>jgilmore</ModifiedByUser>        <Description> This is a description of the emergency notification recipient. </Description>        <Type>CALLBACK</Type>        <Callback>            <Url>https://foo.bar/baz</Url>            <Credentials>                <Username>jgilmore</Username>            </Credentials>        </Callback>    </EmergencyNotificationRecipient></EmergencyNotificationRecipientsResponse>"),
+            new Response(200, [], "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><ApplicationProvisioningResponse>    <ApplicationList>        <Application>            <ApplicationId>2cfcb382-161c-46d4-8c67-87ca09a72c85</ApplicationId>            <ServiceType>Messaging-V2</ServiceType>            <AppName>app1</AppName>            <MsgCallbackUrl>http://a.com</MsgCallbackUrl>        </Application>        <Application>            <ApplicationId>0cb0112b-5998-4c81-999a-0d3fb5e3f8e2</ApplicationId>            <ServiceType>Voice-V2</ServiceType>            <AppName>app2</AppName>            <CallInitiatedCallbackUrl>http://b.com</CallInitiatedCallbackUrl>            <CallbackCreds>                <UserId>15jPWZmXdm</UserId>            </CallbackCreds>            <CallInitiatedFallbackUrl>https://fallback.com</CallInitiatedFallbackUrl>            <CallInitiatedFallbackMethod>POST</CallInitiatedFallbackMethod>            <CallInitiatedFallbackCreds>                <UserId>login2</UserId>            </CallInitiatedFallbackCreds>            <CallbackTimeout>20</CallbackTimeout>        </Application>    </ApplicationList></ApplicationProvisioningResponse>            "),
+            new Response(200, [], "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><ApplicationProvisioningResponse>    <ApplicationList>        <Application>            <ApplicationId>0cb0112b-5998-4c81-999a-0d3fb5e3f8e2</ApplicationId>            <ServiceType>Voice-V2</ServiceType>            <AppName>app2</AppName>            <CallInitiatedCallbackUrl>http://b.com</CallInitiatedCallbackUrl>            <CallbackCreds>                <UserId>15jPWZmXdm</UserId>            </CallbackCreds>            <CallInitiatedFallbackUrl>https://fallback.com</CallInitiatedFallbackUrl>            <CallInitiatedFallbackMethod>POST</CallInitiatedFallbackMethod>            <CallInitiatedFallbackCreds>                <UserId>login2</UserId>            </CallInitiatedFallbackCreds>            <CallbackTimeout>20</CallbackTimeout>        </Application>    </ApplicationList></ApplicationProvisioningResponse>            "),
+            new Response(200, [], "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><ApplicationProvisioningResponse>    <Application>        <ApplicationId>e5a9e103-097e-4ec4-87a0-50109fb7b4b1</ApplicationId>        <ServiceType>Messaging-V2</ServiceType>        <AppName>qMmmTT</AppName>        <MsgCallbackUrl>http://example.com</MsgCallbackUrl>        <CallbackCreds>            <UserId>15jPWZmXdm</UserId>        </CallbackCreds>    </Application></ApplicationProvisioningResponse>            "),
+            new Response(200, [], "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><ApplicationProvisioningResponse>    <Application>        <ApplicationId>d4d1b41d-4c05-47d0-838a-34e4f14e4e3e</ApplicationId>        <ServiceType>Messaging-V2</ServiceType>        <AppName>EBVICs</AppName>        <MsgCallbackUrl>http://example.com</MsgCallbackUrl>        <CallbackCreds>            <UserId>15jPWZmXdm</UserId>        </CallbackCreds>    </Application></ApplicationProvisioningResponse>            "),
+            new Response(200, [], "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><ApplicationProvisioningResponse>    <Application>        <ApplicationId>e5a9e103-097e-4ec4-87a0-50109fb7b4b1</ApplicationId>        <ServiceType>Voice-V2</ServiceType>        <AppName>EBVICs</AppName>        <CallInitiatedCallbackUrl>https://example2.com</CallInitiatedCallbackUrl>        <CallInitiatedMethod>GET</CallInitiatedMethod>        <CallStatusCallbackUrl>https://example3.com</CallStatusCallbackUrl>        <CallStatusMethod>GET</CallStatusMethod>    </Application></ApplicationProvisioningResponse>            "),
+            new Response(200, []),
+            new Response(200, [], "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><AssociatedSipPeersResponse>    <AssociatedSipPeers>        <AssociatedSipPeer>            <SiteId>482</SiteId>            <SiteName>site_e867f</SiteName>            <PeerId>500018</PeerId>            <PeerName>sippeer-e867f</PeerName>        </AssociatedSipPeer>        <AssociatedSipPeer>            <SiteId>483</SiteId>            <SiteName>site_e867d</SiteName>            <PeerId>500019</PeerId>            <PeerName>sippeer-e867d</PeerName>        </AssociatedSipPeer>    </AssociatedSipPeers></AssociatedSipPeersResponse>            "),
+            new Response(200, [], "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><AssociatedSipPeersResponse>    <AssociatedSipPeers>        <AssociatedSipPeer>            <SiteId>482</SiteId>            <SiteName>site_e867f</SiteName>            <PeerId>500018</PeerId>            <PeerName>sippeer-e867f</PeerName>        </AssociatedSipPeer>        </AssociatedSipPeers></AssociatedSipPeersResponse>            "),
         ]);
 
         self::$container = [];
@@ -469,4 +477,85 @@ public function testReplaceEmergencyNotificationRecipient() {
 
         self::$index++;
     }
+
+    public function testGetApplications() {
+        $response = self::$account->getApplications();
+        
+        $this->assertEquals("GET", self::$container[self::$index]['request']->getMethod());
+        $this->assertEquals("https://api.test.inetwork.com/v1.0/accounts/9500249/applications", (string) self::$container[self::$index]['request']->getUri());
+        $this->assertEquals("0cb0112b-5998-4c81-999a-0d3fb5e3f8e2", $response[1]['ApplicationId']);
+
+        self::$index++;
+    }
+
+    public function testGetApplicationsOneResponse() {
+        $response = self::$account->getApplications();
+        
+        $this->assertEquals("GET", self::$container[self::$index]['request']->getMethod());
+        $this->assertEquals("https://api.test.inetwork.com/v1.0/accounts/9500249/applications", (string) self::$container[self::$index]['request']->getUri());
+        $this->assertEquals("0cb0112b-5998-4c81-999a-0d3fb5e3f8e2", $response[0]['ApplicationId']);
+
+        self::$index++;
+    }
+
+    public function testGetApplication() {
+        $response = self::$account->getApplication("123");
+        
+        $this->assertEquals("GET", self::$container[self::$index]['request']->getMethod());
+        $this->assertEquals("https://api.test.inetwork.com/v1.0/accounts/9500249/applications/123", (string) self::$container[self::$index]['request']->getUri());
+        $this->assertEquals("e5a9e103-097e-4ec4-87a0-50109fb7b4b1", $response['ApplicationId']);
+
+        self::$index++;
+    }
+
+    public function testCreateApplication() {
+        $data = array();
+        $response = self::$account->createApplication($data);
+        
+        $this->assertEquals("POST", self::$container[self::$index]['request']->getMethod());
+        $this->assertEquals("https://api.test.inetwork.com/v1.0/accounts/9500249/applications", (string) self::$container[self::$index]['request']->getUri());
+        $this->assertEquals("d4d1b41d-4c05-47d0-838a-34e4f14e4e3e", $response['ApplicationId']);
+
+        self::$index++;
+    }
+
+    public function testUpdateApplication() {
+        $data = array();
+        $response = self::$account->updateApplication("123", $data);
+        
+        $this->assertEquals("PUT", self::$container[self::$index]['request']->getMethod());
+        $this->assertEquals("https://api.test.inetwork.com/v1.0/accounts/9500249/applications/123", (string) self::$container[self::$index]['request']->getUri());
+        $this->assertEquals("e5a9e103-097e-4ec4-87a0-50109fb7b4b1", $response['ApplicationId']);
+
+        self::$index++;
+    }
+
+    public function testDeleteApplication() {
+        self::$account->deleteApplication("123");
+        
+        $this->assertEquals("DELETE", self::$container[self::$index]['request']->getMethod());
+        $this->assertEquals("https://api.test.inetwork.com/v1.0/accounts/9500249/applications/123", (string) self::$container[self::$index]['request']->getUri());
+
+        self::$index++;
+    }
+
+    public function testGetApplicationSippeers() {
+        $response = self::$account->getApplicationSippeers("123");
+
+        $this->assertEquals('site_e867f', $response[0]['SiteName']);
+        $this->assertEquals("GET", self::$container[self::$index]['request']->getMethod());
+        $this->assertEquals("https://api.test.inetwork.com/v1.0/accounts/9500249/applications/123/associatedsippeers", (string) self::$container[self::$index]['request']->getUri());
+
+        self::$index++;
+    }
+
+    public function testGetApplicationSippeersOneResponse() {
+        $response = self::$account->getApplicationSippeers("123");
+
+        $this->assertEquals('site_e867f', $response[0]['SiteName']);
+        $this->assertEquals("GET", self::$container[self::$index]['request']->getMethod());
+        $this->assertEquals("https://api.test.inetwork.com/v1.0/accounts/9500249/applications/123/associatedsippeers", (string) self::$container[self::$index]['request']->getUri());
+
+        self::$index++;
+    }
 }
