twilio-ruby 7.10.6 → 7.11.1

data/lib/twilio-ruby/rest/numbers/v1/sms_verification.rb

@@ -0,0 +1,231 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Numbers
+#    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 Numbers < NumbersBase
+            class V1 < Version
+                class SmsVerificationList < ListResource
+                
+                    ##
+                    # Initialize the SmsVerificationList
+                    # @param [Version] version Version that contains the resource
+                    # @return [SmsVerificationList] SmsVerificationList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/CallerIds/SmsVerifications"
+                        
+                    end
+                    ##
+                    # Create the SmsVerificationInstance
+                    # @return [SmsVerificationInstance] Created SmsVerificationInstance
+                    def create
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers)
+                        SmsVerificationInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the SmsVerificationInstanceMetadata
+                    # @return [SmsVerificationInstance] Created SmsVerificationInstance
+                    def create_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers)
+                        sms_verification_instance = SmsVerificationInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        SmsVerificationInstanceMetadata.new(
+                            @version,
+                            sms_verification_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Numbers.V1.SmsVerificationList>'
+                    end
+                end
+
+                class SmsVerificationPage < Page
+                    ##
+                    # Initialize the SmsVerificationPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [SmsVerificationPage] SmsVerificationPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of SmsVerificationInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [SmsVerificationInstance] SmsVerificationInstance
+                    def get_instance(payload)
+                        SmsVerificationInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Numbers.V1.SmsVerificationPage>'
+                    end
+                end
+
+                class SmsVerificationPageMetadata < PageMetadata
+                    attr_reader :sms_verification_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @sms_verification_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @sms_verification_page << SmsVerificationListResponse.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
+                        @sms_verification_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V1PageMetadata>';
+                    end
+                end
+                class SmsVerificationListResponse < InstanceListResource
+
+                    # @param [Array<SmsVerificationInstance>] 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
+                      @sms_verification = data_list.map do |data|
+                        SmsVerificationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def sms_verification
+                        @sms_verification
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class SmsVerificationInstance < InstanceResource
+                    ##
+                    # Initialize the SmsVerificationInstance
+                    # @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 SmsVerification
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [SmsVerificationInstance] SmsVerificationInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'to' => payload['to'],
+                            'verification_sid' => payload['verification_sid'],
+                            'send_code_attempts' => payload['send_code_attempts'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] The phone number being verified in E.164 format.
+                    def to
+                        @properties['to']
+                    end
+                    
+                    ##
+                    # @return [String] The unique SID of this verification resource.
+                    def verification_sid
+                        @properties['verification_sid']
+                    end
+                    
+                    ##
+                    # @return [Array<NumbersV1SmsVerificationSendCodeAttempts>] An array of verification attempt objects.
+                    def send_code_attempts
+                        @properties['send_code_attempts']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Numbers.V1.SmsVerificationInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Numbers.V1.SmsVerificationInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

data/lib/twilio-ruby/rest/numbers/v1/sms_verification_check.rb

@@ -0,0 +1,238 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Numbers
+#    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 Numbers < NumbersBase
+            class V1 < Version
+                class SmsVerificationCheckList < ListResource
+                
+                    ##
+                    # Initialize the SmsVerificationCheckList
+                    # @param [Version] version Version that contains the resource
+                    # @return [SmsVerificationCheckList] SmsVerificationCheckList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/CallerIds/SmsVerificationChecks"
+                        
+                    end
+                    ##
+                    # Create the SmsVerificationCheckInstance
+                    # @return [SmsVerificationCheckInstance] Created SmsVerificationCheckInstance
+                    def create
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers)
+                        SmsVerificationCheckInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the SmsVerificationCheckInstanceMetadata
+                    # @return [SmsVerificationCheckInstance] Created SmsVerificationCheckInstance
+                    def create_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers)
+                        sms_verification_check_instance = SmsVerificationCheckInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        SmsVerificationCheckInstanceMetadata.new(
+                            @version,
+                            sms_verification_check_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Numbers.V1.SmsVerificationCheckList>'
+                    end
+                end
+
+                class SmsVerificationCheckPage < Page
+                    ##
+                    # Initialize the SmsVerificationCheckPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [SmsVerificationCheckPage] SmsVerificationCheckPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of SmsVerificationCheckInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [SmsVerificationCheckInstance] SmsVerificationCheckInstance
+                    def get_instance(payload)
+                        SmsVerificationCheckInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Numbers.V1.SmsVerificationCheckPage>'
+                    end
+                end
+
+                class SmsVerificationCheckPageMetadata < PageMetadata
+                    attr_reader :sms_verification_check_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @sms_verification_check_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @sms_verification_check_page << SmsVerificationCheckListResponse.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
+                        @sms_verification_check_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V1PageMetadata>';
+                    end
+                end
+                class SmsVerificationCheckListResponse < InstanceListResource
+
+                    # @param [Array<SmsVerificationCheckInstance>] 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
+                      @sms_verification_check = data_list.map do |data|
+                        SmsVerificationCheckInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def sms_verification_check
+                        @sms_verification_check
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class SmsVerificationCheckInstance < InstanceResource
+                    ##
+                    # Initialize the SmsVerificationCheckInstance
+                    # @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 SmsVerificationCheck
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [SmsVerificationCheckInstance] SmsVerificationCheckInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'to' => payload['to'],
+                            'verification_sid' => payload['verification_sid'],
+                            'status' => payload['status'],
+                            'caller_id_sid' => payload['caller_id_sid'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] The phone number that was verified in E.164 format.
+                    def to
+                        @properties['to']
+                    end
+                    
+                    ##
+                    # @return [String] The unique SID of this verification resource.
+                    def verification_sid
+                        @properties['verification_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The status of the verification (pending, approved, canceled).
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [String] The Caller ID SID created upon successful verification.
+                    def caller_id_sid
+                        @properties['caller_id_sid']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Numbers.V1.SmsVerificationCheckInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Numbers.V1.SmsVerificationCheckInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end