telnyx 2.3.0 → 2.4.0

data/lib/telnyx/telnyx_client.rb

@@ -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,12 +48,15 @@ module Telnyx
         Conferences::OBJECT_NAME                      => Conferences,
         Connection::OBJECT_NAME                       => Connection,
         CredentialConnection::OBJECT_NAME             => CredentialConnection,
+        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,
@@ -65,9 +68,12 @@ module Telnyx
         PhoneNumberRegulatoryRequirement::OBJECT_NAME => PhoneNumberRegulatoryRequirement,
         "phone_number_regulatory_group"               => PhoneNumberRegulatoryRequirement,
         Portout::OBJECT_NAME                          => Portout,
+        VerifyProfile::OBJECT_NAME                    => VerifyProfile,
         PublicKey::OBJECT_NAME                        => PublicKey,
         RegulatoryRequirement::OBJECT_NAME            => RegulatoryRequirement,
         SimCard::OBJECT_NAME                          => SimCard,
+        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 = "2.3.0".freeze
+  VERSION = "2.4.0".freeze
 end

data/telnyx.gemspec

@@ -22,7 +22,7 @@ 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("faraday", "~> 0.13", "!= 0.16.0", "!= 0.16.1", "!= 0.16.2", "!= 0.17.1")
   s.add_dependency("net-http-persistent", "~> 3.0")
   s.add_dependency("ed25519", "~> 1")
 

data/test/telnyx/call_control_test.rb

@@ -66,7 +66,7 @@ module Telnyx
       should "send all commands" do
         @call = Call.new
         @call.id = "1234"
-        @call.reject
+        @call.reject cause: "CALL_REJECTED"
         assert_requested :post, format_url(@call, "reject")
         @call.answer
         assert_requested :post, format_url(@call, "answer")
@@ -97,7 +97,7 @@ module Telnyx
 
     context "commands" do
       should "reject" do
-        @call.reject
+        @call.reject cause: "CALL_REJECTED"
         assert_requested :post, format_url(@call, "reject")
       end
       should "answer" do
@@ -151,7 +151,7 @@ module Telnyx
     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)

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

data/test/telnyx/credential_connection_test.rb

@@ -12,7 +12,11 @@ module Telnyx
     end
 
     should "create credential connection" do
-      CredentialConnection.create
+      CredentialConnection.create(
+        connection_name: "Test connection_name",
+        user_name: "Test user_name",
+        password: "correct-horse-battery-staple"
+      )
       assert_requested :post, "#{Telnyx.api_base}/v2/credential_connections"
     end
 

data/test/telnyx/fax_application_test.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+
+module Telnyx
+  class FaxApplicationTest < Test::Unit::TestCase
+    should "fetch index" do
+      fax_applications = FaxApplication.list
+      assert_requested :get, "#{Telnyx.api_base}/v2/fax_applications"
+      assert_kind_of ListObject, fax_applications
+      assert_kind_of FaxApplication, fax_applications.first
+    end
+
+    should "create" do
+      fax_application = FaxApplication.create application_name: "foo", webhook_event_url: "https://foo.bar.com"
+      assert_requested :post, "#{Telnyx.api_base}/v2/fax_applications"
+      assert_kind_of FaxApplication, fax_application
+    end
+
+    should "retrieve" do
+      fax_application = FaxApplication.retrieve "foo"
+      assert_requested :get, "#{Telnyx.api_base}/v2/fax_applications/foo"
+      assert_kind_of FaxApplication, fax_application
+    end
+
+    should "delete" do
+      fax_application = FaxApplication.retrieve "foo"
+      fax_application.delete
+      assert_requested :delete, "#{Telnyx.api_base}/v2/fax_applications/foo"
+    end
+  end
+end

data/test/telnyx/fax_test.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+module Telnyx
+  class FaxTest < Test::Unit::TestCase
+    should "fetch index" do
+      faxes = Fax.list
+      assert_requested :get, "#{Telnyx.api_base}/v2/faxes"
+      assert_kind_of ListObject, faxes
+      assert_kind_of Fax, faxes.first
+    end
+
+    should "send fax" do
+      fax = Fax.create connection_id: "foo", media_url: "example.com", to: "+13127367276"
+      assert_requested :post, "#{Telnyx.api_base}/v2/faxes"
+      assert_kind_of Fax, fax
+    end
+
+    should "view fax" do
+      fax = Fax.retrieve "foo"
+      assert_requested :get, "#{Telnyx.api_base}/v2/faxes/foo"
+      assert_kind_of Fax, fax
+    end
+
+    should "delete fax" do
+      omit "!!waiting for mock!!"
+      fax = Fax.retrieve "foo"
+      fax.delete
+      assert_requested :delete, "#{Telnyx.api_base}/v2/faxes/foo"
+    end
+  end
+end

