ruby-bandwidth-iris 2.0.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c3d3a94981e3e3ec40dad3670799281a661d200e80614973326c4cb059a8adb
-  data.tar.gz: d986dd6e52fc04e7f1f648c3a9e45560326da65a5c91208c89f33d09b1eda811
+  metadata.gz: '08d149b50259af28149c7018f600fcbf22d694c15604b85073a38fa4255ebff7'
+  data.tar.gz: 0beef4622c48e6e119475e37644a16a09a4c74fb9cac935cf10ea82b7e55d377
 SHA512:
-  metadata.gz: 4b0429508a83ff431fc0b29708a78fd64e280650677d1421a08c30e9773224f82f2dc902205c75ceefc46df861104c5d665c0f385c5fdf70d4db79d3f74bb4c0
-  data.tar.gz: 93e9df992af04de3221534fda2c8dac0d74f0e6472322b05e75f8685a313734f9851f157d068bd6f69113d1ce3cc796c02d3efac8ab151f538e5fd16d2887385
+  metadata.gz: b8e8fc95953e9bb5ed6c00a24c5cccef35cea81a31c710c6560eb7c4b0b96a6c3a533cb365fbad0a2aea3a1ac854fb79318b49412d3e5a9125b5219d379e70f9
+  data.tar.gz: 308bdcbc9d7124297535b1656befc3da6fbe574fc878c90573000ae43867da64f05c7349bb4fd27621927393487d3d6ad09b35b8f97b01c252ef42fb0e0b01eb

data/.gitignore

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

data/README.md

@@ -6,11 +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 |
+| 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                                                                                                                                  |
+| 2.6.0           | Fixed TN Reservation and updated tests to match reality                                                                                                                                                                                                     |
 
 ## Install
 
@@ -74,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})
 
@@ -308,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)
@@ -329,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()
@@ -458,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()
@@ -583,7 +602,7 @@ tn.get_rate_center()
 
 ### Create TN Reservation
 ```ruby
-BandwidthIris::TnReservation.create({:reserved_tn => "9195551212"})
+BandwidthIris::TnReservation.create("9195551212")
 ```
 
 ### Get TN Reservation
@@ -603,6 +622,7 @@ tn.delete()
 import_tn_order = {
     :customer_order_id => "id",
     :site_id => "12345",
+    :sip_peer_id => "23456",
     :subscriber => {
         :service_address => {
             :city => "city",
@@ -694,3 +714,379 @@ remove_imported_tn_order = {
 response = BandwidthIris::RemoveImportedTnOrders.create_remove_imported_tn_order(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
+
+```ruby
+csr_data = {
+    :customer_order_id => "order id",
+    :working_or_billing_telephone_number => "5554443333"
+}
+
+response = BandwidthIris::Csr.create(csr_data)
+puts response[0][:order_id]
+```
+
+### Replace CSR Order
+
+```ruby
+csr_data = {
+    :customer_order_id => "order id",
+    :working_or_billing_telephone_number => "5554443333"
+}
+
+response = BandwidthIris::Csr.replace("csr_id", csr_data)
+puts response[0][:order_id]
+```
+
+### Get CSR Order
+
+```ruby
+response = BandwidthIris::Csr.get("csr_id")
+puts response[0][:order_id]
+```
+
+### Get CSR Order Notes
+
+```ruby
+response = BandwidthIris::Csr.get_notes("csr_id")
+puts response[0][:note][0][:id]
+```
+
+### Add CSR Order Note
+
+```ruby
+note_data = {
+    :user_id => "id",
+    :description => "description"
+}
+
+BandwidthIris::Csr.add_note("csr_id", note_data)
+```
+
+### Update CSR Order Note
+
+```ruby
+note_data = {
+    :user_id => "id",
+    :description => "description"
+}
+
+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)
+```