ruby-bandwidth-iris 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd0a2a83930a907b646fd60cd8a9022a112f57639316cfb5f72f8779620dd8cb
-  data.tar.gz: 7ec3e412315f790aa7dfc91fec9bed550d9df9c1b782ef4dbfa60ab54348dada
+  metadata.gz: fbe7fbc5dcefe17806397fdf31f547dca15ca31abe404cfd89916531885ca901
+  data.tar.gz: 21618c8c74f583fab7e9ddb7c5d6d689128fbcfc853d450e215972deca18e9f3
 SHA512:
-  metadata.gz: 8de965b470519e1855a25aaeaa212725e95c12e798805858f2a1d2256f3d666bd225b477a6e900f4c01c3037e18cf245d256cae41bb5b5cea095797750f41697
-  data.tar.gz: f581771fb98683cc909c7feef6dc598e6d427d8dbfd5f38a87798507406a0b5fcd5fcc81664cbc09d1d0d6b848bc15c1501bc6ca8a305bdbfbd32992f2a9423b
+  metadata.gz: 1df9daf8667a8b098a0fb4fff416d9b3529364f9d7eee08c342297c2489142bc465f5efbac7d8f0e1d386c04c7e742073aeed8601314e7e1a412f8d25f3ce681
+  data.tar.gz: 2c2359325581abc5d177334bf3e5f463973f1e2055fb3b433c8150f474fb024164b427843478910c6a019cf4d93ebfd2664b89794be647441b811d6c71fc965c

data/README.md

@@ -17,6 +17,7 @@ Ruby Client library for IRIS / BBS API
 | 2.4.0.pre       | Added application management and sippeer products endpoints                                                                                                                                                                                                 |
 | 2.5.0           | Added `get_order_response` to pull full `<OrderResponse>` object from API, added `id` back to order object on get requests. Fixed TN Reservation and updated tests to match reality  |
 | 2.6.0 | Added Emergency Calling Notification, Emergeny Notification Group, Emergency Notification Endpoint, and Alternate End User Identity methods |
+| 2.7.0 | Added TNOptions endpoints |
 
 ## Install
 
