messagebird-rest 1.4.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ed916adf077ac2e3a03631e2d97fad4a6c9e9c97
-  data.tar.gz: 01aab619642825c19ef2b939a284c138e28542b2
+SHA256:
+  metadata.gz: 9dc78fcfe4e496c197244a6e62ad347bc439c52334d69a453f25977f7981c23b
+  data.tar.gz: 6cef4d63e95ddd4455dd4a003b60bdfc3dfb1b10cfc1049cee9aecc7d8d5fb41
 SHA512:
-  metadata.gz: bfc589631d306c6cdfa0464ed2da03f88c4a7c88846ed0038e48dd20ab8e5e4ddae03a2bdd34c7371e4ce21f3b72b4c0798d43dfcd43f3d359e8e22ec5c85ac8
-  data.tar.gz: 799b7b82c6f6f8839986bdedba3abd47984f6a809b388f6713744b2e2c102a6503ff9cdd02e3baca98832117eaf116fbffa32fddaeea57de02d75c26a2b8a471
+  metadata.gz: f235d92c2c49b14c7529c3aa2ad5e8fb6e03adf66a74f4d55229b1b262c66d8beca1a9137ff1d24da439a8d9051915765c7371e17fc1eae63bc0e56e8b96f715
+  data.tar.gz: 4b264d192ab011f784aedd9f336e750a1d20b9413d6cb9fd2e67d37cef6b36f7ceed25b80d6dbb74e90b4ffb452f90939b3343a732d2043138071a2b15f6260e

data/README.md

