twilio-ruby 4.6.1 → 6.9.0

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

@@ -0,0 +1,304 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Pricing
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Pricing < PricingBase
+            class V2 < Version
+                class VoiceList < ListResource
+
+                     class CountryList < ListResource
+                    ##
+                    # Initialize the CountryList
+                    # @param [Version] version Version that contains the resource
+                    # @return [CountryList] CountryList
+                    def initialize(version)
+                        super(version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Voice/Countries"
+                        
+                    end
+                
+                    ##
+                    # Lists CountryInstance 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 Instance 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 CountryInstance 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 CountryInstance 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 CountryInstance
+                    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)
+
+                        CountryPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of CountryInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of CountryInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    CountryPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Pricing.V2.CountryList>'
+                    end
+                end
+
+
+                class CountryContext < InstanceContext
+                    ##
+                    # Initialize the CountryContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] iso_country The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the origin-based voice pricing information to fetch.
+                    # @return [CountryContext] CountryContext
+                    def initialize(version, iso_country)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { iso_country: iso_country,  }
+                        @uri = "/Voice/Countries/#{@solution[:iso_country]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the CountryInstance
+                    # @return [CountryInstance] Fetched CountryInstance
+                    def fetch
+
+                        payload = @version.fetch('GET', @uri)
+                        CountryInstance.new(
+                            @version,
+                            payload,
+                            iso_country: @solution[:iso_country],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Pricing.V2.CountryContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Pricing.V2.CountryContext #{context}>"
+                    end
+                end
+
+                class CountryPage < Page
+                    ##
+                    # Initialize the CountryPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [CountryPage] CountryPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of CountryInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [CountryInstance] CountryInstance
+                    def get_instance(payload)
+                        CountryInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Pricing.V2.CountryPage>'
+                    end
+                end
+                class CountryInstance < InstanceResource
+                    ##
+                    # Initialize the CountryInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Country
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [CountryInstance] CountryInstance
+                    def initialize(version, payload , iso_country: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'country' => payload['country'],
+                            'iso_country' => payload['iso_country'],
+                            'outbound_prefix_prices' => payload['outbound_prefix_prices'],
+                            'inbound_call_prices' => payload['inbound_call_prices'],
+                            'price_unit' => payload['price_unit'],
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'iso_country' => iso_country  || @properties['iso_country']  , }
+                    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 [CountryContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = CountryContext.new(@version , @params['iso_country'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The name of the country.
+                    def country
+                        @properties['country']
+                    end
+                    
+                    ##
+                    # @return [String] The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
+                    def iso_country
+                        @properties['iso_country']
+                    end
+                    
+                    ##
+                    # @return [Array<PricingV2TrunkingCountryInstanceTerminatingPrefixPrices>] The list of [OutboundPrefixPriceWithOrigin](https://www.twilio.com/docs/voice/pricing#outbound-prefix-price-with-origin) records.
+                    def outbound_prefix_prices
+                        @properties['outbound_prefix_prices']
+                    end
+                    
+                    ##
+                    # @return [Array<PricingV2TrunkingCountryInstanceOriginatingCallPrices>] The list of [InboundCallPrice](https://www.twilio.com/docs/voice/pricing#inbound-call-price) records.
+                    def inbound_call_prices
+                        @properties['inbound_call_prices']
+                    end
+                    
+                    ##
+                    # @return [String] The currency in which prices are measured, specified in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`).
+                    def price_unit
+                        @properties['price_unit']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute URL of the resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the CountryInstance
+                    # @return [CountryInstance] Fetched CountryInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Pricing.V2.CountryInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Pricing.V2.CountryInstance #{values}>"
+                    end
+                end
+
+             end
+            end
+        end
+    end
+end
+
+

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

@@ -0,0 +1,245 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Pricing
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Pricing < PricingBase
+            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 NumberContext < InstanceContext
+                    ##
+                    # Initialize the NumberContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] destination_number The destination phone number, in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, for which to fetch the origin-based voice pricing information. E.164 format consists of a + followed by the country code and subscriber number.
+                    # @return [NumberContext] NumberContext
+                    def initialize(version, destination_number)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { destination_number: destination_number,  }
+                        @uri = "/Voice/Numbers/#{CGI.escape(@solution[:destination_number]).gsub("+", "%20")}"
+
+                        
+                    end
+                    ##
+                    # Fetch the NumberInstance
+                    # @param [String] origination_number The origination phone number, in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, for which to fetch the origin-based voice pricing information. E.164 format consists of a + followed by the country code and subscriber number.
+                    # @return [NumberInstance] Fetched NumberInstance
+                    def fetch(
+                        origination_number: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'OriginationNumber' => origination_number,
+                        })
+                        payload = @version.fetch('GET', @uri, params: 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
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Pricing.V2.NumberContext #{context}>"
+                    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 NumberInstance < InstanceResource
+                    ##
+                    # Initialize the NumberInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Number
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @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] CallContext for this CallInstance
+                    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](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.
+                    def destination_number
+                        @properties['destination_number']
+                    end
+                    
+                    ##
+                    # @return [String] The origination phone number in [[E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.
+                    def origination_number
+                        @properties['origination_number']
+                    end
+                    
+                    ##
+                    # @return [String] The name of the country.
+                    def country
+                        @properties['country']
+                    end
+                    
+                    ##
+                    # @return [String] The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+                    def iso_country
+                        @properties['iso_country']
+                    end
+                    
+                    ##
+                    # @return [Array<PricingV2VoiceVoiceNumberOutboundCallPrices>] The list of [OutboundCallPriceWithOrigin](https://www.twilio.com/docs/voice/pricing#outbound-call-price-with-origin) records.
+                    def outbound_call_prices
+                        @properties['outbound_call_prices']
+                    end
+                    
+                    ##
+                    # @return [PricingV2VoiceVoiceNumberInboundCallPrice] 
+                    def inbound_call_price
+                        @properties['inbound_call_price']
+                    end
+                    
+                    ##
+                    # @return [String] The currency in which prices are measured, specified in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`).
+                    def price_unit
+                        @properties['price_unit']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute URL of the resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the NumberInstance
+                    # @param [String] origination_number The origination phone number, in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, for which to fetch the origin-based voice pricing information. E.164 format consists of a + followed by the country code and subscriber 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/pricing/v2/voice.rb

@@ -0,0 +1,129 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Pricing
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Pricing < PricingBase
+            class V2 < Version
+                class VoiceList < ListResource
+                    ##
+                    # Initialize the VoiceList
+                    # @param [Version] version Version that contains the resource
+                    # @return [VoiceList] VoiceList
+                    def initialize(version)
+                        super(version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Voice"
+                        # Components
+                        @countries = nil
+                        @numbers = nil
+                    end
+                
+
+                ##
+                # Access the countries
+                # @return [CountryList]
+                # @return [CountryContext] if sid was passed.
+                def countries(iso_country=:unset)
+                    raise ArgumentError, 'iso_country cannot be nil' if iso_country.nil?
+
+                    if iso_country != :unset
+                        return CountryContext.new(@version,iso_country )
+                    end
+
+                    @countries ||= CountryList.new(@version )
+                end
+                ##
+                # Access the numbers
+                # @return [NumberList]
+                # @return [NumberContext] if sid 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
+                        '#<Twilio.Pricing.V2.VoiceList>'
+                    end
+                end
+
+                class VoicePage < Page
+                    ##
+                    # Initialize the VoicePage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [VoicePage] VoicePage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of VoiceInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [VoiceInstance] VoiceInstance
+                    def get_instance(payload)
+                        VoiceInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Pricing.V2.VoicePage>'
+                    end
+                end
+                class VoiceInstance < InstanceResource
+                    ##
+                    # Initialize the VoiceInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Voice
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [VoiceInstance] VoiceInstance
+                    def initialize(version )
+                        super(version)
+                        
+                    end
+
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Pricing.V2.VoiceInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Pricing.V2.VoiceInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end