@@ -1236,3 +1237,94 @@ puts aeuis
 aeui = AlternateEndUserIdentity.get_alternate_caller_information("id")
 puts aeui
 ```
+
+## TN Option Orders
+
+### Get TN Option Orders
+
+```ruby
+orders = BandwidthIris::TnOptions.get_tn_option_orders()
+puts orders
+```
+
+### Get TN Option Order
+
+```ruby
+order = BandwidthIris::TnOptions.get_tn_option_order("order_id")
+puts order
+```
+
+### Get TN Option Order (error)
+
+```ruby
+begin
+  order = BandwidthIris::TnOptions.get_tn_option_order("error_id")
+rescue BandwidthIris::Errors::GenericError => e
+  puts e
+end
+```
+
+### Create PortOut Passcode
+
+```ruby
+data = {
+  :customer_order_id => "custom order",
+  :tn_option_groups => {
+    :tn_option_group => [
+      {
+        :port_out_passcode => "12abd38",
+        :telephone_numbers => {
+          :telephone_number => ["2018551020"]
+        }
+      }
+    ]
+  }
+}
+
+
+order = BandwidthIris::TnOptions.create_tn_option_order(data)
+puts order
+```
+
+### Create Call Forward Number
+
+```ruby
+data = {
+  :customer_order_id => "custom order",
+  :tn_option_groups => {
+    :tn_option_group => [
+      {
+        :call_forward => "2018551022",
+        :telephone_numbers => {
+          :telephone_number => ["2018551020"]
+        }
+      }
+    ]
+  }
+}
+
+
+order = BandwidthIris::TnOptions.create_tn_option_order(data)
+puts order
+```
+### Enable SMS
+
+```ruby
+data = {
+  :customer_order_id => "custom order",
+  :tn_option_groups => {
+    :tn_option_group => [
+      {
+        :sms => "on",
+        :telephone_numbers => {
+          :telephone_number => ["2018551020"]
+        }
+      }
+    ]
+  }
+}
+
+
+order = BandwidthIris::TnOptions.create_tn_option_order(data)
+puts order
+```

data/lib/bandwidth-iris/client.rb

@@ -32,6 +32,7 @@ module BandwidthIris
           faraday.basic_auth(user_name, password)
           #faraday.response :logger
           faraday.headers['Accept'] = 'application/xml'
+          faraday.headers['user-agent'] = 'Ruby-Bandwidth-Iris'
           faraday.use FaradayMiddleware::FollowRedirects
           @set_adapter.call(faraday)
         }

data/lib/bandwidth-iris/tn_options.rb

@@ -0,0 +1,26 @@
+module BandwidthIris
+  TN_OPTIONS_PATH = 'tnoptions'
+
+  class TnOptions
+    extend ClientWrapper
+    include ApiItem
+
+    def self.get_tn_option_orders(client, query = nil)
+        response = client.make_request(:get, "#{client.concat_account_path(TN_OPTIONS_PATH)}", query)
+        return response[0]
+    end
+    wrap_client_arg :get_tn_option_orders
+
+    def self.create_tn_option_order(client, data)
+        response = client.make_request(:post, "#{client.concat_account_path(TN_OPTIONS_PATH)}", {:tn_option_order => data})
+        return response[0][:tn_option_order]
+    end
+    wrap_client_arg :create_tn_option_order
+
+    def self.get_tn_option_order(client, order_id)
+        response = client.make_request(:get, "#{client.concat_account_path(TN_OPTIONS_PATH)}/#{order_id}")
+        return response[0]
+    end
+    wrap_client_arg :get_tn_option_order
+  end
+end

data/lib/bandwidth-iris/version.rb

@@ -1,4 +1,4 @@
 module BandwidthIris
   # Version of this gem
-  VERSION = "2.6.0"
+  VERSION = "2.7.0"
 end

data/lib/ruby-bandwidth-iris.rb

@@ -36,5 +36,6 @@ require 'bandwidth-iris/emergency_notification_endpoints'
 require 'bandwidth-iris/emergency_notification_groups'
 require 'bandwidth-iris/emergency_notification_recipients'
 require 'bandwidth-iris/aeui'
+require 'bandwidth-iris/tn_options'
 
 require 'bandwidth-iris/version'

data/spec/bandwidth-iris/tn_options_spec.rb

@@ -0,0 +1,42 @@
+describe BandwidthIris::TnOptions do
+  client = nil
+
+  before :each do
+    client = Helper.get_client()
+  end
+
+  after :each do
+    client.stubs.verify_stubbed_calls()
+  end
+
+  describe "#tnOptionOrders" do
+    it "should get tn option orders" do
+      client.stubs.get("/v1.0/accounts/accountId/tnoptions"){|env| [200, {}, Helper.xml['tnOptionOrders']]}
+      orders = TnOptions.get_tn_option_orders(client)
+      expect(orders[:tn_option_order_summary][0][:account_id]).to eql(14)
+    end
+
+    it "should create tn option order" do
+      data = {
+        :customer_order_id => "12345",
+        :tn_option_groups => {
+          :tn_option_group => [
+            {
+              :number_format => "10digit",
+              :RPIDFormat => "10digit"
+            }
+          ]
+        }
+      }
+      client.stubs.post("/v1.0/accounts/accountId/tnoptions", client.build_xml({:tn_option_order => data})){|env| [200, {}, Helper.xml['tnOptionOrderResponse']]}
+      order = TnOptions.create_tn_option_order(client, data)
+      expect(order[:account_id]).to eql(14)
+    end
+
+    it "should get tn option order" do
+      client.stubs.get("/v1.0/accounts/accountId/tnoptions/id"){|env| [200, {}, Helper.xml['tnOptionOrder']]}
+      order = TnOptions.get_tn_option_order(client, "id")
+      expect(order[:account_id]).to eql(14)
+    end
+  end
+end

data/spec/xml.yml

@@ -69,3 +69,6 @@
   emergencyNotificationRecipient: '<?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-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></EmergencyNotificationRecipientsResponse>'
   aeuis: '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><AlternateEndUserIdentifiersResponse>    <TotalCount>2</TotalCount>    <Links>        <first>Link=&lt;http://localhost:8080/iris/accounts/14/aeuis?page=1&amp;size=500&gt;;rel="first";</first>    </Links>    <AlternateEndUserIdentifiers>        <AlternateEndUserIdentifier>            <Identifier>DavidAcid</Identifier>            <CallbackNumber>8042105760</CallbackNumber>            <EmergencyNotificationGroup>                <Identifier>63865500-0904-46b1-9b4f-7bd237a26363</Identifier>                <Description>Building 5, 5th Floor.</Description>            </EmergencyNotificationGroup>        </AlternateEndUserIdentifier>        <AlternateEndUserIdentifier>            <Identifier>JohnAcid</Identifier>            <CallbackNumber>8042105618</CallbackNumber>        </AlternateEndUserIdentifier>    </AlternateEndUserIdentifiers></AlternateEndUserIdentifiersResponse>'
   aeui: '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><AlternateEndUserIdentifierResponse><AlternateEndUserIdentifier>        <Identifier>DavidAcid</Identifier>        <CallbackNumber>8042105760</CallbackNumber>        <E911>            <CallerName>David</CallerName>            <Address>                <HouseNumber>900</HouseNumber>                <HouseSuffix></HouseSuffix>                <PreDirectional></PreDirectional>                <StreetName>MAIN CAMPUS</StreetName>                <StreetSuffix>DR</StreetSuffix>                <AddressLine2></AddressLine2>                <City>RALEIGH</City>                <StateCode>NC</StateCode>                <Zip>27606</Zip>                <PlusFour>5214</PlusFour>                <Country>United States</Country>                <AddressType>Billing</AddressType>            </Address>            <EmergencyNotificationGroup>                <Identifier>63865500-0904-46b1-9b4f-7bd237a26363</Identifier>                <Description>Building 5, 5th Floor.</Description>            </EmergencyNotificationGroup>        </E911>    </AlternateEndUserIdentifier></AlternateEndUserIdentifierResponse>'
+  tnOptionOrder: '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><TnOptionOrder> <OrderCreateDate>2016-01-15T11:22:58.789Z</OrderCreateDate> <AccountId>14</AccountId> <CreatedByUser>jbm</CreatedByUser> <OrderId>409033ee-88ec-43e3-85f3-538f30733963</OrderId> <LastModifiedDate>2016-01-15T11:22:58.969Z</LastModifiedDate> <ProcessingStatus>COMPLETE</ProcessingStatus> <TnOptionGroups> <TnOptionGroup> <CallingNameDisplay>on</CallingNameDisplay> <Sms>on</Sms> <TelephoneNumbers> <TelephoneNumber>2174101601</TelephoneNumber> </TelephoneNumbers> </TnOptionGroup> <TnOptionGroup> <CallingNameDisplay>off</CallingNameDisplay> <TelephoneNumbers> <TelephoneNumber>2174101602</TelephoneNumber> </TelephoneNumbers> </TnOptionGroup> <TnOptionGroup> <CallingNameDisplay>systemdefault</CallingNameDisplay> <FinalDestinationURI>sip:+12345678901@1.2.3.4:5060</FinalDestinationURI> <TelephoneNumbers> <TelephoneNumber>2174101603</TelephoneNumber> </TelephoneNumbers> </TnOptionGroup> </TnOptionGroups> <ErrorList/> <Warnings> <Warning> <TelephoneNumber>2174101601</TelephoneNumber> <Description>SMS is already Enabled or number is in processing.</Description> </Warning> </Warnings></TnOptionOrder>'
+  tnOptionOrderResponse: '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><TnOptionOrderResponse> <TnOptionOrder> <OrderCreateDate>2016-01-15T12:01:14.324Z</OrderCreateDate> <AccountId>14</AccountId> <CreatedByUser>jbm</CreatedByUser> <OrderId>ddbdc72e-dc27-490c-904e-d0c11291b095</OrderId> <LastModifiedDate>2016-01-15T12:01:14.324Z</LastModifiedDate> <ProcessingStatus>RECEIVED</ProcessingStatus> <TnOptionGroups> <TnOptionGroup> <NumberFormat>10digit</NumberFormat> <RPIDFormat>10digit</RPIDFormat> <RewriteUser>testUser1</RewriteUser> <CallForward>6042661720</CallForward> <CallingNameDisplay>on</CallingNameDisplay> <Protected>true</Protected> <Sms>on</Sms> <TelephoneNumbers> <TelephoneNumber>2018551020</TelephoneNumber> </TelephoneNumbers> </TnOptionGroup> <TnOptionGroup> <CallingNameDisplay>off</CallingNameDisplay> <Protected>false</Protected> <Sms>off</Sms> <TelephoneNumbers> <TelephoneNumber>2018551025</TelephoneNumber> </TelephoneNumbers> </TnOptionGroup> </TnOptionGroups> <ErrorList/> </TnOptionOrder></TnOptionOrderResponse>'
+  tnOptionOrders: '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><TnOptionOrders> <TotalCount>2</TotalCount> <TnOptionOrderSummary> <accountId>14</accountId> <CountOfTNs>2</CountOfTNs> <userId>jbm</userId> <lastModifiedDate>2016-01-15T12:01:14.363Z</lastModifiedDate> <OrderDate>2016-01-15T12:01:14.324Z</OrderDate> <OrderType>tn_option</OrderType> <OrderStatus>FAILED</OrderStatus> <OrderId>ddbdc72e-dc27-490c-904e-d0c11291b095</OrderId> </TnOptionOrderSummary> <TnOptionOrderSummary> <accountId>14</accountId> <CountOfTNs>3</CountOfTNs> <userId>jbm</userId> <lastModifiedDate>2016-01-15T11:22:58.969Z</lastModifiedDate> <OrderDate>2016-01-15T11:22:58.789Z</OrderDate> <OrderType>tn_option</OrderType> <OrderStatus>COMPLETE</OrderStatus> <OrderId>409033ee-88ec-43e3-85f3-538f30733963</OrderId> </TnOptionOrderSummary></TnOptionOrders>'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-bandwidth-iris
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Andrey Belchikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -200,6 +200,7 @@ files:
 - lib/bandwidth-iris/site.rb
 - lib/bandwidth-iris/subscription.rb
 - lib/bandwidth-iris/tn.rb
+- lib/bandwidth-iris/tn_options.rb
 - lib/bandwidth-iris/tn_reservation.rb
 - lib/bandwidth-iris/user.rb
 - lib/bandwidth-iris/version.rb
@@ -236,6 +237,7 @@ files:
 - spec/bandwidth-iris/sip_peer_spec.rb
 - spec/bandwidth-iris/site_spec.rb
 - spec/bandwidth-iris/subscription_spec.rb
+- spec/bandwidth-iris/tn_options_spec.rb
 - spec/bandwidth-iris/tn_reservation_spec.rb
 - spec/bandwidth-iris/tn_spec.rb
 - spec/bandwidth-iris/user_spec.rb
@@ -296,6 +298,7 @@ test_files:
 - spec/bandwidth-iris/sip_peer_spec.rb
 - spec/bandwidth-iris/site_spec.rb
 - spec/bandwidth-iris/subscription_spec.rb
+- spec/bandwidth-iris/tn_options_spec.rb
 - spec/bandwidth-iris/tn_reservation_spec.rb
 - spec/bandwidth-iris/tn_spec.rb
 - spec/bandwidth-iris/user_spec.rb