@@ -58,7 +58,7 @@ pp client.message_create('FromMe', '31612345678', 'Hello World', :reference => '
 
 #<MessageBird::Message:0x007f8d5b883520
  @body="Hello World",
- @createdDatetime=2014-07-07 12:20:30 +0200,
+ @created_datetime=2014-07-07 12:20:30 +0200,
  @datacoding="plain",
  @direction="mt",
  @gateway=239,
@@ -68,7 +68,7 @@ pp client.message_create('FromMe', '31612345678', 'Hello World', :reference => '
  @mclass=1,
  @originator="FromMe",
  @recipient=
-  {"totalCount"=>1,
+  {"total_count"=>1,
    "totalSentCount"=>1,
    "totalDeliveredCount"=>0,
    "totalDeliveryFailedCount"=>0,
@@ -78,9 +78,9 @@ pp client.message_create('FromMe', '31612345678', 'Hello World', :reference => '
       @status="sent",
       @statusDatetime=2014-07-07 12:20:30 +0200>]},
  @reference="MyReference",
- @scheduledDatetime=nil,
+ @scheduled_datetime=nil,
  @type="sms",
- @typeDetails={},
+ @type_details={},
  @validity=nil>
 ```
 
@@ -97,7 +97,7 @@ To perform HLR lookups we have created the **hlr_create** method, which takes a
 pp client.hlr_create('31612345678', 'MyReference')
 
 #<MessageBird::HLR:0x007f8d5b8dafc8
- @createdDatetime=2014-07-07 12:20:05 +0200,
+ @created_datetime=2014-07-07 12:20:05 +0200,
  @href="https://rest.messagebird.com/hlr/4933bed0453ba7455031712h16830892",
  @id="4933bed0453ba7455031712h16830892",
  @msisdn=31612345678,
@@ -126,7 +126,7 @@ client.verify_create(31612345678, {:reference => "YourReference"})
  @reference="YourReference",
  @status="sent",
  @href={"message"=>"https://rest.messagebird.com/messages/67d42f004555213679416f0b13254392"},
- @createdDatetime=2015-05-12 16:51:19 +0200,
+ @created_datetime=2015-05-12 16:51:19 +0200,
  @validUntilDatetime=2015-05-12 16:51:49 +0200>
 ```
 
@@ -147,14 +147,14 @@ pp client.voice_message_create('31612345678', 'Hello World', :reference => 'MyRe
 
 #<MessageBird::VoiceMessage:0x000001030101b8
  @body="Hello World",
- @createdDatetime=2014-07-09 12:17:50 +0200,
+ @created_datetime=2014-07-09 12:17:50 +0200,
  @href=
   "https://rest.messagebird.com/voicemessages/a08e51a0353bd16cea7f298a37405850",
  @id="a08e51a0353bd16cea7f298a37405850",
  @ifMachine="continue",
  @language="en-gb",
  @recipients=
-  {"totalCount"=>1,
+  {"total_count"=>1,
    "totalSentCount"=>1,
    "totalDeliveredCount"=>0,
    "totalDeliveryFailedCount"=>0,
@@ -175,6 +175,54 @@ Similar to regular messaging and HLR lookups, there is a method available to fet
 client.voice_message('a08e51a0353bd16cea7f298a37405850')
 ```
 
+##### Numbers
+There is also a Numbers API that allow you to search for and purchase number subscriptions to use as originator in other services.
+
+```ruby
+pp client.number_search("NL", {:limit=>5})
+
+#<List:0x00007fa405130618
+ @count=5,
+ @items=
+  [#<MessageBird::Number:0x00007fa405130528
+    @country="NL",
+    @features=["voice"],
+    @locality="Rotterdam",
+    @number="31102005108",
+    @region="",
+    @type="unknown">,
+   #<MessageBird::Number:0x00007fa4051303c0
+    @country="NL",
+    @features=["voice"],
+    @locality="Rotterdam",
+    @number="31102005143",
+    @region="",
+    @type="unknown">,
+   #<MessageBird::Number:0x00007fa405130208
+    @country="NL",
+    @features=["voice"],
+    @locality="Rotterdam",
+    @number="31102005145",
+    @region="",
+    @type="unknown">,
+   #<MessageBird::Number:0x00007fa4051300c8
+    @country="NL",
+    @features=["voice"],
+    @locality="Rotterdam",
+    @number="31102005147",
+    @region="",
+    @type="unknown">,
+   #<MessageBird::Number:0x00007fa405131c48
+    @country="NL",
+    @features=["voice"],
+    @locality="Rotterdam",
+    @number="31102005148",
+    @region="",
+    @type="unknown">],
+ @limit=5,
+ @type=MessageBird::Number>
+````
+
 Documentation
 -------------
 Complete documentation, instructions, and examples are available at:

data/lib/messagebird.rb

@@ -1,11 +1,9 @@
-libdir = File.dirname(__FILE__)
-$:.unshift(libdir) unless $:.include?(libdir)
+# frozen_string_literal: true
 
-module MessageBird
-  CLIENT_VERSION = '1.4.0'
-  ENDPOINT       = 'https://rest.messagebird.com'
-end
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
+require 'messagebird/version'
 require 'messagebird/balance'
 require 'messagebird/client'
 require 'messagebird/contact'
@@ -14,6 +12,13 @@ require 'messagebird/group_reference'
 require 'messagebird/hlr'
 require 'messagebird/http_client'
 require 'messagebird/message_reference'
+require 'messagebird/signed_request'
 require 'messagebird/verify'
 require 'messagebird/message'
 require 'messagebird/voicemessage'
+require 'messagebird/callflow'
+require 'messagebird/voice/call'
+require 'messagebird/voice/call_leg'
+require 'messagebird/voice/call_leg_recording'
+require 'messagebird/voice/transcription'
+require 'messagebird/voice/webhook'

data/lib/messagebird/balance.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'messagebird/base'
 
 module MessageBird

data/lib/messagebird/base.rb

@@ -1,18 +1,23 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'time'
 
 module MessageBird
   class Base
-    def initialize(json)
-      json.each do |k,v|
-        begin
-          send("#{k}=", v)
-        rescue NoMethodError
-          # Silently ignore parameters that are not supported.
-        end
+    # takes each element from the given hash and apply it to ourselves through an assignment method
+    def map_hash_elements_to_self(hash)
+      hash.each do |key, value|
+        method_name = key.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase # convert came case to snake case
+        method_name += '='
+        send(method_name, value) if respond_to?(method_name)
       end
     end
 
+    def initialize(json)
+      map_hash_elements_to_self(json)
+    end
+
     def value_to_time(value)
       value ? Time.parse(value) : nil
     end

data/lib/messagebird/call_flow.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'messagebird/base'
+
+module MessageBird
+  class CallFlow < MessageBird::Base
+    attr_accessor :id, :title, :record, :default
+    attr_reader :steps, :created_at, :updated_at
+
+    def steps=(json)
+      @steps = json.map { |s| MessageBird::CallFlowStep.new(s) }
+    end
+
+    def created_at=(value)
+      @created_at = value_to_time(value)
+    end
+
+    def updated_at=(value)
+      @updated_at = value_to_time(value)
+    end
+  end
+end

data/lib/messagebird/call_flow/step.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'messagebird/base'
+
+module MessageBird
+  class CallFlowStep < MessageBird::Base
+    attr_accessor :id, :action, :options
+  end
+end

data/lib/messagebird/callflow.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'messagebird/base'
+
+module MessageBird
+  class CallFlow < MessageBird::Base
+    attr_accessor :id, :title, :record, :default
+    attr_reader :steps, :created_at, :updated_at
+
+    def initialize(json)
+      params = json.include?('data') ? json['data'].first : json
+      super(params)
+    end
+
+    def steps=(json)
+      @steps = json.map { |c| MessageBird::CallFlowStep.new(c) }
+    end
+
+    def created_at=(value)
+      @created_at = value_to_time(value)
+    end
+
+    def updated_at=(value)
+      @updated_at = value_to_time(value)
+    end
+  end
+
+  class CallFlowList < List
+    attr_accessor :perPage, :currentPage, :pageCount, :totalCount
+    PER_PAGE = 20
+    CURRENT_PAGE = 1
+
+    def data=(value)
+      self.items = value
+    end
+
+    def pagination=(value)
+      value.each do |k, v|
+        send("#{k}=", v)
+      rescue NoMethodError
+        puts 'An error occurred while listing callflows'
+      end
+    end
+  end
+
+  class CallFlowStep < MessageBird::Base
+    attr_accessor :id, :action
+
+    def options=(json)
+      @options = CallFlowStepOption.new(json)
+    end
+  end
+
+  class CallFlowStepOption < MessageBird::Base
+    attr_accessor :destination, :payload, :language, :voice, :repeat,
+                  :media, :length, :maxLength, :timeout, :finishOnKey, :transcribe,
+                  :transcribeLanguage, :record, :url, :ifMachine, :machineTimeout,
+                  :onFinish, :mask
+  end
+end

data/lib/messagebird/client.rb

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'net/https'
 require 'uri'
 
 require 'messagebird/balance'
 require 'messagebird/contact'
+require 'messagebird/conversation'
+require 'messagebird/conversation_client'
+require 'messagebird/conversation_message'
+require 'messagebird/conversation_webhook'
 require 'messagebird/error'
 require 'messagebird/group'
 require 'messagebird/hlr'
@@ -11,8 +17,20 @@ require 'messagebird/http_client'
 require 'messagebird/list'
 require 'messagebird/lookup'
 require 'messagebird/message'
+require 'messagebird/number'
+require 'messagebird/number_client'
 require 'messagebird/verify'
+require 'messagebird/verify_email_message'
+require 'messagebird/voice/client'
+require 'messagebird/voice/list'
+require 'messagebird/voice/webhook'
 require 'messagebird/voicemessage'
+require 'messagebird/voice_client'
+require 'messagebird/voice/call'
+require 'messagebird/voice/call_leg'
+require 'messagebird/voice/call_leg_recording'
+require 'messagebird/voice/transcription'
+require 'messagebird/voice/list'
 
 module MessageBird
   class ErrorException < StandardError
@@ -23,30 +41,148 @@ module MessageBird
     end
   end
 
-  class Client
+  class InvalidFeatureException < StandardError
+  end
 
-    attr_reader :access_key
-    attr_reader :http_client
+  class Client
+    attr_reader :access_key, :http_client, :conversation_client, :voice_client
 
-    def initialize(access_key = nil, http_client = nil)
+    def initialize(access_key = nil, http_client = nil, conversation_client = nil, voice_client = nil)
       @access_key = access_key || ENV['MESSAGEBIRD_ACCESS_KEY']
       @http_client = http_client || HttpClient.new(@access_key)
+      @conversation_client = conversation_client || ConversationClient.new(@access_key)
+      @number_client = http_client || NumberClient.new(@access_key)
+      @voice_client = voice_client || VoiceClient.new(@access_key)
     end
 
-    def request(method, path, params={})
+    def conversation_request(method, path, params = {})
+      response_body = @conversation_client.request(method, path, params)
+      return if response_body.nil? || response_body.empty?
+
+      parse_body(response_body)
+    end
+
+    def number_request(method, path, params = {})
+      response_body = @number_client.request(method, path, params)
+      return if response_body.nil? || response_body.empty?
+
+      parse_body(response_body)
+    end
+
+    def voice_request(method, path, params = {})
+      response_body = @voice_client.request(method, path, params)
+      return if response_body.nil? || response_body.empty?
+
+      parse_body(response_body)
+    end
+
+    def request(method, path, params = {})
       response_body = @http_client.request(method, path, params)
-      return if response_body.empty?
+      return if response_body.nil? || response_body.empty?
+
+      parse_body(response_body)
+    end
 
-      json = JSON.parse(response_body)
+    def parse_body(body)
+      json = JSON.parse(body)
 
       # If the request returned errors, create Error objects and raise.
-      if json.has_key?('errors')
-        raise ErrorException, json['errors'].map { |e| Error.new(e) }
+      if json.key?('errors')
+        raise(ErrorException, json['errors'].map { |e| Error.new(e) })
       end
 
       json
     end
 
+    ## Conversations
+    # Send a conversation message
+    def send_conversation_message(from, to, params = {})
+      ConversationMessage.new(conversation_request(
+                                :post,
+                                'send',
+                                params.merge(from: from,
+                                             to: to)
+      ))
+    end
+
+    # Start a conversation
+    def start_conversation(to, channel_id, params = {})
+      Conversation.new(conversation_request(
+                         :post,
+                         'conversations/start',
+                         params.merge(to: to,
+                                      channel_id: channel_id)
+      ))
+    end
+
+    def conversation_list(limit = -1, offset = -1)
+      query = '?'
+      if limit != -1
+        query += "limit=#{limit}&"
+      end
+
+      if offset != -1
+        query += "offset=#{offset}"
+      end
+
+      List.new(Conversation, conversation_request(:get, "conversations#{query}"))
+    end
+
+    def conversation(id)
+      Conversation.new(conversation_request(:get, "conversations/#{id}"))
+    end
+
+    def conversation_update(id, status)
+      Conversation.new(conversation_request(:patch, "conversations/#{id}", status: status))
+    end
+
+    def conversation_reply(id, params = {})
+      ConversationMessage.new(conversation_request(:post, "conversations/#{id}/messages", params))
+    end
+
+    def conversation_messages_list(id, limit = -1, offset = -1)
+      query = '?'
+      if limit != -1
+        query += "limit=#{limit}&"
+      end
+
+      if offset != -1
+        query += "offset=#{offset}"
+      end
+
+      List.new(ConversationMessage, conversation_request(:get, "conversations/#{id}/messages#{query}"))
+    end
+
+    def conversation_message(id)
+      ConversationMessage.new(conversation_request(:get, "messages/#{id}"))
+    end
+
+    def conversation_webhook_create(channel_id, url, events = [])
+      ConversationWebhook.new(conversation_request(
+                                :post,
+                                'webhooks',
+                                channel_id: channel_id,
+                                url: url,
+                                events: events
+      ))
+    end
+
+    def conversation_webhooks_list(limit = 0, offset = 0)
+      List.new(ConversationWebhook, conversation_request(:get, "webhooks?limit=#{limit}&offset=#{offset}"))
+    end
+
+    def conversation_webhook_update(id, params = {})
+      ConversationWebhook.new(conversation_request(:patch, "webhooks/#{id}", params))
+    end
+
+    def conversation_webhook(id)
+      ConversationWebhook.new(conversation_request(:get, "webhooks/#{id}"))
+    end
+
+    def conversation_webhook_delete(id)
+      conversation_request(:delete, "webhooks/#{id}")
+    end
+
     # Retrieve your balance.
     def balance
       Balance.new(request(:get, 'balance'))
@@ -54,96 +190,185 @@ module MessageBird
 
     # Retrieve the information of specific HLR.
     def hlr(id)
-      HLR.new(request(:get, "hlr/#{id.to_s}"))
+      HLR.new(request(:get, "hlr/#{id}"))
     end
 
     # Create a new HLR.
     def hlr_create(msisdn, reference)
       HLR.new(request(
-        :post,
-        'hlr',
-        :msisdn    => msisdn,
-        :reference => reference))
+                :post,
+                'hlr',
+                msisdn: msisdn,
+                reference: reference
+      ))
     end
 
     # Retrieve the information of specific Verify.
     def verify(id)
-      Verify.new(request(:get, "verify/#{id.to_s}"))
+      Verify.new(request(:get, "verify/#{id}"))
+    end
+
+    # Retrieve the information of specific Verify email message
+    def verify_email_message(id)
+      VerifyEmailMessage.new(request(:get, "verify/messages/email/#{id}"))
     end
 
     # Generate a new One-Time-Password message.
-    def verify_create(recipient, params={})
+    def verify_create(recipient, params = {})
       Verify.new(request(
-          :post,
-          'verify',
-          params.merge({
-              :recipient => recipient
-          })
+                   :post,
+                   'verify',
+                   params.merge(recipient: recipient)
       ))
     end
 
     # Verify the One-Time-Password.
     def verify_token(id, token)
-      Verify.new(request(:get, "verify/#{id.to_s}?token=#{token}"))
+      Verify.new(request(:get, "verify/#{id}?token=#{token}"))
     end
 
-    # Delete a Verify
+    # Delete a Verify, response is empty
     def verify_delete(id)
-      Verify.new(request(:delete, "verify/#{id.to_s}"))
+      request(:delete, "verify/#{id}")
     end
 
     # Retrieve the information of specific message.
     def message(id)
-      Message.new(request(:get, "messages/#{id.to_s}"))
+      Message.new(request(:get, "messages/#{id}"))
+    end
+
+    # Retrieve messages with optional paging and status filter.
+    def message_list(filters = {})
+      params = { limit: 10, offset: 0 }.merge(filters).compact
+      query = "messages?#{URI.encode_www_form(params)}"
+
+      List.new(Message, request(:get, query))
     end
 
     # Create a new message.
-    def message_create(originator, recipients, body, params={})
+    def message_create(originator, recipients, body, params = {})
       # Convert an array of recipients to a comma-separated string.
-      recipients = recipients.join(',') if recipients.kind_of?(Array)
+      recipients = recipients.join(',') if recipients.is_a?(Array)
 
       Message.new(request(
-        :post,
-        'messages',
-        params.merge({
-          :originator => originator.to_s,
-          :body       => body.to_s,
-          :recipients => recipients })))
+                    :post,
+                    'messages',
+                    params.merge(originator: originator.to_s,
+                                 body: body.to_s,
+                                 recipients: recipients)
+      ))
     end
 
     # Retrieve the information of a specific voice message.
     def voice_message(id)
-      VoiceMessage.new(request(:get, "voicemessages/#{id.to_s}"))
+      VoiceMessage.new(request(:get, "voicemessages/#{id}"))
     end
 
     # Create a new voice message.
-    def voice_message_create(recipients, body, params={})
+    def voice_message_create(recipients, body, params = {})
       # Convert an array of recipients to a comma-separated string.
-      recipients = recipients.join(',') if recipients.kind_of?(Array)
+      recipients = recipients.join(',') if recipients.is_a?(Array)
 
       VoiceMessage.new(request(
-        :post,
-        'voicemessages',
-        params.merge({ :recipients => recipients, :body => body.to_s })))
+                         :post,
+                         'voicemessages',
+                         params.merge(recipients: recipients, body: body.to_s)
+      ))
     end
 
