ruby-bandwidth-iris 2.0.1 → 2.5.0

data/examples/create_reservation_and_order.rb

@@ -0,0 +1,79 @@
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'ruby-bandwidth-iris'
+
+$bandwidth_account_id = ENV['BANDWIDTH_ACCOUNT_ID']
+$bandwidth_user_name = ENV['BANDWIDTH_API_USER']
+$bandwidth_password = ENV['BANDWIDTH_API_PASSWORD']
+## Fill these in
+$bandwidth_site_id = ENV['BANDWIDTH_SITE_ID']
+$bandwidth_to_sippeer_id = ENV['BANDWIDTH_SIPPEER_ID']
+
+
+def get_order_by_id(client, order_id:, attempts: 0)
+  begin
+    order_result = BandwidthIris::Order.get(client, order_id)
+    return order_result
+  rescue Exception => e
+    if attempts > 3
+      puts("Completely Failed fetching Order")
+      raise StandardError.new e
+    end
+    puts("Error Message: #{e.message}")
+    attempts = attempts+1
+    sleep(1)
+    return get_order_by_id(client, order_id: order_id, attempts: attempts)
+  end
+end
+
+def get_numbers_from_order_id(client, order_id:)
+  order = BandwidthIris::Order.new({:id => order_id}, client)
+  numbers_result = order.get_tns
+  return numbers_result
+end
+
+def order_numbers_with_reservation_id(client, reservation_id:, number:)
+  order_data = {
+      :name => "Reservation Test",
+      :site_id => $bandwidth_site_id,
+      :existing_telephone_number_order_type => {
+          :telephone_number_list => [
+              :telephone_number => number
+          ],
+          :reservation_id_list => [
+            :reservation_id => reservation_id
+          ]
+      }
+  }
+  order_result = BandwidthIris::Order.create(client, order_data)
+  return order_result
+end
+
+def reserve_numbers(client, number:)
+  reservation = BandwidthIris::TnReservation.create(client, number)
+  return reservation
+end
+
+def search_numbers(client, area_code: 919)
+  list = BandwidthIris::AvailableNumber.list(client, {:area_code => area_code, :quantity => 5})
+  return list
+end
+
+def main()
+  client = BandwidthIris::Client.new($bandwidth_account_id, $bandwidth_user_name, $bandwidth_password)
+  available_numbers = search_numbers(client)
+  number = available_numbers[0]
+  reservation = reserve_numbers(client, number: number)
+  reservation_id = reservation.id
+  order = order_numbers_with_reservation_id(client, reservation_id: reservation_id, number: number)
+  order_id = order.id
+  puts(order_id)
+  my_order = get_order_by_id(client, order_id: order_id)
+  my_numbers = get_numbers_from_order_id(client, order_id:order_id)
+  puts(my_numbers)
+end
+
+if __FILE__ == $0
+  main
+end

data/examples/order_number.rb

@@ -0,0 +1,83 @@
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "ruby-bandwidth-iris"
+
+def order_numbers_in_area_code(client, site_id:, sippeer_id:, area_code: 919, quantity: 1)
+  order_data = {
+      :name => "Test",
+      :site_id => site_id,
+      :area_code_search_and_order_type => {
+          :area_code => area_code,
+          :quantity => quantity
+      }
+  }
+  order_result = BandwidthIris::Order.create(client, order_data)
+  order_id = order_result.to_data[:id]
+  return order_id
+end
+
+def get_order_by_id(client, order_id:, attempts: 0)
+  begin
+    order_result = BandwidthIris::Order.get(client, order_id)
+    return order_result
+  rescue Exception => e
+    if attempts > 3
+      puts("Completely Failed fetching Order")
+      raise StandardError.new e
+    end
+    puts("Error Message: #{e.message}\nCode:#{e.code}")
+    attempts = attempts+1
+    sleep(1)
+    return get_order_by_id(client, order_id: order_id, attempts: attempts)
+  end
+end
+
+def get_order_response_by_id(client, order_id:, attempts: 0)
+  begin
+    order_response = BandwidthIris::Order.get_order_response(client, order_id)
+    order_data = order_response.to_data
+    numbers = order_response.completed_numbers
+    completed_number = order_data[:completed_numbers][:telephone_number][:full_number]
+    return order_data
+  rescue Exception => e
+    if attempts > 3
+      puts("Completely Failed fetching Order")
+      raise StandardError.new e
+    end
+    puts("Error Message: #{e.message}\nCode:#{e.code}")
+    attempts = attempts+1
+    sleep(1)
+    return get_order_response(client, order_id: order_id, attempts: attempts)
+  end
+end
+
+
+def get_numbers_from_order_id(client, order_id:)
+  order = BandwidthIris::Order.new({:id => order_id}, client)
+  numbers_result = order.get_tns
+  return numbers_result
+end
+
+def get_numbers_from_order(order)
+  numbers_result = order.get_tns
+  return numbers_result
+end
+
+def main
+  bandwidth_account_id = ENV["BANDWIDTH_ACCOUNT_ID"]
+  bandwidth_user_name = ENV["BANDWIDTH_API_USER"]
+  bandwidth_password = ENV["BANDWIDTH_API_PASSWORD"]
+  bandwidth_site_id = ENV["BANDWIDTH_SITE_ID"]
+  bandwidth_to_sippeer_id = ENV["BANDWIDTH_SIPPEER_ID"]
+  client = BandwidthIris::Client.new(bandwidth_account_id, bandwidth_user_name, bandwidth_password)
+  order_id = order_numbers_in_area_code(client, site_id: bandwidth_site_id, sippeer_id: bandwidth_to_sippeer_id)
+  my_order = get_order_by_id(client, order_id: order_id)
+  my_order_response = get_order_response_by_id(client, order_id: order_id)
+  my_numbers = get_numbers_from_order_id(client, order_id:order_id)
+  my_numbers = get_numbers_from_order(my_order)
+end
+
+if __FILE__ == $0
+  main
+end

data/lib/bandwidth-iris/applications.rb

@@ -0,0 +1,61 @@
+module BandwidthIris
+  APPLICATIONS_PATH = "applications"
+
+  class Applications
+    extend ClientWrapper
+    include ApiItem
+
+    def self.get_applications(client)
+      data = client.make_request(:get, client.concat_account_path(APPLICATIONS_PATH))
+      list = data[0][:application_list][:application]
+      return [] if !list
+      if list.is_a?(Array) then
+        return list
+      else
+        return [list]
+      end
+    end
+    wrap_client_arg :get_applications
+
+    def self.create_application(client, application_data)
+      data = client.make_request(:post, client.concat_account_path(APPLICATIONS_PATH), {:application => application_data})
+      return data[0][:application]
+    end
+    wrap_client_arg :create_application
+
+    def self.get_application(client, application_id)
+      data = client.make_request(:get, client.concat_account_path("#{APPLICATIONS_PATH}/#{application_id}"))
+      return data[0][:application]
+    end
+    wrap_client_arg :get_application
+
+    def self.partial_update_application(client, application_id, application_data)
+      data = client.make_request(:patch, client.concat_account_path("#{APPLICATIONS_PATH}/#{application_id}"), {:application => application_data})
+      return data[0][:application]
+    end
+    wrap_client_arg :partial_update_application
+
+    def self.complete_update_application(client, application_id, application_data)
+      data = client.make_request(:put, client.concat_account_path("#{APPLICATIONS_PATH}/#{application_id}"), {:application => application_data})
+      return data[0][:application]
+    end
+    wrap_client_arg :complete_update_application
+
+    def self.delete_application(client, application_id)
+      client.make_request(:delete, client.concat_account_path("#{APPLICATIONS_PATH}/#{application_id}"))
+    end
+    wrap_client_arg :delete_application
+
+    def self.get_application_sippeers(client, application_id)
+      data = client.make_request(:get, client.concat_account_path("#{APPLICATIONS_PATH}/#{application_id}/associatedsippeers"))
+      list = data[0][:associated_sip_peers][:associated_sip_peer]
+      return [] if !list
+      if list.is_a?(Array) then
+        return list
+      else
+        return [list]
+      end
+    end
+    wrap_client_arg :get_application_sippeers
+  end
+end

data/lib/bandwidth-iris/client.rb

@@ -77,12 +77,44 @@ module BandwidthIris
                       req.params = d unless d == nil || d.empty?
                     end
                   else
-                    connection.run_request(method, @build_path.call(path), build_xml(data), {'Content-Type' => 'application/xml'})
+                    xml_to_send = build_xml(data) # help debug
+                    connection.run_request(method, @build_path.call(path), xml_to_send, {'Content-Type' => 'application/xml'})
                   end
       body = check_response(response)
       [body || {}, symbolize(response.headers || {})]
     end
 
