twilio-ruby 4.6.1 → 6.9.0

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

@@ -0,0 +1,70 @@
+##
+#    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
+            class V2 < Version
+                ##
+                # Initialize the V2 version of Pricing
+                def initialize(domain)
+                    super
+                    @version = 'v2'
+                    @countries = nil
+                    @numbers = nil
+                    @voice = nil
+                end
+
+                ##
+                # @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 [Twilio::REST::Pricing::V2::CountryContext] if isoCountry was passed.
+                # @return [Twilio::REST::Pricing::V2::CountryList]
+                def countries(iso_country=:unset)
+                    if iso_country.nil?
+                        raise ArgumentError, 'iso_country cannot be nil'
+                    end
+                    if iso_country == :unset
+                        @countries ||= CountryList.new self
+                    else
+                        CountryContext.new(self, iso_country)
+                    end
+                end
+                ##
+                # @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 [Twilio::REST::Pricing::V2::NumberContext] if destinationNumber was passed.
+                # @return [Twilio::REST::Pricing::V2::NumberList]
+                def numbers(destination_number=:unset)
+                    if destination_number.nil?
+                        raise ArgumentError, 'destination_number cannot be nil'
+                    end
+                    if destination_number == :unset
+                        @numbers ||= NumberList.new self
+                    else
+                        NumberContext.new(self, destination_number)
+                    end
+                end
+                ##
+                # @return [Twilio::REST::Pricing::V2::VoiceList]
+                def voice
+                    @voice ||= VoiceList.new self
+                end
+                ##
+                # Provide a user friendly representation
+                def to_s
+                    '<Twilio::REST::Pricing::V2>';
+                end
+            end
+        end
+    end
+end

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

@@ -1,6 +1,47 @@
 module Twilio
   module REST
-    module Pricing
+    class Pricing < PricingBase
+      ##
+      # @return [Twilio::REST::Pricing::V1::MessagingInstance]
+      def messaging
+        warn "messaging is deprecated. Use v1.messaging instead."
+        self.v1.messaging()
+      end
+
+      ##
+      # @return [Twilio::REST::Pricing::V1::PhoneNumberInstance]
+      def phone_numbers
+        warn "phone_numbers is deprecated. Use v1.phone_numbers instead."
+        self.v1.phone_numbers()
+      end
+
+      ##
+      # @return [Twilio::REST::Pricing::V2::VoiceInstance]
+      def voice
+        warn "voice is deprecated. Use v2.voice instead."
+        self.v2.voice()
+      end
+
+      ##
+      # @param [String] iso_country The {ISO country
+      #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2].
+      # @return [Twilio::REST::Pricing::V2::CountryInstance] if iso_country was passed.
+      # @return [Twilio::REST::Pricing::V2::CountryList]
+      def countries(iso_country=:unset)
+        warn "countries is deprecated. Use v2.countries instead."
+        self.v2.countries(iso_country)
+      end
+
+      ##
+      # @param [String] destination_number 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.
+      # @return [Twilio::REST::Pricing::V2::NumberInstance] if destination_number was passed.
+      # @return [Twilio::REST::Pricing::V2::NumberList]
+      def numbers(destination_number=:unset)
+        warn "numbers is deprecated. Use v2.numbers instead."
+        self.v2.numbers(destination_number)
+      end
     end
   end
-end
+end

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

@@ -0,0 +1,43 @@
+##
+ # This code was generated by
+ # ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ #  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ #  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ #
+ # NOTE: This class is auto generated by OpenAPI Generator.
+ # https://openapi-generator.tech
+ # Do not edit the class manually.
+# frozen_string_literal: true
+module Twilio
+  module REST
+    class PricingBase < Domain
+      ##
+      # Initialize pricing domain
+      #
+      # @param twilio - The twilio client
+      #
+      def initialize(twilio)
+        super(twilio)
+        @base_url =  "https://pricing.twilio.com"
+        @host = "pricing.twilio.com"
+        @port = 443
+        @v1 = nil
+        @v2 = nil
+      end
+
+      def v1
+        @v1 ||= Pricing::V1.new self
+      end
+
+      def v2
+        @v2 ||= Pricing::V2.new self
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '<Twilio::REST::Pricing>';
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb

@@ -0,0 +1,426 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Proxy
+#    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 Proxy < ProxyBase
+            class V1 < Version
+                class ServiceContext < InstanceContext
+
+                     class PhoneNumberList < ListResource
+                    ##
+                    # Initialize the PhoneNumberList
+                    # @param [Version] version Version that contains the resource
+                    # @return [PhoneNumberList] PhoneNumberList
+                    def initialize(version, service_sid: nil)
+                        super(version)
+                        # Path Solution
+                        @solution = { service_sid: service_sid }
+                        @uri = "/Services/#{@solution[:service_sid]}/PhoneNumbers"
+                        
+                    end
+                    ##
+                    # Create the PhoneNumberInstance
+                    # @param [String] sid The SID of a Twilio [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) resource that represents the Twilio Number you would like to assign to your Proxy Service.
+                    # @param [String] phone_number The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format.  E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.
+                    # @param [Boolean] is_reserved Whether the new phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information.
+                    # @return [PhoneNumberInstance] Created PhoneNumberInstance
+                    def create(
+                        sid: :unset, 
+                        phone_number: :unset, 
+                        is_reserved: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Sid' => sid,
+                            'PhoneNumber' => phone_number,
+                            'IsReserved' => is_reserved,
+                        })
+
+                        payload = @version.create('POST', @uri, data: data)
+                        PhoneNumberInstance.new(
+                            @version,
+                            payload,
+                            service_sid: @solution[:service_sid],
+                        )
+                    end
+
+                
+                    ##
+                    # Lists PhoneNumberInstance 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 PhoneNumberInstance 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 PhoneNumberInstance 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 PhoneNumberInstance
+                    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)
+
+                        PhoneNumberPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of PhoneNumberInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of PhoneNumberInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    PhoneNumberPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Proxy.V1.PhoneNumberList>'
+                    end
+                end
+
+
+                ##
+                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+                class PhoneNumberContext < InstanceContext
+                    ##
+                    # Initialize the PhoneNumberContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] service_sid The SID of the parent [Service](https://www.twilio.com/docs/proxy/api/service) of the PhoneNumber resource to update.
+                    # @param [String] sid The Twilio-provided string that uniquely identifies the PhoneNumber resource to update.
+                    # @return [PhoneNumberContext] PhoneNumberContext
+                    def initialize(version, service_sid, sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { service_sid: service_sid, sid: sid,  }
+                        @uri = "/Services/#{@solution[:service_sid]}/PhoneNumbers/#{@solution[:sid]}"
+
+                        
+                    end
+                    ##
+                    # Delete the PhoneNumberInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        @version.delete('DELETE', @uri)
+                    end
+
+                    ##
+                    # Fetch the PhoneNumberInstance
+                    # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
+                    def fetch
+
+                        payload = @version.fetch('GET', @uri)
+                        PhoneNumberInstance.new(
+                            @version,
+                            payload,
+                            service_sid: @solution[:service_sid],
+                            sid: @solution[:sid],
+                        )
+                    end
+
+                    ##
+                    # Update the PhoneNumberInstance
+                    # @param [Boolean] is_reserved Whether the phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information.
+                    # @return [PhoneNumberInstance] Updated PhoneNumberInstance
+                    def update(
+                        is_reserved: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'IsReserved' => is_reserved,
+                        })
+
+                        payload = @version.update('POST', @uri, data: data)
+                        PhoneNumberInstance.new(
+                            @version,
+                            payload,
+                            service_sid: @solution[:service_sid],
+                            sid: @solution[:sid],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Proxy.V1.PhoneNumberContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Proxy.V1.PhoneNumberContext #{context}>"
+                    end
+                end
+
+                class PhoneNumberPage < Page
+                    ##
+                    # Initialize the PhoneNumberPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [PhoneNumberPage] PhoneNumberPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of PhoneNumberInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [PhoneNumberInstance] PhoneNumberInstance
+                    def get_instance(payload)
+                        PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Proxy.V1.PhoneNumberPage>'
+                    end
+                end
+                class PhoneNumberInstance < InstanceResource
+                    ##
+                    # Initialize the PhoneNumberInstance
+                    # @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 PhoneNumber
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [PhoneNumberInstance] PhoneNumberInstance
+                    def initialize(version, payload , service_sid: nil, sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'account_sid' => payload['account_sid'],
+                            'service_sid' => payload['service_sid'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                            'phone_number' => payload['phone_number'],
+                            'friendly_name' => payload['friendly_name'],
+                            'iso_country' => payload['iso_country'],
+                            'capabilities' => payload['capabilities'],
+                            'url' => payload['url'],
+                            'is_reserved' => payload['is_reserved'],
+                            'in_use' => payload['in_use'] == nil ? payload['in_use'] : payload['in_use'].to_i,
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'service_sid' => service_sid  || @properties['service_sid']  ,'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 [PhoneNumberContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = PhoneNumberContext.new(@version , @params['service_sid'], @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique string that we created to identify the PhoneNumber resource.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the PhoneNumber resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the PhoneNumber resource's parent [Service](https://www.twilio.com/docs/proxy/api/service) resource.
+                    def service_sid
+                        @properties['service_sid']
+                    end
+                    
+                    ##
+                    # @return [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was created.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # @return [String] The 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 phone_number
+                        @properties['phone_number']
+                    end
+                    
+                    ##
+                    # @return [String] The string that you assigned to describe the resource.
+                    def friendly_name
+                        @properties['friendly_name']
+                    end
+                    
+                    ##
+                    # @return [String] The ISO Country Code for the phone number.
+                    def iso_country
+                        @properties['iso_country']
+                    end
+                    
+                    ##
+                    # @return [ProxyV1ServicePhoneNumberCapabilities] 
+                    def capabilities
+                        @properties['capabilities']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute URL of the PhoneNumber resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # @return [Boolean] Whether the phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information.
+                    def is_reserved
+                        @properties['is_reserved']
+                    end
+                    
+                    ##
+                    # @return [String] The number of open session assigned to the number. See the [How many Phone Numbers do I need?](https://www.twilio.com/docs/proxy/phone-numbers-needed) guide for more information.
+                    def in_use
+                        @properties['in_use']
+                    end
+                    
+                    ##
+                    # Delete the PhoneNumberInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
+                    ##
+                    # Fetch the PhoneNumberInstance
+                    # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Update the PhoneNumberInstance
+                    # @param [Boolean] is_reserved Whether the phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information.
+                    # @return [PhoneNumberInstance] Updated PhoneNumberInstance
+                    def update(
+                        is_reserved: :unset
+                    )
+
+                        context.update(
+                            is_reserved: is_reserved, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Proxy.V1.PhoneNumberInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Proxy.V1.PhoneNumberInstance #{values}>"
+                    end
+                end
+
+             end
+            end
+        end
+    end
+end
+
+