twilio-ruby 7.10.7 → 7.11.1

data/lib/twilio-ruby/rest/routes/v3/phone_number.rb

@@ -0,0 +1,465 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Routes
+#    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 Routes < RoutesBase
+            class V3 < Version
+                class PhoneNumberList < ListResource
+                
+                    ##
+                    # Initialize the PhoneNumberList
+                    # @param [Version] version Version that contains the resource
+                    # @return [PhoneNumberList] PhoneNumberList
+                    def initialize(version)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        # Path Solution
+                        @solution = {  }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Routes.V3.PhoneNumberList>'
+                    end
+                end
+
+
+                class PhoneNumberContext < InstanceContext
+                    ##
+                    # Initialize the PhoneNumberContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] phone_number The phone number in E.164 format
+                    # @return [PhoneNumberContext] PhoneNumberContext
+                    def initialize(version, phone_number)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+
+                        # Path Solution
+                        @solution = { phone_number: phone_number,  }
+                        @uri = "/PhoneNumbers/#{@solution[:phone_number]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the PhoneNumberInstance
+                    # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        PhoneNumberInstance.new(
+                            @version,
+                            payload,
+                            phone_number: @solution[:phone_number],
+                        )
+                    end
+
+                    ##
+                    # Fetch the PhoneNumberInstanceMetadata
+                    # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        phone_number_instance = PhoneNumberInstance.new(
+                            @version,
+                            response.body,
+                            phone_number: @solution[:phone_number],
+                        )
+                        PhoneNumberInstanceMetadata.new(
+                            @version,
+                            phone_number_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Update the PhoneNumberInstance
+                    # @param [String] voice_region The Inbound Processing Region used for this phone number for voice
+                    # @param [String] messaging_region The Inbound Processing Region used for this phone number for messaging
+                    # @param [String] friendly_name A human readable description of this resource, up to 64 characters.
+                    # @return [PhoneNumberInstance] Updated PhoneNumberInstance
+                    def update(
+                      voice_region: :unset, 
+                      messaging_region: :unset, 
+                      friendly_name: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'voiceRegion' => voice_region,
+                            'messagingRegion' => messaging_region,
+                            'friendlyName' => friendly_name,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
+                        PhoneNumberInstance.new(
+                            @version,
+                            payload,
+                            phone_number: @solution[:phone_number],
+                        )
+                    end
+
+                    ##
+                    # Update the PhoneNumberInstanceMetadata
+                    # @param [String] voice_region The Inbound Processing Region used for this phone number for voice
+                    # @param [String] messaging_region The Inbound Processing Region used for this phone number for messaging
+                    # @param [String] friendly_name A human readable description of this resource, up to 64 characters.
+                    # @return [PhoneNumberInstance] Updated PhoneNumberInstance
+                    def update_with_metadata(
+                      voice_region: :unset, 
+                      messaging_region: :unset, 
+                      friendly_name: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'voiceRegion' => voice_region,
+                            'messagingRegion' => messaging_region,
+                            'friendlyName' => friendly_name,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        phone_number_instance = PhoneNumberInstance.new(
+                            @version,
+                            response.body,
+                            phone_number: @solution[:phone_number],
+                        )
+                        PhoneNumberInstanceMetadata.new(
+                            @version,
+                            phone_number_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Routes.V3.PhoneNumberContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Routes.V3.PhoneNumberContext #{context}>"
+                    end
+                end
+
+                class PhoneNumberInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new PhoneNumberInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}PhoneNumberInstance] phone_number_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [PhoneNumberInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, phone_number_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @phone_number_instance = phone_number_instance
+                    end
+
+                    def phone_number
+                        @phone_number_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.PhoneNumberInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class PhoneNumberListResponse < InstanceListResource
+                    # @param [Array<PhoneNumberInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @phone_number_instance = payload.body[key].map do |data|
+                        PhoneNumberInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def phone_number_instance
+                          @instance
+                      end
+                  end
+
+                class PhoneNumberPage < TokenPage
+                    ##
+                    # 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)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, 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)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Routes.V3.PhoneNumberPage>'
+                    end
+                end
+
+                class PhoneNumberPageMetadata < PageMetadata
+                    attr_reader :phone_number_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @phone_number_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @phone_number_page << PhoneNumberListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @phone_number_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Routes::V3PageMetadata>';
+                    end
+                end
+                class PhoneNumberListResponse < InstanceListResource
+
+                    # @param [Array<PhoneNumberInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @phone_number = data_list.map do |data|
+                        PhoneNumberInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def phone_number
+                        @phone_number
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    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 , phone_number: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'phone_number' => payload['phone_number'],
+                            'url' => payload['url'],
+                            'account_sid' => payload['account_sid'],
+                            'friendly_name' => payload['friendly_name'],
+                            'voice_region' => payload['voice_region'],
+                            'messaging_region' => payload['messaging_region'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'phone_number' => phone_number  || @properties['phone_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 [PhoneNumberContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = PhoneNumberContext.new(@version , @params['phone_number'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The phone number in E.164 format
+                    def phone_number
+                        @properties['phone_number']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute URL of the resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # @return [String] The unique SID identifier of the Account.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] A human readable description of the Inbound Processing Region assignments for this phone number, up to 64 characters.
+                    def friendly_name
+                        @properties['friendly_name']
+                    end
+                    
+                    ##
+                    # @return [String] The Inbound Processing Region used for this phone number for voice.
+                    def voice_region
+                        @properties['voice_region']
+                    end
+                    
+                    ##
+                    # @return [String] The Inbound Processing Region used for this phone number for messaging.
+                    def messaging_region
+                        @properties['messaging_region']
+                    end
+                    
+                    ##
+                    # @return [Time] The date that this phone number was assigned an Inbound Processing Region, given in ISO 8601 format.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [Time] The date that the Inbound Processing Region was updated for this phone number, given in ISO 8601 format.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # Fetch the PhoneNumberInstance
+                    # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Update the PhoneNumberInstance
+                    # @param [String] voice_region The Inbound Processing Region used for this phone number for voice
+                    # @param [String] messaging_region The Inbound Processing Region used for this phone number for messaging
+                    # @param [String] friendly_name A human readable description of this resource, up to 64 characters.
+                    # @return [PhoneNumberInstance] Updated PhoneNumberInstance
+                    def update(
+                      voice_region: :unset, 
+                      messaging_region: :unset, 
+                      friendly_name: :unset
+                    )
+
+                        context.update(
+                            voice_region: voice_region, 
+                            messaging_region: messaging_region, 
+                            friendly_name: friendly_name, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Routes.V3.PhoneNumberInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Routes.V3.PhoneNumberInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end

data/lib/twilio-ruby/rest/routes/v3.rb

@@ -0,0 +1,50 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Routes
+#    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 Routes
+            class V3 < Version
+                ##
+                # Initialize the V3 version of Routes
+                def initialize(domain)
+                    super
+                    @version = 'v3'
+                    @phone_numbers = nil
+                end
+
+                ##
+                # @param [String] phone_number The phone number in E.164 format
+                # @return [Twilio::REST::Routes::V3::PhoneNumberContext] if phoneNumber was passed.
+                # @return [Twilio::REST::Routes::V3::PhoneNumberList]
+                def phone_numbers(phone_number=:unset)
+                    if phone_number.nil?
+                        raise ArgumentError, 'phone_number cannot be nil'
+                    end
+
+                    if phone_number == :unset
+                        @phone_numbers ||= PhoneNumberList.new self
+                    else
+                        PhoneNumberContext.new(self, phone_number)
+                    end
+                end
+                ##
+                # Provide a user friendly representation
+                def to_s
+                    '<Twilio::REST::Routes::V3>';
+                end
+            end
+        end
+    end
+end

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

@@ -22,16 +22,21 @@ module Twilio
         @host = "routes.twilio.com"
         @port = 443
         @v2 = nil
+        @v3 = nil
       end
 
       def v2
         @v2 ||= Routes::V2.new self
       end
 
+      def v3
+        @v3 ||= Routes::V3.new self
+      end
+
       ##
       # Provide a user friendly representation
       def to_s
-        '<Twilio::REST::Routes::V2>';
+        '<Twilio::REST::Routes>';
       end
     end
   end