+    # Makes an HTTP request for file uploads
+    # @param method [Symbol] http method to make
+    # @param path [string] path of url (exclude api verion and endpoint) to make call
+    # @param data [string] the raw binary string representing the file to upload
+    # @param content_type [string] the content type of the request
+    # @return [Array] array with 2 elements: parsed  data of response and response headers
+    def make_request_file_upload(method, path, data, content_type)
+      connection = @create_connection.call()
+      response = connection.run_request(method, @build_path.call(path), data, {'Content-Type' => content_type})
+      body = check_response(response)
+      [body || {}, symbolize(response.headers || {})]
+    end
+
+    # Makes an HTTP request for a file download
+    # @param method [Symbol] http method to make
+    # @param path [string] path of url (exclude api verion and endpoint) to make call
+    # @param data [Hash] data  which will be sent with request (for :get and :delete request they will be sent with query in url)
+    # @return [string] raw response from the API
+    def make_request_file_download(method, path, data = {})
+      connection = @create_connection.call()
+      response =  if method == :get || method == :delete
+                    d  = camelcase(data)
+                    connection.run_request(method, @build_path.call(path), nil, nil) do |req|
+                      req.params = d unless d == nil || d.empty?
+                    end
+                  else
+                    connection.run_request(method, @build_path.call(path), build_xml(data), {'Content-Type' => 'application/xml'})
+                  end
+      return response.body
+    end
+
     # Check response object and raise error if status code >= 400
     # @param response response object
     def check_response(response)

data/lib/bandwidth-iris/csr.rb

@@ -0,0 +1,44 @@
+module BandwidthIris
+  CSR_PATH = 'csrs'
+
+  class Csr
+    extend ClientWrapper
+    include ApiItem
+
+    def self.create(client, csr_data)
+      data = client.make_request(:post, client.concat_account_path("#{CSR_PATH}"), {:csr => csr_data})
+      return data
+    end
+    wrap_client_arg :create
+
+    def self.get(client, csr_id)
+      data = client.make_request(:get, client.concat_account_path("#{CSR_PATH}/#{csr_id}"))
+      return data
+    end
+    wrap_client_arg :get
+
+    def self.replace(client, csr_id, csr_data)
+      data = client.make_request(:put, client.concat_account_path("#{CSR_PATH}/#{csr_id}"), {:csr => csr_data})
+      return data
+    end
+    wrap_client_arg :replace
+
+    def self.get_notes(client, csr_id)
+      data = client.make_request(:get, client.concat_account_path("#{CSR_PATH}/#{csr_id}/notes"))
+      return data
+    end
+    wrap_client_arg :get_notes
+
+    def self.add_note(client, csr_id, note_data)
+      data = client.make_request(:post, client.concat_account_path("#{CSR_PATH}/#{csr_id}/notes"), {:note => note_data})
+      return data
+    end
+    wrap_client_arg :add_note
+
+    def self.update_note(client, csr_id, note_id, note_data)
+      data = client.make_request(:put, client.concat_account_path("#{CSR_PATH}/#{csr_id}/notes/#{note_id}"), {:note => note_data})
+      return data
+    end
+    wrap_client_arg :update_note
+  end
+end

data/lib/bandwidth-iris/import_tn_orders.rb

@@ -1,5 +1,5 @@
 module BandwidthIris
-  IMPORT_TN_ORDERS_PATH = "importTnOrders"
+  IMPORT_TN_ORDERS_PATH = "importtnorders"
 
   class ImportTnOrders
     extend ClientWrapper
@@ -28,5 +28,48 @@ module BandwidthIris
       return data
     end
     wrap_client_arg :create_import_tn_order
