telnyx 0.1.0 → 2.6.0

data/lib/telnyx/number_lookup.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class NumberLookup < APIResource
+    RESOURCE_PATH = OBJECT_NAME = "number_lookup".freeze
+  end
+end

data/lib/telnyx/phone_number.rb

@@ -13,7 +13,7 @@ module Telnyx
                                   instance_methods: { list: "voice" }
     nested_resource_class_methods "messaging",
                                   path: ["messaging"],
-                                  operations: %i[update list],
+                                  operations: %i[update list retrieve],
                                   instance_methods: { list: "messaging" }
     nested_resource_class_methods "inbound_channel",
                                   path: ["inbound_channels"],
@@ -35,6 +35,14 @@ module Telnyx
       self.class.list_inbound_channels(nil).channels
     end
 
+    def self.list_voice
+      list_voices nil
+    end
+
+    def self.messaging
+      list_messagings(nil)
+    end
+
     OBJECT_NAME = "phone_number".freeze
   end
 end

data/lib/telnyx/phone_number_regulatory_requirement.rb

@@ -5,5 +5,6 @@ module Telnyx
     extend APIOperations::List
 
     OBJECT_NAME = "phone_number_regulatory_requirement".freeze
+    RESOURCE_PATH = "phone_numbers_regulatory_requirements".freeze
   end
 end

data/lib/telnyx/sim_card.rb

@@ -6,7 +6,7 @@ module Telnyx
     extend APIOperations::NestedResource
     extend APIOperations::List
 
-    ACTIONS = %w[deactivate activate].freeze
+    ACTIONS = %w[enable disable].freeze
     ACTIONS.each do |action|
       nested_resource_class_methods action,
                                     path: %W[actions #{action}],
@@ -20,5 +20,16 @@ module Telnyx
     end
 
     OBJECT_NAME = "sim_card".freeze
+
+    # depreciated api
+    def activate
+      warn "[DEPRECATION] SimCard#activate is deprecated, use enable instead."
+      enable
+    end
+
+    def deactivate
+      warn "[DEPRECATION] SimCard#deactivate is deprecated, use enable instead."
+      disable
+    end
   end
 end

data/lib/telnyx/telnyx_client.rb

@@ -240,7 +240,7 @@ module Telnyx
         end
 
         case e
-        when Faraday::ClientError
+        when Faraday::Error
           if e.response
             handle_error_response(e.response, error_context)
           else
@@ -310,30 +310,21 @@ module Telnyx
         json_body: resp.data,
       }
 
-      case resp.http_status
-      when 400
-        InvalidRequestError.new(error_list, opts)
-      when 401
-        AuthenticationError.new(error_list, opts)
-      when 403
-        PermissionError.new(error_list, opts)
-      when 404
-        ResourceNotFoundError.new(error_list, opts)
-      when 405
-        MethodNotSupportedError.new(error_list, opts)
-      when 408
-        TimeoutError.new(error_list, opts)
-      when 422
-        InvalidParametersError.new(error_list, opts)
-      when 429
-        RateLimitError.new(error_list, opts)
-      when 500
-        APIError.new(error_list, opts)
-      when 503
-        ServiceUnavailableError.new(error_list, opts)
-      else
-        APIError.new(error_list, opts)
-      end
+      err_class = case resp.http_status
+                  when 400 then InvalidRequestError
+                  when 401 then AuthenticationError
+                  when 403 then PermissionError
+                  when 404 then ResourceNotFoundError
+                  when 405 then MethodNotSupportedError
+                  when 408 then TimeoutError
+                  when 422 then InvalidParametersError
+                  when 429 then RateLimitError
+                  when 500 then APIError
+                  when 503 then ServiceUnavailableError
+                  else APIError
+                  end
+
+      err_class.new(error_list, **opts)
     end
 
     def handle_network_error(e, context, num_retries, api_base = nil)

data/lib/telnyx/util.rb

