twilio-ruby 5.12.4 → 5.13.0

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

@@ -23,6 +23,7 @@ module Twilio
 
             # Components
             @countries = nil
+            @numbers = nil
           end
 
           ##
@@ -41,6 +42,22 @@ module Twilio
               @countries ||= CountryList.new(@version, )
           end
 
+          ##
+          # Access the numbers
+          # @param [String] destination_number This fetches the origin-based voice pricing
+          #   information for a phone number
+          # @return [NumberList]
+          # @return [NumberContext] if destination_number was passed.
+          def numbers(destination_number=:unset)
+            raise ArgumentError, 'destination_number cannot be nil' if destination_number.nil?
+
+            if destination_number != :unset
+              return NumberContext.new(@version, destination_number, )
+            end
+
+              @numbers ||= NumberList.new(@version, )
+          end
+
           ##
           # Provide a user friendly representation
           def to_s

data/lib/twilio-ruby/rest/pricing/v2/voice/number.rb

@@ -0,0 +1,214 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Pricing < Domain
+      class V2 < Version
+        class VoiceList < ListResource
+          class NumberList < ListResource
+            ##
+            # Initialize the NumberList
+            # @param [Version] version Version that contains the resource
+            # @return [NumberList] NumberList
+            def initialize(version)
+              super(version)
+
+              # Path Solution
+              @solution = {}
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Pricing.V2.NumberList>'
+            end
+          end
+
+          class NumberPage < Page
+            ##
+            # Initialize the NumberPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [NumberPage] NumberPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of NumberInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [NumberInstance] NumberInstance
+            def get_instance(payload)
+              NumberInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Pricing.V2.NumberPage>'
+            end
+          end
+
+          class NumberContext < InstanceContext
+            ##
+            # Initialize the NumberContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] destination_number This fetches the origin-based voice pricing
+            #   information for a phone number
+            # @return [NumberContext] NumberContext
+            def initialize(version, destination_number)
+              super(version)
+
+              # Path Solution
+              @solution = {destination_number: destination_number, }
+              @uri = "/Voice/Numbers/#{@solution[:destination_number]}"
+            end
+
+            ##
+            # Fetch a NumberInstance
+            # @param [String] origination_number The origination_number
+            # @return [NumberInstance] Fetched NumberInstance
+            def fetch(origination_number: :unset)
+              params = Twilio::Values.of({'OriginationNumber' => origination_number, })
+
+              payload = @version.fetch(
+                  'GET',
+                  @uri,
+                  params,
+              )
+
+              NumberInstance.new(@version, payload, destination_number: @solution[:destination_number], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Pricing.V2.NumberContext #{context}>"
+            end
+          end
+
+          class NumberInstance < InstanceResource
+            ##
+            # Initialize the NumberInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] destination_number This fetches the origin-based voice pricing
+            #   information for a phone number
+            # @return [NumberInstance] NumberInstance
+            def initialize(version, payload, destination_number: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'destination_number' => payload['destination_number'],
+                  'origination_number' => payload['origination_number'],
+                  'country' => payload['country'],
+                  'iso_country' => payload['iso_country'],
+                  'outbound_call_prices' => payload['outbound_call_prices'],
+                  'inbound_call_price' => payload['inbound_call_price'],
+                  'price_unit' => payload['price_unit'],
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'destination_number' => destination_number || @properties['destination_number'], }
+            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 [NumberContext] NumberContext for this NumberInstance
+            def context
+              unless @instance_context
+                @instance_context = NumberContext.new(@version, @params['destination_number'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The destination phone number, in E.164
+            def destination_number
+              @properties['destination_number']
+            end
+
+            ##
+            # @return [String] The origination phone number, in E.164
+            def origination_number
+              @properties['origination_number']
+            end
+
+            ##
+            # @return [String] Name of the country
+            def country
+              @properties['country']
+            end
+
+            ##
+            # @return [String] The ISO country code
+            def iso_country
+              @properties['iso_country']
+            end
+
+            ##
+            # @return [String] List of OutboundCallPriceWithOrigin records
+            def outbound_call_prices
+              @properties['outbound_call_prices']
+            end
+
+            ##
+            # @return [String] List of InboundCallPrice records
+            def inbound_call_price
+              @properties['inbound_call_price']
+            end
+
+            ##
+            # @return [String] The currency in which prices are measured, in ISO 4127 format (e.g. usd, eur, jpy).
+            def price_unit
+              @properties['price_unit']
+            end
+
+            ##
+            # @return [String] The URL of this resource.
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch a NumberInstance
+            # @param [String] origination_number The origination_number
+            # @return [NumberInstance] Fetched NumberInstance
+            def fetch(origination_number: :unset)
+              context.fetch(origination_number: origination_number, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Pricing.V2.NumberInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Pricing.V2.NumberInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Verify < Domain
+      ##
+      # Initialize the Verify Domain
+      def initialize(twilio)
+        super
+
+        @base_url = 'https://verify.twilio.com'
+        @host = 'verify.twilio.com'
+        @port = 443
+
+        # Versions
+        @v1 = nil
+      end
+
+      ##
+      # Version v1 of verify
+      def v1
+        @v1 ||= V1.new self
+      end
+
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this Service.
+      # @return [Twilio::REST::Verify::V1::ServiceInstance] if sid was passed.
+      # @return [Twilio::REST::Verify::V1::ServiceList]
+      def services(sid=:unset)
+        self.v1.services(sid)
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '#<Twilio::REST::Verify>'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Verify
+      class V1 < Version
+        ##
+        # Initialize the V1 version of Verify
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @services = nil
+        end
+
+        ##
+        # @param [String] sid The unique SID identifier of Verification Service Instance.
+        # @return [Twilio::REST::Verify::V1::ServiceContext] if sid was passed.
+        # @return [Twilio::REST::Verify::V1::ServiceList]
+        def services(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @services ||= ServiceList.new self
+          else
+            ServiceContext.new(self, sid)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Verify::V1>'
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/verify/v1/service.rb

@@ -0,0 +1,391 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+# 
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Verify < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class ServiceList < ListResource
+          ##
+          # Initialize the ServiceList
+          # @param [Version] version Version that contains the resource
+          # @return [ServiceList] ServiceList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Services"
+          end
+
+          ##
+          # Retrieve a single page of ServiceInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] friendly_name A 1-64 character string with friendly name of
+          #   service
+          # @param [String] code_length The length of the verification code to be generated.
+          #   Must be an integer value between 4-10
+          # @return [ServiceInstance] Newly created ServiceInstance
+          def create(friendly_name: nil, code_length: :unset)
+            data = Twilio::Values.of({'FriendlyName' => friendly_name, 'CodeLength' => code_length, })
+
+            payload = @version.create(
+                'POST',
+                @uri,
+                data: data
+            )
+
+            ServiceInstance.new(@version, payload, )
+          end
+
+          ##
+          # Lists ServiceInstance 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 ServiceInstance 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 ServiceInstance 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 ServiceInstance 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 ServiceInstance
+          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
+            )
+            ServicePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of ServiceInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of ServiceInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            ServicePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Verify.V1.ServiceList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class ServicePage < Page
+          ##
+          # Initialize the ServicePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [ServicePage] ServicePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of ServiceInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [ServiceInstance] ServiceInstance
+          def get_instance(payload)
+            ServiceInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Verify.V1.ServicePage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class ServiceContext < InstanceContext
+          ##
+          # Initialize the ServiceContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The unique SID identifier of Verification Service Instance.
+          # @return [ServiceContext] ServiceContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/Services/#{@solution[:sid]}"
+
+            # Dependents
+            @verifications = nil
+            @verification_checks = nil
+          end
+
+          ##
+          # Fetch a ServiceInstance
+          # @return [ServiceInstance] Fetched ServiceInstance
+          def fetch
+            params = Twilio::Values.of({})
+
+            payload = @version.fetch(
+                'GET',
+                @uri,
+                params,
+            )
+
+            ServiceInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Update the ServiceInstance
+          # @param [String] friendly_name A 1-64 character string with friendly name of
+          #   service
+          # @param [String] code_length The length of the verification code to be generated.
+          #   Must be an integer value between 4-10
+          # @return [ServiceInstance] Updated ServiceInstance
+          def update(friendly_name: :unset, code_length: :unset)
+            data = Twilio::Values.of({'FriendlyName' => friendly_name, 'CodeLength' => code_length, })
+
+            payload = @version.update(
+                'POST',
+                @uri,
+                data: data,
+            )
+
+            ServiceInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Access the verifications
+          # @return [VerificationList]
+          # @return [VerificationContext]
+          def verifications
+            unless @verifications
+              @verifications = VerificationList.new(@version, service_sid: @solution[:sid], )
+            end
+
+            @verifications
+          end
+
+          ##
+          # Access the verification_checks
+          # @return [VerificationCheckList]
+          # @return [VerificationCheckContext]
+          def verification_checks
+            unless @verification_checks
+              @verification_checks = VerificationCheckList.new(@version, service_sid: @solution[:sid], )
+            end
+
+            @verification_checks
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Verify.V1.ServiceContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class ServiceInstance < InstanceResource
+          ##
+          # Initialize the ServiceInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The unique SID identifier of Verification Service Instance.
+          # @return [ServiceInstance] ServiceInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'friendly_name' => payload['friendly_name'],
+                'code_length' => payload['code_length'].to_i,
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'url' => payload['url'],
+                'links' => payload['links'],
+            }
+
+            # 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 [ServiceContext] ServiceContext for this ServiceInstance
+          def context
+            unless @instance_context
+              @instance_context = ServiceContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] A string that uniquely identifies this Service.
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] Account Sid.
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] Friendly name of the service
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [String] Length of verification code. Valid values are 4-10
+          def code_length
+            @properties['code_length']
+          end
+
+          ##
+          # @return [Time] The date this Service was created
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The date this Service was updated
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] The links
+          def links
+            @properties['links']
+          end
+
+          ##
+          # Fetch a ServiceInstance
+          # @return [ServiceInstance] Fetched ServiceInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Update the ServiceInstance
+          # @param [String] friendly_name A 1-64 character string with friendly name of
+          #   service
+          # @param [String] code_length The length of the verification code to be generated.
+          #   Must be an integer value between 4-10
+          # @return [ServiceInstance] Updated ServiceInstance
+          def update(friendly_name: :unset, code_length: :unset)
+            context.update(friendly_name: friendly_name, code_length: code_length, )
+          end
+
+          ##
+          # Access the verifications
+          # @return [verifications] verifications
+          def verifications
+            context.verifications
+          end
+
+          ##
+          # Access the verification_checks
+          # @return [verification_checks] verification_checks
+          def verification_checks
+            context.verification_checks
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Verify.V1.ServiceInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Verify.V1.ServiceInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end