data/test/telnyx/fqdn_connection_test.rb

@@ -12,7 +12,7 @@ module Telnyx
     end
 
     should "create fqdn connection" do
-      FQDNConnection.create
+      FQDNConnection.create(connection_name: "test")
       assert_requested :post, "#{Telnyx.api_base}/v2/fqdn_connections"
     end
 

data/test/telnyx/fqdn_test.rb

@@ -12,7 +12,7 @@ module Telnyx
     end
 
     should "create fqdn" do
-      FQDN.create fqdn: "example.com"
+      FQDN.create fqdn: "example.com", dns_record_type: "A", connection_id: "abc"
       assert_requested :post, "#{Telnyx.api_base}/v2/fqdns"
     end
 

data/test/telnyx/messaging_phone_number_test.rb

@@ -6,14 +6,16 @@ module Telnyx
   class MessagingPhoneNumberTest < Test::Unit::TestCase
     should "be listable" do
       messaging_phone_numbers = Telnyx::MessagingPhoneNumber.list
-      assert_requested :get, "#{Telnyx.api_base}/v2/messaging_phone_numbers"
+      # assert_requested :get, "#{Telnyx.api_base}/v2/messaging_phone_numbers"
+      assert_requested :get, "#{Telnyx.api_base}/v2/phone_numbers/messaging"
       assert messaging_phone_numbers.data.is_a?(Array)
       assert messaging_phone_numbers.first.is_a?(Telnyx::MessagingPhoneNumber)
     end
 
     should "be retrievable" do
       messaging_phone_number = Telnyx::MessagingPhoneNumber.retrieve("123")
-      assert_requested :get, "#{Telnyx.api_base}/v2/messaging_phone_numbers/123"
+      # assert_requested :get, "#{Telnyx.api_base}/v2/messaging_phone_numbers/123"
+      assert_requested :get, "#{Telnyx.api_base}/v2/phone_numbers/123/messaging"
       assert messaging_phone_number.is_a?(Telnyx::MessagingPhoneNumber)
     end
 
@@ -21,12 +23,14 @@ module Telnyx
       messaging_phone_number = Telnyx::MessagingPhoneNumber.retrieve("123")
       messaging_phone_number.messaging_profile_id = "value"
       messaging_phone_number.save
-      assert_requested :patch, "#{Telnyx.api_base}/v2/messaging_phone_numbers/#{messaging_phone_number.id}"
+      # assert_requested :patch, "#{Telnyx.api_base}/v2/messaging_phone_numbers/#{messaging_phone_number.id}"
+      assert_requested :patch, "#{Telnyx.api_base}/v2/phone_numbers/#{messaging_phone_number.id}/messaging"
     end
 
     should "be updateable" do
       messaging_phone_number = Telnyx::MessagingPhoneNumber.update("123", messaging_profile_id: "456")
-      assert_requested :patch, "#{Telnyx.api_base}/v2/messaging_phone_numbers/123"
+      # assert_requested :patch, "#{Telnyx.api_base}/v2/messaging_phone_numbers/123"
+      assert_requested :patch, "#{Telnyx.api_base}/v2/phone_numbers/123/messaging"
       assert messaging_phone_number.is_a?(Telnyx::MessagingPhoneNumber)
     end
   end

data/test/telnyx/messaging_profile_test.rb

@@ -58,7 +58,7 @@ module Telnyx
       phone_numbers = messaging_profile.phone_numbers
       assert_requested :get, "#{Telnyx.api_base}/v2/messaging_profiles/123/phone_numbers"
       assert phone_numbers.data.is_a?(Array)
-      assert phone_numbers.data[0].is_a?(Telnyx::MessagingPhoneNumber)
+      assert_kind_of Telnyx::MessagingPhoneNumber, phone_numbers.data[0]
     end
 
     should "be able to list alphanumeric sender ids" do