ruby-bandwidth-iris 3.0.0.pre → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db4758fe28b5dcf53dcd12d522a9651035201dd476ddb18a33d673196d8c2caf
-  data.tar.gz: '0285dd547fec9376e78974da0459869bb74860a2d4fef43f9d768994136e3a4e'
+  metadata.gz: 38c4a5c4376a7f3d8ae7cd6be021bb6eba4aa4d96b58b8261070d33e4a40c6c3
+  data.tar.gz: 5d4eadf2dfe738a20d375fb2ca0a28a6d68f7af0f596324c15635e8e3981bfec
 SHA512:
-  metadata.gz: 3e91ce595f504a53cffecba1af770bba9ecd43849c9a5b9564f64d041d00c2352d86f405097d520cd56a672394c4f800972fa9fcfd75b06a46bcb59fba897588
-  data.tar.gz: 0dda080c2137fc733e5f1c338a2de61807cc569fe4ef474e7bcc1910b03437ddc81e35a39f95149d47425e2249c48d0a0de41179bb89585f245aff4c43dc1830
+  metadata.gz: eef3948e858359ecfcd5242d847ce337b1c56c697c989d4d6364553fe4c533c8729826e8879d3dac70ba51a9cce282f39a1861265adaa7c3faa05f28dcb609da
+  data.tar.gz: 1e747a0019511bdd0c6eebb2b2366d40819cce1a17caff39d1bf73abe3c1928e00cfe4690c5cb088c84386153b255068b36e27575a654ab9dcaa0c97b08a06e8

data/.gitignore

@@ -10,3 +10,4 @@ coverage
 *.swo
 .yardoc
 examples/config.yml
+.idea/*

data/README.md

@@ -13,7 +13,13 @@ Ruby Client library for IRIS / BBS API
 | 2.0.1 | Updated gem dependencies to be less restrictive |
 | 2.1.0 | Added `csrs` endpoints |
 | 2.2.0 | Added `loas` endpoints to `importTnOrders` |
-| 3.0.0.pre | Removed functionality that causes an error to be raised when some type of `error` field is returned in the XML body response. This change reduces the situations that cause an error to be thrown to simply be 4XX and 5XX http responses. This change was made to improve communication when an error is found. Please update your code to handle this change. |
+| 2.2.0           | Added `loas` endpoints to `importTnOrders`                                                                                                                                                                                                                  |
+| 2.3.0           | Added `get_tns_by_order_id` to the Orders class                                                                                                                                                                                                             |
+| 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 |
+| 3.0.0 | Removed functionality that causes an error to be raised when some type of `error` field is returned in the XML body response. This change reduces the situations that cause an error to be thrown to simply be 4XX and 5XX http responses. This change was made to improve communication when an error is found. Please update your code to handle this change. |
 
 ### 3.x.x release
 
@@ -101,6 +107,7 @@ When fetching objects from the API, it will always return an object that has the
 instantiated so that you can call dependent methods as well as update, delete.
 
 Example:
+
 ```ruby
 site = BandwidthIris::Site.create({siteObject})
 
@@ -335,6 +342,16 @@ BandwidthIris::Order.create(order_data)
 ```ruby
 order = BandwidthIris::Order.get("order_id")
 ```
+
+### Get Order Response
+
+The order response object contains more details returned in the `GET` `/orders/order-id` API.
+
+```ruby
+order = BandwidthIris::Order.get_order_response(client, "101")
+completed_number = order.completed_numbers[:telephone_number][:full_number]
+```
+
 ### List Orders
 ```ruby
 BandwidthIris::Order.list(query)
@@ -356,6 +373,8 @@ order.get_totals()
 
 // get all Tns for an order
 order.get_tns()
+##Use the below method to grab TNs via an already existing Order ID##
+BandwidthIris::Order.get_tns_by_order_id("id")
 
 // get order history
 order.get_history()
@@ -485,7 +504,7 @@ sipPeer.delete()
 ### SipPeer TN Methods
 ```ruby
 # get TN for this peer
-sipPeer.get_tns(number)  
+sipPeer.get_tns(number)
 
 # get all TNs for this peer
 sipPeer.get_tns()
@@ -555,7 +574,7 @@ site.create_sip_peer(sipPeer)
 ```ruby
 subscription = {
   :order_type => "orders",
-  :callback_subcription => {
+  :callback_subscription => {
     :URL => "http://mycallbackurl.com",
     :user => "userid",
     :expiry => 12000
@@ -610,7 +629,7 @@ tn.get_rate_center()
 
 ### Create TN Reservation
 ```ruby
-BandwidthIris::TnReservation.create({:reserved_tn => "9195551212"})
+BandwidthIris::TnReservation.create("9195551212")
 ```
 
 ### Get TN Reservation
@@ -778,7 +797,7 @@ puts response[0][:file_name]
 ```ruby
 metadata = {
     :document_name => "file_name",
-    :document_type => "LOA"    
+    :document_type => "LOA"
 }
 BandwidthIris::ImportTnOrders.update_loa_file_metadata("order_id", "file_id", metadata)
 ```
@@ -849,3 +868,489 @@ note_data = {
 
 BandwidthIris::Csr.update_note("csr_id", "note_id", note_data)
 ```
+
+## Application Management
+
+### Create Application
+
+```ruby
+data = {
+  :service_type => "Messaging-V2",
+  :app_name => "Name",
+  :msg_callback_url => "https://test.com"
+}
+application = BandwidthIris::Applications.create_application(data)
+puts application
+```
+
+### Get Applications
+
+```ruby
+applications = BandwidthIris::Applications.get_applications()
+puts applications[0]
+```
+
+### Get An Application
+
+```ruby
+application = BandwidthIris::Applications.get_application("id")
+puts application
+```
+
+### Partially Update An Application
+
+```ruby
+data = {
+  :app_name => "Name2"
+}
+application = BandwidthIris::Applications.partial_update_application("id", data)
+puts application
+```
+
+### Completely Update An Application
+
+```ruby
+data = {
+  :service_type => "Messaging-V2",
+  :app_name => "Name2",
+  :msg_callback_url => "https://test2.com"
+}
+application = BandwidthIris::Applications.complete_update_application("id", data)
+puts application
+```
+
+### Remove An Application
+
+```ruby
+BandwidthIris::Applications.delete_application("id")
+```
+
+### List Application Sippeers
+
+```ruby
+sippeers = BandwidthIris::Applications.get_application_sippeers("id")
+puts sippeers[0]
+```
+
+## SipPeer Products
+
+### Get Origination Settings
+
+```ruby
+puts BandwidthIris::SipPeerProducts.get_origination_settings("site_id", "sippeer_id")
+```
+
+### Create Origination Settings
+
+```ruby
+data = {
+  :voice_protocol => "HTTP"
+}
+puts BandwidthIris::SipPeerProducts.create_origination_settings("site_id", "sippeer_id", data)
+```
+
+### Update Origination Settings
+
+```ruby
+data = {
+  :voice_protocol => "HTTP"
+}
+BandwidthIris::SipPeerProducts.update_origination_settings("site_id", "sippeer_id", data)
+```
+
+### Get Termination Settings
+
+```ruby
+puts BandwidthIris::SipPeerProducts.get_termination_settings("site_id", "sippeer_id")
+```
+
+### Create Termination Settings
+
+```ruby
+data = {
+  :voice_protocol => "HTTP"
+}
+puts BandwidthIris::SipPeerProducts.create_termination_settings("site_id", "sippeer_id", data)
+```
+
+### Update Termination Settings
+
+```ruby
+data = {
+  :voice_protocol => "HTTP"
+}
+BandwidthIris::SipPeerProducts.update_termination_settings("site_id", "sippeer_id", data)
+```
+
+### Get Sms Feature Settings
+
+```ruby
+puts BandwidthIris::SipPeerProducts.get_sms_feature_settings("site_id", "sippeer_id")
+```
+
+### Create Sms Feature Settings
+
+```ruby
+data = {
+  :sip_peer_sms_feature_settings => {
+    :toll_free => true,
+    :protocol => "HTTP",
+    :zone_1 => true,
+    :zone_2 => false,
+    :zone_3 => false,
+    :zone_4 => false,
+    :zone_5 => false
+  },
+  :http_settings => {}
+}
+
+puts BandwidthIris::SipPeerProducts.create_sms_feature_settings("site_id", "sippeer_id", data)
+```
+
+### Update Sms Feature Settings
+
+```ruby
+data = {
+  :sip_peer_sms_feature_settings => {
+    :toll_free => true,
+    :protocol => "HTTP",
+    :zone_1 => true,
+    :zone_2 => false,
+    :zone_3 => false,
+    :zone_4 => false,
+    :zone_5 => false
+  },
+  :http_settings => {}
+}
+
+puts BandwidthIris::SipPeerProducts.update_sms_feature_settings("site_id", "sippeer_id", data)
+```
+
+### Delete Sms Feature Settings
+
+```ruby
+BandwidthIris::SipPeerProducts.delete_sms_feature_settings("site_id", "sippeer_id")
+```
+
+### Get Mms Feature Settings
+
+```ruby
+puts BandwidthIris::SipPeerProducts.get_mms_feature_settings("site_id", "sippeer_id")
+```
+
+### Create Mms Feature Settings
+
+```ruby
+data = {
+  :mms_settings => {
+    :protocol => "HTTP"
+  },
+  :protocols => {
+    :HTTP => {
+      :http_settings => {}
+    }
+  }
+}
+
+puts BandwidthIris::SipPeerProducts.create_mms_feature_settings("site_id", "sippeer_id", data)
+```
+
+### Update Mms Feature Settings
+
+```ruby
+data = {
+  :mms_settings => {
+    :protocol => "HTTP"
+  },
+  :protocols => {
+    :HTTP => {
+      :http_settings => {}
+    }
+  }
+}
+
+BandwidthIris::SipPeerProducts.update_mms_feature_settings("site_id", "sippeer_id", data)
+```
+
+### Delete Mms Feature Settings
+
+```ruby
+BandwidthIris::SipPeerProducts.delete_mms_feature_settings("site_id", "sippeer_id")
+```
+
+### Get Mms Feature Mms Settings
+
+```ruby
+puts BandwidthIris::SipPeerProducts.get_mms_feature_mms_settings("site_id", "sippeer_id")
+```
+
+### Get Messaging Application Settings
+
+```ruby
+puts BandwidthIris::SipPeerProducts.get_messaging_application_settings("site_id", "sippeer_id")
+```
+
+### Update Messaging Application Settings
+
+```ruby
+data = {
+  :http_messaging_v2_app_id => "4-d-4-8-5"
+}
+
+puts BandwidthIris::SipPeerProducts.update_messaging_application_settings("site_id", "sippeer_id", data)
+```
+
+### Get Messaging Settings
+
+```ruby
+puts BandwidthIris::SipPeerProducts.get_messaging_settings("site_id", "sippeer_id")
+```
+
+### Update Messaging Settings
+
+```ruby
+data = {
+  :break_out_countries => {
+    :country => "CAN"
+  }
+}
+
+puts BandwidthIris::SipPeerProducts.update_messaging_settings("site_id", "sippeer_id", data)
+```
+
+## Emergency Notification Recipients
+
+### Create Emergency Notification Recipient
+
+```ruby
+data = {
+  :description => "Email to Bldg. 3 Front Desk",
+  :type => "EMAIL",
+  :email_address => "foo@bar.com"
+}
+
+enr = BandwidthIris::EmergencyNotificationRecipients.create_emergency_notification_recipient(data)
+puts enr
+```
+### Get Emergency Notification Recipients
+
+```ruby
+enrs = BandwidthIris::EmergencyNotificationRecipients.get_emergency_notification_recipients()
+puts enrs
+```
+
+### Get Emergency Notification Recipient
+
+```ruby
+enr = BandwidthIris::EmergencyNotificationRecipients.get_emergency_notification_recipient("id")
+puts enr
+```
+
+### Replace Emergency Notification Recipient
+
+```ruby
+data = {
+  :description => "Email to Bldg. 3 Front Desk",
+  :type => "EMAIL",
+  :email_address => "foo@bar.com"
+}
+
+enr = BandwidthIris::EmergencyNotificationRecipients.replace_emergency_notification_recipient("id", data)
+puts enr
+```
+
+### Delete Emergency Notification Recipient
+
+```ruby
+BandwidthIris::EmergencyNotificationRecipients.delete_emergency_notification_recipient("id")
+```
+
+## Emergeny Notification Group
+
+### Create Emergency Notification Group Order
+
+```ruby
+data = {
+  :customer_order_id => "value",
+  :added_emergency_notification_group => {
+    :description => "description",
+    :added_emergency_notification_recipients => {
+      :emergency_notification_recipient => [
+        {
+          :identifier => "123"
+        }
+      ]
+    }
+  }
+}
+
+order = BandwidthIris::EmergencyNotificationGroups.create_emergency_notification_group_order(data)
+puts order
+```
+
+### Get Emergency Notification Group Orders
+
+```ruby
+orders = BandwidthIris::EmergencyNotificationGroups.get_emergency_notification_group_orders()
+puts orders
+```
+
+### Get Emergency Notification Group Order
+
+```ruby
+order = BandwidthIris::EmergencyNotificationGroups.get_emergency_notification_group_order("id")
+puts order
+```
+
+### Get Emergency Notification Groups
+
+```ruby
+groups = BandwidthIris::EmergencyNotificationGroups.get_emergency_notification_groups()
+puts groups
+```
+
+### Get Emergency Notification Group
+
+```ruby
+group = BandwidthIris::EmergencyNotificationGroups.get_emergency_notification_group("id")
+puts group
+```
+
+## Emergency Notification Endpoint
+
+### Create Emergency Notification Endpoint Order
+
+```ruby
+data = {
+  :customer_order_id => "123",
+  :emergency_notification_endpoint_associations => {
+    :emergency_notification_group => {
+      :identifier => "456"
+    }
+  }
+}
+
+order = BandwidthIris::EmergencyNotificationEndpoints.create_emergency_notification_endpoint_order(data)
+puts order
+```
+
+### Get Emergency Notification Endpoint Orders
+
+```ruby
+orders = BandwidthIris::EmergencyNotificationEndpoints.get_emergency_notification_endpoint_orders()
+puts orders
+```
+
+### Get Emergency Notification Endpoint Order
+
+```ruby
+order = BandwidthIris::EmergencyNotificationEndpoints.get_emergency_notification_endpoint_order("id")
+puts order
+```
+
+## Alternate End User Identiy
+
+### Get Alternate End User Information
+
+```ruby
+aeuis = BandwidthIris::AlternateEndUserIdentity.get_alternate_end_user_information()
+puts aeuis
+```
+
+### Get Alternate Caller Information
+
+```ruby
+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
+```