telnyx 2.9.0 → 3.0.1

data/lib/telnyx/sim_card.rb

@@ -6,20 +6,45 @@ module Telnyx
     extend APIOperations::NestedResource
     extend APIOperations::List
 
-    ACTIONS = %w[enable disable].freeze
+    ACTIONS = %w[enable disable set_standby public_ip wireless_connectivity_logs device_details set_public_ip set_network_preferences remove_public_ip delete_network_preferences].freeze
     ACTIONS.each do |action|
       nested_resource_class_methods action,
                                     path: %W[actions #{action}],
                                     operations: [:create],
                                     instance_methods: { create: action }
     end
+    nested_resource_class_methods :device_details,
+                                  path: ["device_details"],
+                                  operations: %i[list],
+                                  instance_methods: { list: "device_details" }
+    nested_resource_class_methods :activation_code,
+                                  path: ["activation_code"],
+                                  operations: %i[list],
+                                  instance_methods: { list: "activation_code" }
 
     def self.register(params = {}, opts = {})
       resp, opts = request(:post, "/v2/actions/register/sim_cards", params, opts)
       Util.convert_to_telnyx_object(resp.data, opts)
     end
 
-    OBJECT_NAME = "sim_card".freeze
+    # Additional action to validate registration codes
+    def self.validate_registration_codes(params = {}, opts = {})
+      opts = Util.normalize_opts(opts)
+      resp, opts = request(:post, "/v2/sim_cards/actions/validate_registration_codes", params, opts)
+      Util.convert_to_telnyx_object(resp.data, opts)
+    end
+
+    # Additional action to bulk_set_public_ips
+    def self.bulk_set_public_ips(params = {}, opts = {})
+      opts = Util.normalize_opts(opts)
+      resp, opts = request(:post, "/v2/sim_cards/actions/bulk_set_public_ips", params, opts)
+      Util.convert_to_telnyx_object(resp.data, opts)
+    end
+
+    def self.network_preferences(params = {}, opts = {})
+      resp, opts = request(:put, "/v2/actions/network_preferences/sim_cards", params, opts)
+      Util.convert_to_telnyx_object(resp.data, opts)
+    end
 
     # depreciated api
     def activate
@@ -31,5 +56,6 @@ module Telnyx
       warn "[DEPRECATION] SimCard#deactivate is deprecated, use enable instead."
       disable
     end
+    OBJECT_NAME = "sim_card".freeze
   end
 end

data/lib/telnyx/sim_card_action.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class SimCardAction < APIResource
+    extend APIOperations::List
+    extend APIOperations::Create
+    include APIOperations::Delete
+    include APIOperations::Save
+
+    OBJECT_NAME = "sim_card_actions".freeze
+  end
+end

data/lib/telnyx/sim_card_data_usage_notification.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class SimCardDataUsageNotification < APIResource
+    extend APIOperations::List
+    extend APIOperations::Create
+    include APIOperations::Delete
+    include APIOperations::Save
+
+    OBJECT_NAME = "sim_card_data_usage_notification".freeze
+  end
+end

data/lib/telnyx/sim_card_group.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class SimCardGroup < APIResource
+    extend APIOperations::List
+    extend APIOperations::Create
+    include APIOperations::Delete
+    include APIOperations::Save
+    extend APIOperations::NestedResource
+
+    ACTIONS = %w[set_private_wireless_gateway remove_private_wireless_gateway].freeze
+    ACTIONS.each do |action|
+      nested_resource_class_methods action,
+                                    path: %W[actions #{action}],
+                                    operations: [:create],
+                                    instance_methods: { create: action }
+    end
+
+    OBJECT_NAME = "sim_card_group".freeze
+  end
+end

data/lib/telnyx/sim_card_group_action.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class SimCardGroupAction < APIResource
+    extend APIOperations::List
+    OBJECT_NAME = "sim_card_group_action".freeze
+  end
+end

data/lib/telnyx/sim_card_order.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class SimCardOrder < APIResource
+    extend APIOperations::List
+    extend APIOperations::Create
+
+    OBJECT_NAME = "sim_card_order".freeze
+  end
+end

data/lib/telnyx/summary.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class Summary < APIResource
+    extend Telnyx::APIOperations::Create
+
+    OBJECT_NAME = "ai/summarize".freeze
+  end
+end

data/lib/telnyx/telephony_credential.rb

@@ -6,6 +6,28 @@ module Telnyx
     extend Telnyx::APIOperations::Create
     include Telnyx::APIOperations::Save
     include Telnyx::APIOperations::Delete
+    extend APIOperations::NestedResource
+    ACTIONS = %w[activate deactivate].freeze
+
+    ACTIONS.each do |action|
+      nested_resource_class_methods action,
+                                    path: %W[actions #{action}],
+                                    operations: [:create],
+                                    instance_methods: { create: action }
+    end
+
+    %w[token].each do |action|
+      nested_resource_class_methods action,
+                                    path: %W[#{action}],
+                                    operations: [:create],
+                                    instance_methods: { create: action }
+    end
+    # Additional action to list tags
+    def self.tags(params = {}, opts = {})
+      opts = Util.normalize_opts(opts)
+      resp, opts = request(:get, "/v2/telephony_credentials/tags", params, opts)
+      ListObject.construct_from(resp.data, opts)
+    end
 
     OBJECT_NAME = "telephony_credential".freeze
   end

data/lib/telnyx/telnyx_client.rb

@@ -32,7 +32,6 @@ module Telnyx
       # object per thread.
       Thread.current[:telnyx_client_default_conn] ||= begin
         conn = Faraday.new do |builder|
-          builder.use Faraday::Request::Multipart
           builder.use Faraday::Request::UrlEncoded
           builder.use Faraday::Response::RaiseError
 
@@ -411,7 +410,7 @@ module Telnyx
                      body: body,
                      request_id: context.request_id)
 
-      return unless context.request_id
+      nil unless context.request_id
     end
     private :log_response
 

data/lib/telnyx/texml_application.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class TexmlApplication < APIResource
+    extend Telnyx::APIOperations::List
+
+    OBJECT_NAME = "texml_application".freeze
+  end
+end

data/lib/telnyx/verification.rb

@@ -19,9 +19,9 @@ module Telnyx
                                     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)
+    def self.submit_code(params = {})
+      url = "#{resource_url}/by_phone_number/#{CGI.escape params[:phone_number]}/actions/verify"
+      resp, _opts = request(:post, url, params)
       Response.construct_from resp.data[:data]
     end
 

data/lib/telnyx/verified_calls_display_profile.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class VerifiedCallsDisplayProfile < APIResource
+    extend APIOperations::List
+    extend APIOperations::NestedResource
+
+    %w[verification_request].each do |action|
+      nested_resource_class_methods action,
+                                    path: %W[#{action}],
+                                    operations: [:create],
+                                    instance_methods: { create: action }
+    end
+
+    OBJECT_NAME = "verified_calls_display_profile".freeze
+  end
+end

data/lib/telnyx/verify_profile.rb

@@ -5,6 +5,7 @@ module Telnyx
     extend APIOperations::List
     extend APIOperations::Create
     include APIOperations::Save
+    include APIOperations::Delete
 
     OBJECT_NAME = "verify_profile".freeze
   end

data/lib/telnyx/version.rb

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

data/lib/telnyx/virtual_cross_connect.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class VirtualCrossConnect < APIResource
+    include APIOperations::Delete
+    include APIOperations::Save
+    extend APIOperations::List
+    extend APIOperations::Create
+    extend APIOperations::NestedResource
+    ACTIONS = %w[provision].freeze
+    ACTIONS.each do |action|
+      nested_resource_class_methods action,
+                                    path: %W[actions #{action}],
+                                    operations: [:create],
+                                    instance_methods: { create: action }
+    end
+
+    OBJECT_NAME = "virtual_cross_connect".freeze
+  end
+end

data/lib/telnyx/virtual_cross_connect_region.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class VirtualCrossConnectRegion < APIResource
+    extend APIOperations::List
+
+    OBJECT_NAME = "virtual_cross_connect_region".freeze
+  end
+end

data/lib/telnyx/wdr.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class Wdr < APIResource
+    extend APIOperations::List
+    def self.resource_path(id = nil)
+      return "reports/wdrs/#{CGI.escape(id)}" if id
+
+      "reports/wdrs"
+    end
+    OBJECT_NAME = "/reports/wdr".freeze
+  end
+end

data/lib/telnyx/webhook_deliverie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class WebhookDeliverie < APIResource
+    extend APIOperations::List
+
+    OBJECT_NAME = "webhook_deliverie".freeze
+  end
+end

data/lib/telnyx/wireguard_interface.rb

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

data/lib/telnyx/wireguard_peer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class WireguardPeer < APIResource
+    include APIOperations::Delete
+    include APIOperations::Save
+    extend APIOperations::List
+    extend APIOperations::Create
+    extend APIOperations::NestedResource
+    nested_resource_class_methods "config",
+                                  path: "config",
+                                  operations: [:list],
+                                  instance_methods: { list: "config" }
+    nested_resource_class_methods "allowed_ips",
+                                  path: "allowed_ips",
+                                  operations: [:list],
+                                  instance_methods: { list: "allowed_ips" }
+
+    OBJECT_NAME = "wireguard_peer".freeze
+  end
+end

data/lib/telnyx.rb

@@ -4,6 +4,9 @@
 # API spec at https://developers.telnyx.com
 require "cgi"
 require "faraday"
+require "faraday/retry"
+require "faraday/multipart"
+require "faraday/net_http_persistent"
 require "json"
 require "logger"
 require "openssl"
@@ -46,33 +49,94 @@ require "telnyx/conference"
 require "telnyx/connection"
 require "telnyx/credential_connection"
 require "telnyx/event"
-require "telnyx/fax"
 require "telnyx/fax_application"
+require "telnyx/fax"
 require "telnyx/fqdn_connection"
 require "telnyx/fqdn"
 require "telnyx/ip_connection"
 require "telnyx/ip"
 require "telnyx/message"
+require "telnyx/message_number_pool"
 require "telnyx/messaging_phone_number"
 require "telnyx/messaging_profile"
+require "telnyx/mobile_operator_network"
+require "telnyx/network"
+require "telnyx/region"
 require "telnyx/number_lookup"
 require "telnyx/number_order_document"
 require "telnyx/number_order"
 require "telnyx/number_reservation"
+require "telnyx/ota_update"
 require "telnyx/outbound_voice_profile"
 require "telnyx/phone_number_regulatory_requirement"
 require "telnyx/phone_number"
-require "telnyx/portout"
 require "telnyx/porting_order"
+require "telnyx/portout"
 require "telnyx/public_key"
-require "telnyx/queue"
 require "telnyx/queue_call"
+require "telnyx/queue"
 require "telnyx/regulatory_requirement"
 require "telnyx/sim_card"
 require "telnyx/telephony_credential"
 require "telnyx/verification"
 require "telnyx/verify_profile"
 require "telnyx/wireless_detail_records_report"
+require "telnyx/room_composition"
+require "telnyx/room_participant"
+require "telnyx/room_recording"
+require "telnyx/room_session"
+require "telnyx/room"
+require "telnyx/wireguard_interface"
+require "telnyx/short_code"
+require "telnyx/wireguard_peer"
+require "telnyx/virtual_cross_connect_region"
+require "telnyx/virtual_cross_connect"
+require "telnyx/sim_card_group"
+require "telnyx/sim_card_order"
+require "telnyx/sim_card_group_action"
+require "telnyx/sim_card_data_usage_notification"
+require "telnyx/requirement_type"
+require "telnyx/requirement"
+require "telnyx/batch_mdr_report"
+require "telnyx/cdr_usage_report"
+require "telnyx/mdr_usage_report"
+require "telnyx/inference"
+require "telnyx/summary"
+require "telnyx/call_recording"
+require "telnyx/public_internet_gateway"
+require "telnyx/private_wireless_gateway"
+require "telnyx/csv_download"
+require "telnyx/number_block_order"
+require "telnyx/mobile_push_credential"
+require "telnyx/messaging_tollfree_verification"
+require "telnyx/phone_number_block_job"
+require "telnyx/wdr"
+require "telnyx/embedding"
+require "telnyx/webhook_deliverie"
+require "telnyx/call_event"
+require "telnyx/messaging_url_domain"
+require "telnyx/verified_calls_display_profile"
+require "telnyx/detail_record"
+require "telnyx/business_identitie"
+require "telnyx/managed_account"
+require "telnyx/ledger_billing_group_report"
+require "telnyx/global_ip"
+require "telnyx/global_ip_usage"
+require "telnyx/global_ip_protocol"
+require "telnyx/global_ip_latency"
+require "telnyx/global_ip_assignment"
+require "telnyx/global_ip_assignment_health"
+require "telnyx/global_ip_assignment_usage"
+require "telnyx/global_ip_allowed_port"
+require "telnyx/dialogflow_connection"
+require "telnyx/channel_zone"
+require "telnyx/bulk_sim_card_action"
+require "telnyx/campaign"
+require "telnyx/comment"
+require "telnyx/enum"
+require "telnyx/custom_storage_credential"
+require "telnyx/texml_application"
+require "telnyx/bulk_credential"
 
 module Telnyx
   @app_info = nil

data/server.js

@@ -0,0 +1,31 @@
+const http = require('http');
+const httpProxy = require('http-proxy');
+
+// Create a proxy server with custom application logic
+const proxy = httpProxy.createProxyServer({});
+
+// Your Prism mock server URL
+const PRISM_MOCK_SERVER = 'http://127.0.0.1:4010'; // Replace with your Prism mock server URL
+
+// Create your server that makes an operation on the request
+const server = http.createServer((req, res) => {
+  // Modify the URL by removing the '/v2' prefix
+  req.url = req.url.replace(/^\/v2(\/|$)/, '/');
+
+  // Forward the modified request to the Prism mock server
+  proxy.web(req, res, { target: PRISM_MOCK_SERVER });
+});
+
+// Listen to the `error` event and log it
+proxy.on('error', (err, req, res) => {
+  console.error('Proxy error:', err);
+  res.end();
+});
+
+// Choose the port for the proxy server
+const PORT = 8000; // You can choose any available port
+
+// Start the server
+server.listen(PORT, () => {
+  console.log(`Proxy server listening on port ${PORT}`);
+});

data/telnyx.gemspec

@@ -7,7 +7,7 @@ require "telnyx/version"
 Gem::Specification.new do |s|
   s.name = "telnyx"
   s.version = Telnyx::VERSION
-  s.required_ruby_version = ">= 2.1.0"
+  s.required_ruby_version = ">= 3.0.0"
   s.summary = "Ruby bindings for the Telnyx API"
   s.description = "Telnyx enables anyone to deliver enterprise-grade real-time communications over the internet. See https://telnyx.com for details."
   s.author = "Telnyx"
@@ -22,7 +22,9 @@ Gem::Specification.new do |s|
     "source_code_uri"   => "https://github.com/team-telnyx/telnyx-ruby",
   }
 
-  s.add_dependency("faraday", ">= 0.13", "< 2.0", "!= 0.16.0", "!= 0.16.1", "!= 0.16.2", "!= 0.17.1")
+  s.add_dependency("faraday", ">= 2.5.0")
+  s.add_dependency("faraday-multipart", "~> 1.0.4")
+  s.add_dependency("faraday-net_http_persistent", "~> 2.1.0")
   s.add_dependency("net-http-persistent", ">= 3.0", "< 5.0")
   s.add_dependency("ed25519", "~> 1")
 

data/test/openapi/README.md

@@ -1,9 +1,36 @@
-## Using custom OpenAPI specification and fixtures files
+# Using custom OpenAPI specification and fixtures files
 
 You can place custom OpenAPI specification and fixtures files in this
 directory. The files must be in JSON format, and must be named `spec3.json`
 and `fixtures3.json` respectively.
 
-If those files are present, the test suite will start its own telnyx-mock
-process on a random available port. In order for this to work, `telnyx-mock`
-must be on the `PATH` in the environment used to run the test suite.
+## Development
+
+### Setup
+The test suite depends on the [Prism Mock Server](https://github.com/stoplightio/prism).
+
+```bash
+npm install -g @stoplight/prism-cli
+
+# OR
+
+yarn global add @stoplight/prism-cli
+```
+
+Once installed, start the prism mock service with the following command:
+
+```bash
+prism mock https://raw.githubusercontent.com/team-telnyx/openapi/master/openapi/spec3.json
+```
+
+--------
+
+One final step -- because the Ruby SDK originally expected to reach the legacy `telnyx-mock` service at port 12111 (in addition to providing a `/v2/` base path), we need to setup a proxy server.
+
+You can do this any way you wish, but included is a server.js file which you can utilize:
+
+```bash
+# In new terminal window
+
+node server.js
+```