ruby-bandwidth-iris 2.1.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b1159ee27c2a2ee423bdd0ce54a1b0943749127da435a611eeb113dec178ad0
-  data.tar.gz: a7e09992b64e938a9dc1c3943ee8be92dc9d6b8a1ed9d3b722268879a35779bd
+  metadata.gz: fd0a2a83930a907b646fd60cd8a9022a112f57639316cfb5f72f8779620dd8cb
+  data.tar.gz: 7ec3e412315f790aa7dfc91fec9bed550d9df9c1b782ef4dbfa60ab54348dada
 SHA512:
-  metadata.gz: bc146c9252add1af25853dd70416d790ba9bb5ad8b74adb6f1575e95b754cd6dcf5d5875112060b643493fcc4b970df156c8d8072db1d054c8f68a6c49faaf87
-  data.tar.gz: 33db19d5c8f58b4632206a82333fd526b708726b8fbed3d71ba8efe6841708a19d29e66e2a9f1357f7a3caab668c2ff132422e34116e45bbdc33b3c7aee79516
+  metadata.gz: 8de965b470519e1855a25aaeaa212725e95c12e798805858f2a1d2256f3d666bd225b477a6e900f4c01c3037e18cf245d256cae41bb5b5cea095797750f41697
+  data.tar.gz: f581771fb98683cc909c7feef6dc598e6d427d8dbfd5f38a87798507406a0b5fcd5fcc81664cbc09d1d0d6b848bc15c1501bc6ca8a305bdbfbd32992f2a9423b

data/.gitignore

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

data/README.md

@@ -6,12 +6,17 @@ Ruby Client library for IRIS / BBS API
 
 ## Release Notes
 
-| Release Version | Notes |
-|--|--|
-| 1.0.5 | Fixed incorrect generation of XML for a Disconnect request |
-| 2.0.0 | Added `importTnOrders`, `removeImportedTnOrders`, `inserviceNumbers`, and `importTnChecker` endpoints. This release also changed the response body of `BandwidthIris::InServiceNumber.list()`. Please make sure to update your code to include this change. |
-| 2.0.1 | Updated gem dependencies to be less restrictive |
-| 2.1.0 | Added `csrs` endpoints |
+| Release Version | Notes                                                                                                                                                                                                                                                       |
+|:----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 1.0.5           | Fixed incorrect generation of XML for a Disconnect request                                                                                                                                                                                                  |
+| 2.0.0           | Added `importTnOrders`, `removeImportedTnOrders`, `inserviceNumbers`, and `importTnChecker` endpoints. This release also changed the response body of `BandwidthIris::InServiceNumber.list()`. Please make sure to update your code to include this change. |
+| 2.0.1           | Updated gem dependencies to be less restrictive                                                                                                                                                                                                             |
+| 2.1.0           | Added `csrs` endpoints                                                                                                                                                                                                                                      |
+| 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 |
 
 ## Install
 
@@ -75,6 +80,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})
 
@@ -309,6 +315,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)
@@ -330,6 +346,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()
@@ -459,7 +477,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()
@@ -529,7 +547,7 @@ site.create_sip_peer(sipPeer)
 ```ruby
 subscription = {
   :order_type => "orders",
-  :callback_subcription => {
+  :callback_subscription => {
     :URL => "http://mycallbackurl.com",
     :user => "userid",
     :expiry => 12000
@@ -584,7 +602,7 @@ tn.get_rate_center()
 
 ### Create TN Reservation
 ```ruby
-BandwidthIris::TnReservation.create({:reserved_tn => "9195551212"})
+BandwidthIris::TnReservation.create("9195551212")
 ```
 
 ### Get TN Reservation
@@ -604,6 +622,7 @@ tn.delete()
 import_tn_order = {
     :customer_order_id => "id",
     :site_id => "12345",
+    :sip_peer_id => "23456",
     :subscriber => {
         :service_address => {
             :city => "city",
@@ -696,6 +715,71 @@ response = BandwidthIris::RemoveImportedTnOrders.create_remove_imported_tn_order
 puts response
 ```
 
+### Get LOAs
+```ruby
+response = BandwidthIris::ImportTnOrders.get_loa_files("order_id")
+puts response[0][:result_message]
+puts response[0][:file_names] #this can be a single string (if there's 1 file) or an array of strings (if there's multiple files)
+```
+
+### Upload LOA
+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`
+
+```ruby
+BandwidthIris::ImportTnOrders.upload_loa_file("order_id", "binary_file_contents", "mime_type")
+```
+
+```ruby
+f = open("loa.pdf", "rb")
+file_content = f.read
+f.close()
+
+BandwidthIris::ImportTnOrders.upload_loa_file("order_id", file_content, "application/pdf")
+```
+
+### Download LOA
+Note: Make sure to grab the desired file ID from the response of `BandwidthIris::ImportTnOrders.get_loa_files("order_id")` in the field `response[0][:file_names]`
+
+```ruby
+f = open("write.pdf", "wb")
+response = BandwidthIris::ImportTnOrders.download_loa_file("order_id", "file_id")
+f.puts(response)
+f.close()
+```
+
+### Replace LOA
+```ruby
+BandwidthIris::ImportTnOrders.replace_loa_file("order_id", "file_id", "binary_file_contents", "mime_type")
+```
+
+### Delete LOA
+```ruby
+BandwidthIris::ImportTnOrders.delete_loa_file("order_id", "file_id")
+```
+
+### Get LOA Metadata
+```ruby
+response = BandwidthIris::ImportTnOrders.get_loa_file_metadata("order_id", "file_id")
+puts response[0][:document_name]
+puts response[0][:file_name]
+```
+
+### Update LOA Metadata
+```ruby
+metadata = {
+    :document_name => "file_name",
+    :document_type => "LOA"
+}
+BandwidthIris::ImportTnOrders.update_loa_file_metadata("order_id", "file_id", metadata)
+```
+
+### Delete LOA Metadata
+```ruby
+BandwidthIris::ImportTnOrders.delete_loa_file_metadata("order_id", "file_id")
+```
+
 ## CSR
 
 ### Create CSR Order
@@ -757,3 +841,398 @@ 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
+```