twilio-ruby 5.31.1 → 5.54.0

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

@@ -0,0 +1,329 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Voice < Domain
+      class V1 < Version
+        class SourceIpMappingList < ListResource
+          ##
+          # Initialize the SourceIpMappingList
+          # @param [Version] version Version that contains the resource
+          # @return [SourceIpMappingList] SourceIpMappingList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/SourceIpMappings"
+          end
+
+          ##
+          # Create the SourceIpMappingInstance
+          # @param [String] ip_record_sid The Twilio-provided string that uniquely
+          #   identifies the IP Record resource to map from.
+          # @param [String] sip_domain_sid The SID of the SIP Domain that the IP Record
+          #   should be mapped to.
+          # @return [SourceIpMappingInstance] Created SourceIpMappingInstance
+          def create(ip_record_sid: nil, sip_domain_sid: nil)
+            data = Twilio::Values.of({'IpRecordSid' => ip_record_sid, 'SipDomainSid' => sip_domain_sid, })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            SourceIpMappingInstance.new(@version, payload, )
+          end
+
+          ##
+          # Lists SourceIpMappingInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @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
+          #    not set will use the default value of 50 records.  If no page_size is defined
+          #    but a limit is defined, stream() will attempt to read the limit with the most
+          #    efficient page size, i.e. min(limit, 1000)
+          # @return [Array] Array of up to limit results
+          def list(limit: nil, page_size: nil)
+            self.stream(limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams SourceIpMappingInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @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
+          #    not set will use the default value of 50 records. If no page_size is defined
+          #    but a limit is defined, stream() will attempt to read the limit with the most
+          #    efficient page size, i.e. min(limit, 1000)
+          # @return [Enumerable] Enumerable that will yield up to limit results
+          def stream(limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields SourceIpMappingInstance records from the API.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          def each
+            limits = @version.read_limits
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit]).each {|x| yield x}
+          end
+
+          ##
+          # Retrieve a single page of SourceIpMappingInstance records from the API.
+          # Request is executed immediately.
+          # @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
+          # @return [Page] Page of SourceIpMappingInstance
+          def page(page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            SourceIpMappingPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of SourceIpMappingInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of SourceIpMappingInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            SourceIpMappingPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Voice.V1.SourceIpMappingList>'
+          end
+        end
+
+        class SourceIpMappingPage < Page
+          ##
+          # Initialize the SourceIpMappingPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [SourceIpMappingPage] SourceIpMappingPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of SourceIpMappingInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [SourceIpMappingInstance] SourceIpMappingInstance
+          def get_instance(payload)
+            SourceIpMappingInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Voice.V1.SourceIpMappingPage>'
+          end
+        end
+
+        class SourceIpMappingContext < InstanceContext
+          ##
+          # Initialize the SourceIpMappingContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The Twilio-provided string that uniquely identifies the IP
+          #   Record resource to fetch.
+          # @return [SourceIpMappingContext] SourceIpMappingContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/SourceIpMappings/#{@solution[:sid]}"
+          end
+
+          ##
+          # Fetch the SourceIpMappingInstance
+          # @return [SourceIpMappingInstance] Fetched SourceIpMappingInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            SourceIpMappingInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Update the SourceIpMappingInstance
+          # @param [String] sip_domain_sid The SID of the SIP Domain that the IP Record
+          #   should be mapped to.
+          # @return [SourceIpMappingInstance] Updated SourceIpMappingInstance
+          def update(sip_domain_sid: nil)
+            data = Twilio::Values.of({'SipDomainSid' => sip_domain_sid, })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            SourceIpMappingInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Delete the SourceIpMappingInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+             @version.delete('DELETE', @uri)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Voice.V1.SourceIpMappingContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Voice.V1.SourceIpMappingContext #{context}>"
+          end
+        end
+
+        class SourceIpMappingInstance < InstanceResource
+          ##
+          # Initialize the SourceIpMappingInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The Twilio-provided string that uniquely identifies the IP
+          #   Record resource to fetch.
+          # @return [SourceIpMappingInstance] SourceIpMappingInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'ip_record_sid' => payload['ip_record_sid'],
+                'sip_domain_sid' => payload['sip_domain_sid'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'sid' => sid || @properties['sid'], }
+          end
+
+          ##
+          # Generate an instance context for the instance, the context is capable of
+          # performing various actions.  All instance actions are proxied to the context
+          # @return [SourceIpMappingContext] SourceIpMappingContext for this SourceIpMappingInstance
+          def context
+            unless @instance_context
+              @instance_context = SourceIpMappingContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique string that identifies the resource
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The unique string that identifies an IP Record
+          def ip_record_sid
+            @properties['ip_record_sid']
+          end
+
+          ##
+          # @return [String] The unique string that identifies a SIP Domain
+          def sip_domain_sid
+            @properties['sip_domain_sid']
+          end
+
+          ##
+          # @return [Time] The RFC 2822 date and time in GMT that the resource was created
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] The absolute URL of the resource
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the SourceIpMappingInstance
+          # @return [SourceIpMappingInstance] Fetched SourceIpMappingInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Update the SourceIpMappingInstance
+          # @param [String] sip_domain_sid The SID of the SIP Domain that the IP Record
+          #   should be mapped to.
+          # @return [SourceIpMappingInstance] Updated SourceIpMappingInstance
+          def update(sip_domain_sid: nil)
+            context.update(sip_domain_sid: sip_domain_sid, )
+          end
+
+          ##
+          # Delete the SourceIpMappingInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+            context.delete
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Voice.V1.SourceIpMappingInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Voice.V1.SourceIpMappingInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -33,11 +33,12 @@ module Twilio
         # @return [Twilio::REST::Wireless::V1::CommandList]
         def commands(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @commands ||= CommandList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @commands ||= CommandList.new self
           else
-            CommandContext.new(self, sid)
+              CommandContext.new(self, sid)
           end
         end
 
@@ -47,11 +48,12 @@ module Twilio
         # @return [Twilio::REST::Wireless::V1::RatePlanList]
         def rate_plans(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @rate_plans ||= RatePlanList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @rate_plans ||= RatePlanList.new self
           else
-            RatePlanContext.new(self, sid)
+              RatePlanContext.new(self, sid)
           end
         end
 
@@ -61,11 +63,12 @@ module Twilio
         # @return [Twilio::REST::Wireless::V1::SimList]
         def sims(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @sims ||= SimList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @sims ||= SimList.new self
           else
-            SimContext.new(self, sid)
+              SimContext.new(self, sid)
           end
         end
 

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

@@ -27,8 +27,8 @@ 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 The `sid` or `unique_name` of the [Sim
-          #   resources](https://www.twilio.com/docs/wireless/api/sim-resource) to read.
+          # @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
@@ -57,8 +57,8 @@ 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 The `sid` or `unique_name` of the [Sim
-          #   resources](https://www.twilio.com/docs/wireless/api/sim-resource) to read.
+          # @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
@@ -103,8 +103,8 @@ module Twilio
           ##
           # Retrieve a single page of CommandInstance records from the API.
           # Request is executed immediately.
-          # @param [String] sim The `sid` or `unique_name` of the [Sim
-          #   resources](https://www.twilio.com/docs/wireless/api/sim-resource) to read.
+          # @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
@@ -125,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
 
@@ -147,12 +145,11 @@ module Twilio
           end
 
           ##
-          # Retrieve a single page of CommandInstance records from the API.
-          # Request is executed immediately.
+          # 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
+          #   {SIM}[https://www.twilio.com/docs/wireless/api/sim-resource] to send the Command
           #   to.
           # @param [String] callback_method The HTTP method we use to call `callback_url`.
           #   Can be: `POST` or `GET`, and the default is `POST`.
@@ -173,7 +170,7 @@ module Twilio
           #   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] Newly created CommandInstance
+          # @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,
@@ -185,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
@@ -245,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
+          # Delete the CommandInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
@@ -396,14 +383,14 @@ module Twilio
           end
 
           ##
-          # Fetch a CommandInstance
+          # Fetch the CommandInstance
           # @return [CommandInstance] Fetched CommandInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Deletes the CommandInstance
+          # Delete the CommandInstance
           # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete