twilio-ruby 5.19.0 → 5.74.2

data/lib/twilio-ruby/rest/voice/v1.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,13 +15,102 @@ module Twilio
         def initialize(domain)
           super
           @version = 'v1'
-          @voice_permissions = nil
+          @archived_calls = nil
+          @byoc_trunks = nil
+          @connection_policies = nil
+          @dialing_permissions = nil
+          @ip_records = nil
+          @source_ip_mappings = nil
         end
 
         ##
-        # @return [Twilio::REST::Voice::V1::VoicePermissionContext]
-        def voice_permissions
-          @voice_permissions ||= VoicePermissionList.new self
+        # @param [Date] date The date of the Call in UTC.
+        # @param [String] sid The Twilio-provided Call SID that uniquely identifies the
+        #   Call resource to delete
+        # @return [Twilio::REST::Voice::V1::ArchivedCallContext] if sid was passed.
+        # @return [Twilio::REST::Voice::V1::ArchivedCallList]
+        def archived_calls(date=:unset, sid=:unset)
+          if date.nil?
+              raise ArgumentError, 'date cannot be nil'
+          end
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if date == :unset && sid == :unset
+              @archived_calls ||= ArchivedCallList.new self
+          else
+              ArchivedCallContext.new(self, date, sid)
+          end
+        end
+
+        ##
+        # @param [String] sid The Twilio-provided string that uniquely identifies the BYOC
+        #   Trunk resource to fetch.
+        # @return [Twilio::REST::Voice::V1::ByocTrunkContext] if sid was passed.
+        # @return [Twilio::REST::Voice::V1::ByocTrunkList]
+        def byoc_trunks(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @byoc_trunks ||= ByocTrunkList.new self
+          else
+              ByocTrunkContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @param [String] sid The unique string that we created to identify the Connection
+        #   Policy resource to fetch.
+        # @return [Twilio::REST::Voice::V1::ConnectionPolicyContext] if sid was passed.
+        # @return [Twilio::REST::Voice::V1::ConnectionPolicyList]
+        def connection_policies(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @connection_policies ||= ConnectionPolicyList.new self
+          else
+              ConnectionPolicyContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @return [Twilio::REST::Voice::V1::DialingPermissionsContext]
+        def dialing_permissions
+          @dialing_permissions ||= DialingPermissionsList.new self
+        end
+
+        ##
+        # @param [String] sid The Twilio-provided string that uniquely identifies the IP
+        #   Record resource to fetch.
+        # @return [Twilio::REST::Voice::V1::IpRecordContext] if sid was passed.
+        # @return [Twilio::REST::Voice::V1::IpRecordList]
+        def ip_records(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @ip_records ||= IpRecordList.new self
+          else
+              IpRecordContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @param [String] sid The Twilio-provided string that uniquely identifies the IP
+        #   Record resource to fetch.
+        # @return [Twilio::REST::Voice::V1::SourceIpMappingContext] if sid was passed.
+        # @return [Twilio::REST::Voice::V1::SourceIpMappingList]
+        def source_ip_mappings(sid=:unset)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @source_ip_mappings ||= SourceIpMappingList.new self
+          else
+              SourceIpMappingContext.new(self, sid)
+          end
         end
 
         ##

data/lib/twilio-ruby/rest/voice.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -29,9 +29,53 @@ module Twilio
       end
 
       ##
-      # @return [Twilio::REST::Voice::V1::VoicePermissionInstance]
-      def voice_permissions
-        self.v1.voice_permissions()
+      # @param [String] sid The call sid
+      # @return [Twilio::REST::Voice::V1::ArchivedCallInstance] if sid was passed.
+      # @return [Twilio::REST::Voice::V1::ArchivedCallList]
+      def archived_calls(date=:unset, sid=:unset)
+        self.v1.archived_calls(date, sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that that we created to identify the BYOC
+      #   Trunk resource.
+      # @return [Twilio::REST::Voice::V1::ByocTrunkInstance] if sid was passed.
+      # @return [Twilio::REST::Voice::V1::ByocTrunkList]
+      def byoc_trunks(sid=:unset)
+        self.v1.byoc_trunks(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the Connection
+      #   Policy resource.
+      # @return [Twilio::REST::Voice::V1::ConnectionPolicyInstance] if sid was passed.
+      # @return [Twilio::REST::Voice::V1::ConnectionPolicyList]
+      def connection_policies(sid=:unset)
+        self.v1.connection_policies(sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Voice::V1::DialingPermissionsInstance]
+      def dialing_permissions
+        self.v1.dialing_permissions()
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the IP Record
+      #   resource.
+      # @return [Twilio::REST::Voice::V1::IpRecordInstance] if sid was passed.
+      # @return [Twilio::REST::Voice::V1::IpRecordList]
+      def ip_records(sid=:unset)
+        self.v1.ip_records(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the IP Record
+      #   resource.
+      # @return [Twilio::REST::Voice::V1::SourceIpMappingInstance] if sid was passed.
+      # @return [Twilio::REST::Voice::V1::SourceIpMappingList]
+      def source_ip_mappings(sid=:unset)
+        self.v1.source_ip_mappings(sid)
       end
 
       ##

data/lib/twilio-ruby/rest/wireless/v1/command.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -27,12 +27,14 @@ module Twilio
           # Lists CommandInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
-          # @param [String] sim Only return Commands to or from this SIM.
-          # @param [command.Status] status Only return Commands with this status value.
+          # @param [String] sim The `sid` or `unique_name` of the {Sim
+          #   resources}[https://www.twilio.com/docs/wireless/api/sim-resource] to read.
+          # @param [command.Status] status The status of the resources to read. Can be:
+          #   `queued`, `sent`, `delivered`, `received`, or `failed`.
           # @param [command.Direction] direction Only return Commands with this direction
           #   value.
           # @param [command.Transport] transport Only return Commands with this transport
-          #   value.
+          #   value. Can be: `sms` or `ip`.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
           #    guarantees to never return more than limit.  Default is no limit
           # @param [Integer] page_size Number of records to fetch per request, when
@@ -55,12 +57,14 @@ module Twilio
           # Streams CommandInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
-          # @param [String] sim Only return Commands to or from this SIM.
-          # @param [command.Status] status Only return Commands with this status value.
+          # @param [String] sim The `sid` or `unique_name` of the {Sim
+          #   resources}[https://www.twilio.com/docs/wireless/api/sim-resource] to read.
+          # @param [command.Status] status The status of the resources to read. Can be:
+          #   `queued`, `sent`, `delivered`, `received`, or `failed`.
           # @param [command.Direction] direction Only return Commands with this direction
           #   value.
           # @param [command.Transport] transport Only return Commands with this transport
-          #   value.
+          #   value. Can be: `sms` or `ip`.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
           #    guarantees to never return more than limit. Default is no limit.
           # @param [Integer] page_size Number of records to fetch per request, when
@@ -99,12 +103,14 @@ module Twilio
           ##
           # Retrieve a single page of CommandInstance records from the API.
           # Request is executed immediately.
-          # @param [String] sim Only return Commands to or from this SIM.
-          # @param [command.Status] status Only return Commands with this status value.
+          # @param [String] sim The `sid` or `unique_name` of the {Sim
+          #   resources}[https://www.twilio.com/docs/wireless/api/sim-resource] to read.
+          # @param [command.Status] status The status of the resources to read. Can be:
+          #   `queued`, `sent`, `delivered`, `received`, or `failed`.
           # @param [command.Direction] direction Only return Commands with this direction
           #   value.
           # @param [command.Transport] transport Only return Commands with this transport
-          #   value.
+          #   value. Can be: `sms` or `ip`.
           # @param [String] page_token PageToken provided by the API
           # @param [Integer] page_number Page Number, this value is simply for client state
           # @param [Integer] page_size Number of records to return, defaults to 50
@@ -119,11 +125,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             CommandPage.new(@version, response, @solution)
           end
 
@@ -141,34 +145,32 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of CommandInstance records from the API.
-          # Request is executed immediately.
-          # @param [String] command The message body of the Command (in text mode) or a
-          #   Base64 encoded byte string in binary mode.
-          # @param [String] sim The Sid or UniqueName of the
-          #   [SIM](https://www.twilio.com/docs/api/wireless/rest-api/sim) to send the Command
+          # Create the CommandInstance
+          # @param [String] command The message body of the Command. Can be plain text in
+          #   text mode or a Base64 encoded byte string in binary mode.
+          # @param [String] sim The `sid` or `unique_name` of the
+          #   {SIM}[https://www.twilio.com/docs/wireless/api/sim-resource] to send the Command
           #   to.
-          # @param [String] callback_method The HTTP method Twilio will use when making a
-          #   request to the callback URL (valid options are GET or POST). Defaults to POST.
-          # @param [String] callback_url Twilio will make a request to this URL when the
-          #   Command has finished sending (delivered or failed).
-          # @param [command.CommandMode] command_mode A string representing which mode to
-          #   send the SMS message using. May be `text` or `binary`. If omitted, the default
-          #   SMS mode is `text`.
-          # @param [String] include_sid When sending a Command to a SIM in text mode, Twilio
-          #   can automatically include the Sid of the Command in the message body, which
-          #   could be used to ensure that the device does not process the same Command more
-          #   than once. The options for inclusion are `none`, `start` and `end`. The default
-          #   behavior is `none`. When using `start` or `end`, the CommandSid will be
-          #   prepended or appended to the message body, with a space character separating the
-          #   CommandSid and the message body. The length of the CommandSid contributes toward
-          #   the 160 character limit, i.e. the SMS body must be 128 characters or less before
-          #   the Command Sid is included.
-          # @param [Boolean] delivery_receipt_requested A boolean representing whether to
-          #   request delivery receipt from the recipient. For Commands that request delivery
-          #   receipt, the Command state transitions to 'delivered' once the server has
-          #   received a delivery receipt from the device. Defaults to true.
-          # @return [CommandInstance] Newly created CommandInstance
+          # @param [String] callback_method The HTTP method we use to call `callback_url`.
+          #   Can be: `POST` or `GET`, and the default is `POST`.
+          # @param [String] callback_url The URL we call using the `callback_url` when the
+          #   Command has finished sending, whether the command was delivered or it failed.
+          # @param [command.CommandMode] command_mode The mode to use when sending the SMS
+          #   message. Can be: `text` or `binary`. The default SMS mode is `text`.
+          # @param [String] include_sid Whether to include the SID of the command in the
+          #   message body. Can be: `none`, `start`, or `end`, and the default behavior is
+          #   `none`. When sending a Command to a SIM in text mode, we can automatically
+          #   include the SID of the Command in the message body, which could be used to
+          #   ensure that the device does not process the same Command more than once.  A
+          #   value of `start` will prepend the message with the Command SID, and `end` will
+          #   append it to the end, separating the Command SID from the message body with a
+          #   space. The length of the Command SID is included in the 160 character limit so
+          #   the SMS body must be 128 characters or less before the Command SID is included.
+          # @param [Boolean] delivery_receipt_requested Whether to request delivery receipt
+          #   from the recipient. For Commands that request delivery receipt, the Command
+          #   state transitions to 'delivered' once the server has received a delivery receipt
+          #   from the device. The default value is `true`.
+          # @return [CommandInstance] Created CommandInstance
           def create(command: nil, sim: :unset, callback_method: :unset, callback_url: :unset, command_mode: :unset, include_sid: :unset, delivery_receipt_requested: :unset)
             data = Twilio::Values.of({
                 'Command' => command,
@@ -180,11 +182,7 @@ module Twilio
                 'DeliveryReceiptRequested' => delivery_receipt_requested,
             })
 
-            payload = @version.create(
-                'POST',
-                @uri,
-                data: data
-            )
+            payload = @version.create('POST', @uri, data: data)
 
             CommandInstance.new(@version, payload, )
           end
@@ -229,8 +227,7 @@ module Twilio
           ##
           # Initialize the CommandContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid A 34 character string that uniquely identifies this
-          #   resource.
+          # @param [String] sid The SID of the Command resource to fetch.
           # @return [CommandContext] CommandContext
           def initialize(version, sid)
             super(version)
@@ -241,25 +238,19 @@ module Twilio
           end
 
           ##
-          # Fetch a CommandInstance
+          # Fetch the CommandInstance
           # @return [CommandInstance] Fetched CommandInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             CommandInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the CommandInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the CommandInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
@@ -268,6 +259,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Wireless.V1.CommandContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Wireless.V1.CommandContext #{context}>"
+          end
         end
 
         class CommandInstance < InstanceResource
@@ -275,8 +273,7 @@ module Twilio
           # Initialize the CommandInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid A 34 character string that uniquely identifies this
-          #   resource.
+          # @param [String] sid The SID of the Command resource to fetch.
           # @return [CommandInstance] CommandInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -314,87 +311,87 @@ module Twilio
           end
 
           ##
-          # @return [String] A 34 character string that uniquely identifies this resource.
+          # @return [String] The unique string that identifies the resource
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] The unique id of the Account that this Command belongs to.
+          # @return [String] The SID of the Account that created the resource
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The unique ID of the SIM that this Command was sent to or from.
+          # @return [String] The SID of the Sim resource that the Command was sent to or from
           def sim_sid
             @properties['sim_sid']
           end
 
           ##
-          # @return [String] The message being sent to or from the SIM.
+          # @return [String] The message being sent to or from the SIM
           def command
             @properties['command']
           end
 
           ##
-          # @return [command.CommandMode] A string representing which mode the SMS was sent or received using.
+          # @return [command.CommandMode] The mode used to send the SMS message
           def command_mode
             @properties['command_mode']
           end
 
           ##
-          # @return [command.Transport] The transport
+          # @return [command.Transport] The type of transport used
           def transport
             @properties['transport']
           end
 
           ##
-          # @return [Boolean] The delivery_receipt_requested
+          # @return [Boolean] Whether to request a delivery receipt
           def delivery_receipt_requested
             @properties['delivery_receipt_requested']
           end
 
           ##
-          # @return [command.Status] A string representing the status of the Command.
+          # @return [command.Status] The status of the Command
           def status
             @properties['status']
           end
 
           ##
-          # @return [command.Direction] The direction of the Command.
+          # @return [command.Direction] The direction of the Command
           def direction
             @properties['direction']
           end
 
           ##
-          # @return [Time] The date that this resource was created, given as GMT in ISO 8601 format.
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was created
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date that this resource was last updated, given as GMT in ISO 8601 format.
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated format
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] The URL for this resource.
+          # @return [String] The absolute URL of the resource
           def url
             @properties['url']
           end
 
           ##
-          # Fetch a CommandInstance
+          # Fetch the CommandInstance
           # @return [CommandInstance] Fetched CommandInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Deletes the CommandInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the CommandInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end