@@ -48,27 +48,33 @@ module Telnyx
         Conferences::OBJECT_NAME                      => Conferences,
         Connection::OBJECT_NAME                       => Connection,
         CredentialConnection::OBJECT_NAME             => CredentialConnection,
-        FQDNConnection::OBJECT_NAME                   => FQDNConnection,
+        Fax::OBJECT_NAME                              => Fax,
+        FaxApplication::OBJECT_NAME                   => FaxApplication,
         FQDN::OBJECT_NAME                             => FQDN,
+        FQDNConnection::OBJECT_NAME                   => FQDNConnection,
         IP::OBJECT_NAME                               => IP,
         IPConnection::OBJECT_NAME                     => IPConnection,
         Message::OBJECT_NAME                          => Message,
         MessagingPhoneNumber::OBJECT_NAME             => MessagingPhoneNumber,
+        "messaging_settings"                          => MessagingPhoneNumber,
         MessagingProfile::OBJECT_NAME                 => MessagingProfile,
+        NumberLookup::OBJECT_NAME                     => NumberLookup,
         NumberOrder::OBJECT_NAME                      => NumberOrder,
         NumberOrderDocument::OBJECT_NAME              => NumberOrderDocument,
-        "phone_number_reservation"                    => NumberReservation,
         NumberReservation::OBJECT_NAME                => NumberReservation,
+        OutboundVoiceProfile::OBJECT_NAME             => OutboundVoiceProfile,
         PhoneNumber::OBJECT_NAME                      => PhoneNumber,
+        "phone_number_reservation"                    => NumberReservation,
         PhoneNumberRegulatoryRequirement::OBJECT_NAME => PhoneNumberRegulatoryRequirement,
         "phone_number_regulatory_group"               => PhoneNumberRegulatoryRequirement,
         Portout::OBJECT_NAME                          => Portout,
+        VerifyProfile::OBJECT_NAME                    => VerifyProfile,
         PublicKey::OBJECT_NAME                        => PublicKey,
-        WirelessDetailRecordsReport::OBJECT_NAME      => WirelessDetailRecordsReport,
-        # 'phone_number_regulatory_group'             => RegulatoryRequirement,
         RegulatoryRequirement::OBJECT_NAME            => RegulatoryRequirement,
         SimCard::OBJECT_NAME                          => SimCard,
-        OutboundVoiceProfile::OBJECT_NAME             => OutboundVoiceProfile,
+        Verification::OBJECT_NAME                     => Verification,
+        "verification"                                => Verification::Response,
+        WirelessDetailRecordsReport::OBJECT_NAME      => WirelessDetailRecordsReport,
       }
     end
 
@@ -86,7 +92,7 @@ module Telnyx
     #
     # ==== Attributes
     #
-    # * +data+ - Hash of fields and values to be converted into a TelnyxObject.
+    # * +Data+ - Hash of fields and values to be converted into a TelnyxObject.
     # * +opts+ - Options for +TelnyxObject+ like an API key that will be reused
     #   on subsequent API calls.
     def self.convert_to_telnyx_object(data, opts = {})

data/lib/telnyx/verification.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class Verification < APIResource
+    # Type for verification responses
+    class Response < TelnyxObject; end
+
+    extend APIOperations::Create
+    extend APIOperations::NestedResource
+
+    nested_resource_class_methods "by_telephone",
+                                  path: "by_tn",
+                                  operations: [:retrieve],
+                                  instance_methods: {
+                                    retrieve: "by_telephone",
+                                  }
+
+    def self.submit_code(phone_number: nil, code: nil)
+      url = "#{resource_url}/by_phone_number/#{CGI.escape phone_number}/actions/verify"
+      resp, _opts = request(:post, url, code: code)
+      Response.construct_from resp.data[:data]
+    end
+
+    OBJECT_NAME = "verify_verification".freeze
+    RESOURCE_PATH = "verifications".freeze
+  end
+end

data/lib/telnyx/verify_profile.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class VerifyProfile < APIResource
+    extend APIOperations::List
+    extend APIOperations::Create
+    include APIOperations::Save
+
+    OBJECT_NAME = "verify_profile".freeze
+  end
+end

data/lib/telnyx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Telnyx
-  VERSION = "0.1.0".freeze
+  VERSION = "2.6.0".freeze
 end

data/telnyx.gemspec

@@ -22,8 +22,8 @@ Gem::Specification.new do |s|
     "source_code_uri"   => "https://github.com/team-telnyx/telnyx-ruby",
   }
 
-  s.add_dependency("faraday", "~> 0.13", "!= 0.16.0", "!= 0.16.1", "!= 0.16.2")
-  s.add_dependency("net-http-persistent", "~> 3.0")
+  s.add_dependency("faraday", ">= 0.13", "< 2.0", "!= 0.16.0", "!= 0.16.1", "!= 0.16.2", "!= 0.17.1")
+  s.add_dependency("net-http-persistent", ">= 3.0", "< 5.0")
   s.add_dependency("ed25519", "~> 1")
 
   s.files = `git ls-files`.split("\n")

data/test/telnyx/call_control_test.rb

@@ -66,95 +66,119 @@ module Telnyx
       should "send all commands" do
         @call = Call.new
         @call.id = "1234"
-        @call.reject
-        assert_requested :post, format_url(@call, "reject")
+        @call.reject cause: "CALL_REJECTED"
+        assert_requested :post, format_action_url(@call, "reject")
         @call.answer
-        assert_requested :post, format_url(@call, "answer")
+        assert_requested :post, format_action_url(@call, "answer")
         @call.hangup
-        assert_requested :post, format_url(@call, "hangup")
+        assert_requested :post, format_action_url(@call, "hangup")
         @call.bridge call_control_id: SecureRandom.base64(20)
-        assert_requested :post, format_url(@call, "bridge")
+        assert_requested :post, format_action_url(@call, "bridge")
         @call.speak language: "en-US", voice: "female", payload: "Telnyx call control test"
-        assert_requested :post, format_url(@call, "speak")
+        assert_requested :post, format_action_url(@call, "speak")
         @call.fork_start call_control_id: SecureRandom.base64(20)
-        assert_requested :post, format_url(@call, "fork_start")
+        assert_requested :post, format_action_url(@call, "fork_start")
         @call.fork_stop
-        assert_requested :post, format_url(@call, "fork_stop")
+        assert_requested :post, format_action_url(@call, "fork_stop")
         @call.gather_using_audio audio_url: "https://audio.example.com"
-        assert_requested :post, format_url(@call, "gather_using_audio")
+        assert_requested :post, format_action_url(@call, "gather_using_audio")
         @call.gather_using_speak language: "en-US", voice: "female", payload: "Telnyx call control test"
-        assert_requested :post, format_url(@call, "gather_using_speak")
+        assert_requested :post, format_action_url(@call, "gather_using_speak")
         @call.playback_start audio_url: "https://audio.example.com"
-        assert_requested :post, format_url(@call, "playback_start")
+        assert_requested :post, format_action_url(@call, "playback_start")
         @call.playback_stop
-        assert_requested :post, format_url(@call, "playback_stop")
+        assert_requested :post, format_action_url(@call, "playback_stop")
         @call.send_dtmf digits: "1www2WABCDw9"
-        assert_requested :post, format_url(@call, "send_dtmf")
+        assert_requested :post, format_action_url(@call, "send_dtmf")
         @call.transfer to: "+15552223333"
-        assert_requested :post, format_url(@call, "transfer")
+        assert_requested :post, format_action_url(@call, "transfer")
       end
     end
 
     context "commands" do
       should "reject" do
-        @call.reject
-        assert_requested :post, format_url(@call, "reject")
+        @call.reject cause: "CALL_REJECTED"
+        assert_requested :post, format_action_url(@call, "reject")
       end
       should "answer" do
         @call.answer
-        assert_requested :post, format_url(@call, "answer")
+        assert_requested :post, format_action_url(@call, "answer")
       end
       should "hangup" do
         @call.hangup
-        assert_requested :post, format_url(@call, "hangup")
+        assert_requested :post, format_action_url(@call, "hangup")
       end
       should "bridge" do
         @call.bridge call_control_id: SecureRandom.base64(20)
-        assert_requested :post, format_url(@call, "bridge")
+        assert_requested :post, format_action_url(@call, "bridge")
       end
       should "speak" do
         @call.speak language: "en-US", voice: "female", payload: "Telnyx call control test"
-        assert_requested :post, format_url(@call, "speak")
+        assert_requested :post, format_action_url(@call, "speak")
       end
       should "start fork" do
         @call.fork_start call_control_id: SecureRandom.base64(20)
-        assert_requested :post, format_url(@call, "fork_start")
+        assert_requested :post, format_action_url(@call, "fork_start")
       end
       should "stop fork" do
         @call.fork_stop
-        assert_requested :post, format_url(@call, "fork_stop")
+        assert_requested :post, format_action_url(@call, "fork_stop")
       end
       should "gather using audio" do
         @call.gather_using_audio audio_url: "https://audio.example.com"
-        assert_requested :post, format_url(@call, "gather_using_audio")
+        assert_requested :post, format_action_url(@call, "gather_using_audio")
       end
       should "gather using speak" do
         @call.gather_using_speak language: "en-US", voice: "female", payload: "Telnyx call control test"
-        assert_requested :post, format_url(@call, "gather_using_speak")
+        assert_requested :post, format_action_url(@call, "gather_using_speak")
       end
       should "playback start" do
         @call.playback_start audio_url: "https://audio.example.com"
-        assert_requested :post, format_url(@call, "playback_start")
+        assert_requested :post, format_action_url(@call, "playback_start")
       end
       should "playback stop" do
         @call.playback_stop
-        assert_requested :post, format_url(@call, "playback_stop")
+        assert_requested :post, format_action_url(@call, "playback_stop")
       end
       should "send dtmf" do
         @call.send_dtmf digits: "1www2WABCDw9"
-        assert_requested :post, format_url(@call, "send_dtmf")
+        assert_requested :post, format_action_url(@call, "send_dtmf")
       end
       should "transfer" do
         @call.transfer to: "+15552223333"
-        assert_requested :post, format_url(@call, "transfer")
+        assert_requested :post, format_action_url(@call, "transfer")
+      end
+      should "start transcription" do
+        @call.transcription_start
+        assert_requested :post, format_action_url(@call, "transcription_start")
+      end
+      should "end transcription" do
+        @call.transcription_stop
+        assert_requested :post, format_action_url(@call, "transcription_stop")
+      end
+      should "pause recording" do
+        @call.record_pause
+        assert_requested :post, format_action_url(@call, "record_pause")
+      end
+      should "resume recording" do
+        @call.record_resume
+        assert_requested :post, format_action_url(@call, "record_resume")
+      end
+      should "gather stop" do
+        @call.gather_stop
+        assert_requested :post, format_action_url(@call, "gather_stop")
+      end
+      should "refer" do
+        @call.refer sip_address: "sip:username@sip.non-telnyx-address.com"
+        assert_requested :post, format_action_url(@call, "refer")
       end
     end
 
     def create_call
-      Telnyx::Call.create connection_id: "12345", to: "+15550001111", from: "+15550002222"
+      Telnyx::Call.create connection_id: "12345", to: "+15550001111", from: "+15550002222", cause: "test"
     end
 
-    def format_url(call, action)
+    def format_action_url(call, action)
       "#{Telnyx.api_base}/v2/calls/#{call.call_control_id}/actions/#{action}"
     end
   end

data/test/telnyx/conference_test.rb

@@ -5,14 +5,19 @@ require_relative "../test_helper"
 module Telnyx
   class ConferenceTest < Test::Unit::TestCase
     setup do
-      @call = create_call
-      @conference = Conference.create call_control_id: @call.id, name: "conference!"
+      @conference = Conference.create call_control_id: "foobar", name: "conference!"
     end
     should "create conference" do
       assert_requested :post, "#{Telnyx.api_base}/v2/conferences"
       assert_kind_of Conference, @conference
     end
 
+    should "retrieve conference" do
+      conference = Conference.retrieve "foobar"
+      assert_kind_of Conference, conference
+      assert_requested :get, "#{Telnyx.api_base}/v2/conferences/foobar"
+    end
+
     should "list conferences" do
       conferences = Conference.list
 
@@ -21,47 +26,79 @@ module Telnyx
       assert_kind_of Conference, conferences.first
     end
 
+    should "list participants" do
+      participants = @conference.participants
+      assert_requested :get, "#{Telnyx.api_base}/v2/conferences/#{@conference.id}/participants"
+      assert_kind_of ListObject, participants
+    end
+
     should "have nested command instance methods" do
       assert defined? @conference.join
       assert defined? @conference.mute
       assert defined? @conference.unmute
       assert defined? @conference.unhold
+      assert defined? @conference.play
+      assert defined? @conference.start_recording
+      assert defined? @conference.stop_recording
+      assert defined? @conference.speak
+      assert defined? @conference.dial_participant
+      assert defined? @conference.update
     end
 
     context "commands" do
       should "join" do
-        stub = stub_request(:post, format_url(@conference, "join"))
-               .to_return(body: JSON.generate(result: "ok"))
-        @conference.join
-        assert_requested stub
+        @conference.join call_control_id: "foo_bar_baz"
+        assert_requested :post, action_url(@conference, "join")
       end
 
       should "mute" do
-        stub = stub_request(:post, format_url(@conference, "mute"))
-               .to_return(body: JSON.generate(result: "ok"))
         @conference.mute
-        assert_requested stub
+        assert_requested :post, action_url(@conference, "mute")
       end
 
       should "unmute" do
-        stub = stub_request(:post, format_url(@conference, "unmute"))
-               .to_return(body: JSON.generate(result: "ok"))
         @conference.unmute
-        assert_requested stub
+        assert_requested :post, action_url(@conference, "unmute")
       end
 
       should "hold" do
-        stub = stub_request(:post, format_url(@conference, "hold"))
-               .to_return(body: JSON.generate(result: "ok"))
         @conference.hold
-        assert_requested stub
+        assert_requested :post, action_url(@conference, "hold")
       end
 
       should "unhold" do
-        stub = stub_request(:post, format_url(@conference, "unhold"))
-               .to_return(body: JSON.generate(result: "ok"))
-        @conference.unhold
-        assert_requested stub
+        @conference.unhold call_control_ids: %w[foo bar baz]
+        assert_requested :post, action_url(@conference, "unhold")
+      end
+
+      should "play" do
+        @conference.play audio_url: "https://example.com/audio.mp3"
+        assert_requested :post, action_url(@conference, "play")
+      end
+
+      should "start recording" do
+        @conference.start_recording channels: "dual", format: "mp3"
+        assert_requested :post, action_url(@conference, "record_start")
+      end
+
+      should "stop recording" do
+        @conference.stop_recording
+        assert_requested :post, action_url(@conference, "record_stop")
+      end
+
+      should "speak" do
+        @conference.speak language: "en-US", payload: "test speech", voice: "female"
+        assert_requested :post, action_url(@conference, "speak")
+      end
+
+      should "dial participant" do
+        @conference.dial_participant call_control_id: "foo", to: "+12223334444", from: "+12223335555"
+        assert_requested :post, action_url(@conference, "dial_participant")
+      end
+
+      should "update" do
+        @conference.update call_control_id: "foo"
+        assert_requested :post, action_url(@conference, "update")
       end
     end
 
@@ -69,7 +106,7 @@ module Telnyx
       Telnyx::Call.create connection_id: "12345", to: "+15550001111", from: "+15550002222"
     end
 
-    def format_url(conf, action)
+    def action_url(conf, action)
       "#{Telnyx.api_base}/v2/conferences/#{conf.id}/actions/#{action}"
     end
   end