+
+    def self.get_loa_files(client, order_id)
+      data = client.make_request(:get, client.concat_account_path("#{IMPORT_TN_ORDERS_PATH}/#{order_id}/#{LOAS_PATH}"))
+      return data
+    end
+    wrap_client_arg :get_loa_files
+
+    def self.upload_loa_file(client, order_id, file_contents, mime_type)
+      client.make_request_file_upload(:post, client.concat_account_path("#{IMPORT_TN_ORDERS_PATH}/#{order_id}/#{LOAS_PATH}"), file_contents, mime_type)
+    end
+    wrap_client_arg :upload_loa_file
+
+    def self.download_loa_file(client, order_id, file_id)
+      data = client.make_request_file_download(:get, client.concat_account_path("#{IMPORT_TN_ORDERS_PATH}/#{order_id}/#{LOAS_PATH}/#{file_id}"))
+      return data
+    end
+    wrap_client_arg :download_loa_file
+
+    def self.replace_loa_file(client, order_id, file_id, file_contents, mime_type)
+      data = client.make_request_file_upload(:put, client.concat_account_path("#{IMPORT_TN_ORDERS_PATH}/#{order_id}/#{LOAS_PATH}/#{file_id}"), file_contents, mime_type)
+    end
+    wrap_client_arg :replace_loa_file
+
+    def self.delete_loa_file(client, order_id, file_id)
+      client.make_request(:delete, client.concat_account_path("#{IMPORT_TN_ORDERS_PATH}/#{order_id}/#{LOAS_PATH}/#{file_id}"))
+    end
+    wrap_client_arg :delete_loa_file
+
+    def self.get_loa_file_metadata(client, order_id, file_id)
+      data = client.make_request(:get, client.concat_account_path("#{IMPORT_TN_ORDERS_PATH}/#{order_id}/#{LOAS_PATH}/#{file_id}/metadata"))
+      return data
+    end
+    wrap_client_arg :get_loa_file_metadata
+
+    def self.update_loa_file_metadata(client, order_id, file_id, file_metadata)
+      client.make_request(:put, client.concat_account_path("#{IMPORT_TN_ORDERS_PATH}/#{order_id}/#{LOAS_PATH}/#{file_id}/metadata"), {:file_meta_data => file_metadata})
+    end
+    wrap_client_arg :update_loa_file_metadata
+
+    def self.delete_loa_file_metadata(client, order_id, file_id)
+      client.make_request(:delete, client.concat_account_path("#{IMPORT_TN_ORDERS_PATH}/#{order_id}/#{LOAS_PATH}/#{file_id}/metadata"))
+    end
+    wrap_client_arg :delete_loa_file_metadata
   end
 end

data/lib/bandwidth-iris/order.rb

@@ -13,6 +13,14 @@ module BandwidthIris
 
     def self.get(client, id)
       data = client.make_request(:get, "#{client.concat_account_path(ORDER_PATH)}/#{id}")[0][:order]
+      data[:id] = id
+      Order.new(data, client)
+    end
+    wrap_client_arg :get
+
+    def self.get_order_response(client, id)
+      data = client.make_request(:get, "#{client.concat_account_path(ORDER_PATH)}/#{id}")[0]
+      data[:id] = id
       Order.new(data, client)
     end
     wrap_client_arg :get
@@ -25,6 +33,13 @@ module BandwidthIris
     end
     wrap_client_arg :list
 
+    #`get order` no longer returns an `id`, which means the subsequent `get_tns` call will fail
+    #This is a workaround to provide the "get tns by order id" functionality
+    def self.get_tns_by_order_id(client, id)
+      client.make_request(:get, "#{client.concat_account_path(ORDER_PATH)}/#{id}/tns")[0]
+    end
+    wrap_client_arg :get_tns_by_order_id
+
     def update(data)
       @client.make_request(:put, "#{@client.concat_account_path(ORDER_PATH)}/#{id}", {:order => data})[0]
     end

data/lib/bandwidth-iris/sip_peer_products.rb