-    def lookup(phoneNumber, params={})
-      Lookup.new(request(:get, "lookup/#{phoneNumber}", params))
+    def voice_webhook_create(url, params = {})
+      Voice::Webhook.new(voice_request(:post, 'webhooks', params.merge(url: url)))
     end
 
-    def lookup_hlr_create(phoneNumber, params={})
-      HLR.new(request(:post, "lookup/#{phoneNumber}/hlr", params))
+    def voice_webhooks_list(per_page = VoiceList::PER_PAGE, page = VoiceList::CURRENT_PAGE)
+      Voice::List.new(Voice::Webhook, voice_request(:get, "webhooks?perPage=#{per_page}&page=#{page}"))
     end
 
-    def lookup_hlr(phoneNumber, params={})
-      HLR.new(request(:get, "lookup/#{phoneNumber}/hlr", params))
+    def voice_webhook_update(id, params = {})
+      Voice::Webhook.new(voice_request(:put, "webhooks/#{id}", params))
     end
 
-    def contact_create(phoneNumber, params={})
+    def voice_webhook(id)
+      Voice::Webhook.new(voice_request(:get, "webhooks/#{id}"))
+    end
+
+    def voice_webhook_delete(id)
+      voice_request(:delete, "webhooks/#{id}")
+    end
+
+    def call_create(source, destination, call_flow = {}, webhook = {}, params = {})
+      params = params.merge(callFlow: call_flow.to_json) unless call_flow.empty?
+      params = params.merge(webhook: webhook.to_json) unless webhook.empty?
+
+      Voice::Call.new(voice_request(:post, 'calls', params.merge(source: source, destination: destination)))
+    end
+
+    def call_list(per_page = Voice::List::PER_PAGE, page = Voice::List::CURRENT_PAGE)
+      Voice::List.new(Voice::Call, voice_request(:get, "calls?perPage=#{per_page}&currentPage=#{page}"))
+    end
+
+    def call_view(id)
+      Voice::Call.new(voice_request(:get, "calls/#{id}"))
+    end
+
+    def call_delete(id)
+      voice_request(:delete, "calls/#{id}")
+    end
+
+    def call_leg_list(call_id, per_page = Voice::List::PER_PAGE, current_page = Voice::List::CURRENT_PAGE)
+      Voice::List.new(Voice::CallLeg, voice_request(:get, "calls/#{call_id}/legs?perPage=#{per_page}&currentPage=#{current_page}"))
+    end
+
+    def call_leg_recording_view(call_id, leg_id, recording_id)
+      Voice::CallLegRecording.new(voice_request(:get, "calls/#{call_id}/legs/#{leg_id}/recordings/#{recording_id}"))
+    end
+
+    def call_leg_recording_list(call_id, leg_id)
+      Voice::List.new(Voice::CallLegRecording, voice_request(:get, "calls/#{call_id}/legs/#{leg_id}/recordings"))
+    end
+
+    def call_leg_recording_delete(call_id, leg_id, recording_id)
+      voice_request(:delete, "calls/#{call_id}/legs/#{leg_id}/recordings/#{recording_id}")
+    end
+
+    def call_leg_recording_download(recording_uri, &block)
+      @voice_client.request_block(:get, recording_uri, {}, &block)
+    end
+
+    def voice_transcription_create(call_id, leg_id, recording_id, params = {})
+      Voice::Transcription.new(voice_request(:post, "calls/#{call_id}/legs/#{leg_id}/recordings/#{recording_id}/transcriptions", params))
+    end
+
+    def voice_transcriptions_list(call_id, leg_id, recording_id)
+      Voice::List.new(Voice::Transcription, voice_request(:get, "calls/#{call_id}/legs/#{leg_id}/recordings/#{recording_id}/transcriptions"))
+    end
+
+    def voice_transcription_download(call_id, leg_id, recording_id, transcription_id, &block)
+      @voice_client.request_block(:get, "calls/#{call_id}/legs/#{leg_id}/recordings/#{recording_id}/transcriptions/#{transcription_id}.txt", {}, &block)
+    end
+
+    def voice_transcription_view(call_id, leg_id, recording_id, transcription_id)
+      Voice::Transcription.new(voice_request(:get, "calls/#{call_id}/legs/#{leg_id}/recordings/#{recording_id}/transcriptions/#{transcription_id}"))
+    end
+
+    def lookup(phone_number, params = {})
+      Lookup.new(request(:get, "lookup/#{phone_number}", params))
+    end
+
+    def lookup_hlr_create(phone_number, params = {})
+      HLR.new(request(:post, "lookup/#{phone_number}/hlr", params))
+    end
+
+    def lookup_hlr(phone_number, params = {})
+      HLR.new(request(:get, "lookup/#{phone_number}/hlr", params))
+    end
+
+    def contact_create(phone_number, params = {})
       Contact.new(request(
-                      :post,
-                      'contacts',
-                      params.merge({ :msisdn => phoneNumber.to_s })))
+                    :post,
+                    'contacts',
+                    params.merge(msisdn: phone_number.to_s)
+      ))
     end
 
     def contact(id)
