twilio-ruby 7.11.2 → 7.12.0

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

@@ -0,0 +1,402 @@
+##
+#    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 IsoCountryCodeList < ListResource
+                
+                    ##
+                    # Initialize the IsoCountryCodeList
+                    # @param [Version] version Version that contains the resource
+                    # @return [IsoCountryCodeList] IsoCountryCodeList
+                    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.IsoCountryCodeList>'
+                    end
+                end
+
+
+                class IsoCountryCodeContext < InstanceContext
+                    ##
+                    # Initialize the IsoCountryCodeContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] iso_country_code The ISO country code of the short code
+                    # @param [String] short_code The short code
+                    # @return [IsoCountryCodeContext] IsoCountryCodeContext
+                    def initialize(version, iso_country_code, short_code)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+
+                        # Path Solution
+                        @solution = { iso_country_code: iso_country_code, short_code: short_code,  }
+                        @uri = "/ShortCodes/#{@solution[:iso_country_code]}/#{@solution[:short_code]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the IsoCountryCodeInstance
+                    # @return [IsoCountryCodeInstance] Fetched IsoCountryCodeInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        IsoCountryCodeInstance.new(
+                            @version,
+                            payload,
+                            iso_country_code: @solution[:iso_country_code],
+                            short_code: @solution[:short_code],
+                        )
+                    end
+
+                    ##
+                    # Fetch the IsoCountryCodeInstanceMetadata
+                    # @return [IsoCountryCodeInstance] Fetched IsoCountryCodeInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        iso_country_code_instance = IsoCountryCodeInstance.new(
+                            @version,
+                            response.body,
+                            iso_country_code: @solution[:iso_country_code],
+                            short_code: @solution[:short_code],
+                        )
+                        IsoCountryCodeInstanceMetadata.new(
+                            @version,
+                            iso_country_code_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                    ##
+                    # Update the IsoCountryCodeInstance
+                    # @param [String] messaging_region The Processing Region used for this short code for messaging
+                    # @param [String] friendly_name A human readable description of this resource, up to 64 characters.
+                    # @return [IsoCountryCodeInstance] Updated IsoCountryCodeInstance
+                    def update(
+                      messaging_region: :unset, 
+                      friendly_name: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            '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)
+                        IsoCountryCodeInstance.new(
+                            @version,
+                            payload,
+                            iso_country_code: @solution[:iso_country_code],
+                            short_code: @solution[:short_code],
+                        )
+                    end
+
+                    ##
+                    # Update the IsoCountryCodeInstanceMetadata
+                    # @param [String] messaging_region The Processing Region used for this short code for messaging
+                    # @param [String] friendly_name A human readable description of this resource, up to 64 characters.
+                    # @return [IsoCountryCodeInstance] Updated IsoCountryCodeInstance
+                    def update_with_metadata(
+                      messaging_region: :unset, 
+                      friendly_name: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            '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)
+                        iso_country_code_instance = IsoCountryCodeInstance.new(
+                            @version,
+                            response.body,
+                            iso_country_code: @solution[:iso_country_code],
+                            short_code: @solution[:short_code],
+                        )
+                        IsoCountryCodeInstanceMetadata.new(
+                            @version,
+                            iso_country_code_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.IsoCountryCodeContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Routes.V3.IsoCountryCodeContext #{context}>"
+                    end
+                end
+
+                class IsoCountryCodeInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new IsoCountryCodeInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}IsoCountryCodeInstance] iso_country_code_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 [IsoCountryCodeInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, iso_country_code_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @iso_country_code_instance = iso_country_code_instance
+                    end
+
+                    def iso_country_code
+                        @iso_country_code_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.IsoCountryCodeInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class IsoCountryCodeListResponse < InstanceListResource
+                    # @param [Array<IsoCountryCodeInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @iso_country_code_instance = payload.body[key].map do |data|
+                        IsoCountryCodeInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def iso_country_code_instance
+                          @instance
+                      end
+                  end
+
+                class IsoCountryCodePage < TokenPage
+                    ##
+                    # Initialize the IsoCountryCodePage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [IsoCountryCodePage] IsoCountryCodePage
+                    def initialize(version, response, solution)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of IsoCountryCodeInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [IsoCountryCodeInstance] IsoCountryCodeInstance
+                    def get_instance(payload)
+                        IsoCountryCodeInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Routes.V3.IsoCountryCodePage>'
+                    end
+                end
+
+                class IsoCountryCodeInstance < InstanceResource
+                    ##
+                    # Initialize the IsoCountryCodeInstance
+                    # @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 IsoCountryCode
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [IsoCountryCodeInstance] IsoCountryCodeInstance
+                    def initialize(version, payload , iso_country_code: nil, short_code: nil)
+                        
+                        apiV1Version = ApiV1Version.new version.domain, version
+                        super(apiV1Version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'iso_country_code' => payload['iso_country_code'],
+                            'short_code' => payload['short_code'],
+                            'url' => payload['url'],
+                            'account_sid' => payload['account_sid'],
+                            'friendly_name' => payload['friendly_name'],
+                            '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 = { 'iso_country_code' => iso_country_code  || @properties['iso_country_code']  ,'short_code' => short_code  || @properties['short_code']  , }
+                    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 [IsoCountryCodeContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = IsoCountryCodeContext.new(@version , @params['iso_country_code'], @params['short_code'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The ISO country code of the short code
+                    def iso_country_code
+                        @properties['iso_country_code']
+                    end
+                    
+                    ##
+                    # @return [String] The short code
+                    def short_code
+                        @properties['short_code']
+                    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 assignment for this short code, up to 64 characters.
+                    def friendly_name
+                        @properties['friendly_name']
+                    end
+                    
+                    ##
+                    # @return [String] The Inbound Processing Region used for this short code for messaging.
+                    def messaging_region
+                        @properties['messaging_region']
+                    end
+                    
+                    ##
+                    # @return [Time] The date that this short code 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 short code, given in ISO 8601 format.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # Fetch the IsoCountryCodeInstance
+                    # @return [IsoCountryCodeInstance] Fetched IsoCountryCodeInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Update the IsoCountryCodeInstance
+                    # @param [String] messaging_region The Processing Region used for this short code for messaging
+                    # @param [String] friendly_name A human readable description of this resource, up to 64 characters.
+                    # @return [IsoCountryCodeInstance] Updated IsoCountryCodeInstance
+                    def update(
+                      messaging_region: :unset, 
+                      friendly_name: :unset
+                    )
+
+                        context.update(
+                            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.IsoCountryCodeInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Routes.V3.IsoCountryCodeInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -21,9 +21,52 @@ module Twilio
                 def initialize(domain)
                     super
                     @version = 'v3'
+                    @iso_country_code = nil
                     @phone_numbers = nil
                 end
 
+                ##
+                # @param [String] iso_country_code The ISO country code of the short code
+                # @param [String] short_code The short code
+                # @return [Twilio::REST::Routes::V3::IsoCountryCodeContext] if isoCountryCode was passed.
+                # @return [Twilio::REST::Routes::V3::IsoCountryCodeList]
+                def iso_country_code(iso_country_code=:unset, short_code=:unset)
+                    if iso_country_code.nil?
+                        raise ArgumentError, 'iso_country_code cannot be nil'
+                    end
+                    if short_code.nil?
+                        raise ArgumentError, 'short_code cannot be nil'
+                    end
+
+                    if iso_country_code == :unset && short_code == :unset
+                        @iso_country_code ||= IsoCountryCodeList.new self
+                    elsif iso_country_code != :unset && short_code == :unset
+                        IsoCountryCodeList.new(self, iso_country_code: iso_country_code)
+                    else
+                        IsoCountryCodeContext.new(self, iso_country_code, short_code)
+                    end
+                end
+                ##
+                # @param [String] iso_country_code The ISO country code of the short code
+                # @param [String] short_code The short code
+                # @return [Twilio::REST::Routes::V3::IsoCountryCodeContext] if shortCode was passed.
+                # @return [Twilio::REST::Routes::V3::IsoCountryCodeList]
+                def iso_country_code(iso_country_code=:unset, short_code=:unset)
+                    if iso_country_code.nil?
+                        raise ArgumentError, 'iso_country_code cannot be nil'
+                    end
+                    if short_code.nil?
+                        raise ArgumentError, 'short_code cannot be nil'
+                    end
+
+                    if iso_country_code == :unset && short_code == :unset
+                        @iso_country_code ||= IsoCountryCodeList.new self
+                    elsif iso_country_code != :unset && short_code == :unset
+                        IsoCountryCodeList.new(self, iso_country_code: iso_country_code)
+                    else
+                        IsoCountryCodeContext.new(self, iso_country_code, short_code)
+                    end
+                end
                 ##
                 # @param [String] phone_number The phone number in E.164 format
                 # @return [Twilio::REST::Routes::V3::PhoneNumberContext] if phoneNumber was passed.

data/lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb

@@ -635,7 +635,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Hash] Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\"os\": \"Android\"}`. Can be up to 1024 characters in length.
+                    # @return [Hash] Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\"os\": \"Android\"}`. Can be up to 1024 characters in length. For `passkeys` factors, it contains the `aaguid` of the authenticator once the factor is verified, and `date_last_approved` (ISO 8601) once the factor has been used to approve a challenge.
                     def metadata
                         @properties['metadata']
                     end

data/lib/twilio-ruby/rest/verify/v2/service/new_verify_factor.rb

@@ -265,7 +265,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [Hash] Custom metadata associated with the factor.
+                    # @return [Hash] Metadata associated with the factor. For `passkeys` factors, it contains the `aaguid` of the authenticator once the factor is verified, and `date_last_approved` (ISO 8601) once the factor has been used to approve a challenge.
                     def metadata
                         @properties['metadata']
                     end