@@ -0,0 +1,118 @@
+module BandwidthIris
+  SIPPEER_PRODUCTS_PATH = 'products'
+
+  class SipPeerProducts
+    extend ClientWrapper
+    include ApiItem
+
+    def self.get_origination_settings(client, site_id, sippeer_id)
+      response = client.make_request(:get, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/origination/settings")
+      return response[0][:sip_peer_origination_settings]
+    end
+    wrap_client_arg :get_origination_settings
+
+    def self.create_origination_settings(client, site_id, sippeer_id, data)
+      response = client.make_request(:post, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/origination/settings", {:sip_peer_origination_settings => data})
+      return response[0][:sip_peer_origination_settings]
+    end
+    wrap_client_arg :create_origination_settings
+
+    def self.update_origination_settings(client, site_id, sippeer_id, data)
+      client.make_request(:put, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/origination/settings", {:sip_peer_origination_settings => data})
+    end
+    wrap_client_arg :update_origination_settings
+
+    def self.get_termination_settings(client, site_id, sippeer_id)
+      response = client.make_request(:get, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/termination/settings")
+      return response[0][:sip_peer_termination_settings]
+    end
+    wrap_client_arg :get_termination_settings
+
+    def self.create_termination_settings(client, site_id, sippeer_id, data)
+      response = client.make_request(:post, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/termination/settings", {:sip_peer_termination_settings => data})
+      return response[0][:sip_peer_termination_settings]
+    end
+    wrap_client_arg :create_termination_settings
+
+    def self.update_termination_settings(client, site_id, sippeer_id, data)
+      client.make_request(:put, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/termination/settings", {:sip_peer_termination_settings => data})
+    end
+    wrap_client_arg :update_termination_settings
+
+    def self.get_sms_feature_settings(client, site_id, sippeer_id)
+      response = client.make_request(:get, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/messaging/features/sms")
+      return response[0][:sip_peer_sms_feature]
+    end
+    wrap_client_arg :get_sms_feature_settings
+
+    def self.create_sms_feature_settings(client, site_id, sippeer_id, data)
+      response = client.make_request(:post, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/messaging/features/sms", {:sip_peer_sms_feature => data})
+      return response[0][:sip_peer_sms_feature]
+    end
+    wrap_client_arg :create_sms_feature_settings
+
+    def self.update_sms_feature_settings(client, site_id, sippeer_id, data)
+      response = client.make_request(:put, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/messaging/features/sms", {:sip_peer_sms_feature => data})
+      return response[0][:sip_peer_sms_feature]
+    end
+    wrap_client_arg :update_sms_feature_settings
+
+    def self.delete_sms_feature_settings(client, site_id, sippeer_id)
+      response = client.make_request(:delete, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/messaging/features/sms")
+      return response
+    end
+    wrap_client_arg :delete_sms_feature_settings
+
+    def self.get_mms_feature_settings(client, site_id, sippeer_id)
+      response = client.make_request(:get, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/messaging/features/mms")
+      return response[0][:mms_feature]
+    end
+    wrap_client_arg :get_mms_feature_settings
+
+    def self.create_mms_feature_settings(client, site_id, sippeer_id, data)
+      response = client.make_request(:post, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/messaging/features/mms", {:mms_feature => data})
+      return response[0][:mms_feature]
+    end
+    wrap_client_arg :create_mms_feature_settings
+
+    def self.update_mms_feature_settings(client, site_id, sippeer_id, data)
+      client.make_request(:put, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/messaging/features/mms", {:mms_feature => data})
+    end
+    wrap_client_arg :update_mms_feature_settings
+
+    def self.delete_mms_feature_settings(client, site_id, sippeer_id)
+      client.make_request(:delete, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/messaging/features/mms")
+    end
+    wrap_client_arg :delete_mms_feature_settings
+
+    def self.get_mms_feature_mms_settings(client, site_id, sippeer_id)
+      response = client.make_request(:get, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/messaging/features/mms/settings")
+      return response[0][:mms_settings]
+    end
+    wrap_client_arg :get_mms_feature_mms_settings
+
+    def self.get_messaging_application_settings(client, site_id, sippeer_id)
+      response = client.make_request(:get, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/messaging/applicationSettings")
+      return response[0][:applications_settings]
+    end
+    wrap_client_arg :get_messaging_application_settings
+
+    def self.update_messaging_application_settings(client, site_id, sippeer_id, data)
+      response = client.make_request(:put, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/messaging/applicationSettings", {:applications_settings => data})
+      return response[0][:applications_settings]
+    end
+    wrap_client_arg :update_messaging_application_settings
+
+    def self.get_messaging_settings(client, site_id, sippeer_id)
+      response = client.make_request(:get, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/messaging/settings")
+      return response[0][:sip_peer_messaging_settings]
+    end
+    wrap_client_arg :get_messaging_settings
+
+    def self.update_messaging_settings(client, site_id, sippeer_id, data)
+      response = client.make_request(:put, "#{client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{sippeer_id}/#{SIPPEER_PRODUCTS_PATH}/messaging/settings", {:sip_peer_messaging_settings => data})
+      return response[0][:sip_peer_messaging_settings]
+    end
+    wrap_client_arg :update_messaging_settings
+  end
+end