@@ -154,7 +379,7 @@ module MessageBird
       request(:delete, "contacts/#{id}")
     end
 
-    def contact_update(id, params={})
+    def contact_update(id, params = {})
       request(:patch, "contacts/#{id}", params)
     end
 
@@ -167,7 +392,7 @@ module MessageBird
     end
 
     def group_create(name)
-      Group.new(request(:post, 'groups', { :name => name }))
+      Group.new(request(:post, 'groups', name: name))
     end
 
     def group_delete(id)
@@ -179,7 +404,7 @@ module MessageBird
     end
 
     def group_update(id, name)
-      request(:patch, "groups/#{id}", { :name => name })
+      request(:patch, "groups/#{id}", name: name)
     end
 
     def group_add_contacts(group_id, contact_ids)
@@ -195,8 +420,68 @@ module MessageBird
       request(:delete, "groups/#{group_id}/contacts/#{contact_id}")
     end
 
+    ## Numbers API
+    # Search for available numbers
+    def number_search(country_code, params = {})
+      List.new(Number, number_request(:get, add_querystring("available-phone-numbers/#{country_code}", params), params))
+    end
+
+    # Purchase an avaiable number
+    def number_purchase(number, country_code, billing_interval_months)
+      params = {
+        number: number,
+        countryCode: country_code,
+        billingIntervalMonths: billing_interval_months
+      }
+      Number.new(number_request(:post, 'phone-numbers', params))
+    end
+
+    # Fetch all purchaed numbers' details
+    def number_fetch_all(params = {})
+      List.new(Number, number_request(:get, add_querystring('phone-numbers', params), params))
+    end
+
+    # Fetch specific purchased number's details
+    def number_fetch(number)
+      Number.new(number_request(:get, "phone-numbers/#{number}"))
+    end
+
+    # Update a number
+    def number_update(number, tags)
+      tags = [tags] if tags.is_a? String
+      Number.new(number_request(:patch, "phone-numbers/#{number}", tags: tags))
+    end
+
+    # Cancel a number
+    def number_cancel(number)
+      number_request(:delete, "phone-numbers/#{number}")
+    end
+
+    def call_flow_create(title, steps, default, record, params = {})
+      params = params.merge(
+        title: title,
+        steps: steps,
+        default: default,
+        record: record
+      )
+      CallFlow.new(voice_request(:post, 'call-flows', params))
+    end
+
+    def call_flow_view(id)
+      CallFlow.new(voice_request(:get, "call-flows/#{id}"))
+    end
+
+    def call_flow_list(per_page = CallFlowList::PER_PAGE, page = CallFlowList::CURRENT_PAGE)
+      CallFlowList.new(CallFlow, voice_request(:get, "call-flows?perPage=#{per_page}&page=#{page}"))
+    end
+
+    def call_flow_delete(id)
+      voice_request(:delete, "call-flows/#{id}")
+    end
+
     private # Applies to every method below this line
 
+    # Applies to every method below this line
     def add_contacts_query(contact_ids)
       # add_contacts_query gets a query string to add contacts to a group.
       # We're using the alternative "/foo?_method=PUT&key=value" format to send
@@ -208,5 +493,10 @@ module MessageBird
       '_method=PUT&' + contact_ids.map { |id| "ids[]=#{id}" }.join('&')
     end
 
+    def add_querystring(path, params)
+      return path if params.empty?
+
+      "#{path}?" + params.collect { |k, v| v.is_a?(Array) ? v.collect { |sv| "#{k}=#{sv}" }.join('&') : "#{k}=#{v}" }.join('&')
+    end
   end
 end