twilio-ruby 4.6.1 → 6.9.0

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

@@ -0,0 +1,245 @@
+##
+#    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 PortingPortInFetchList < ListResource
+                    ##
+                    # Initialize the PortingPortInFetchList
+                    # @param [Version] version Version that contains the resource
+                    # @return [PortingPortInFetchList] PortingPortInFetchList
+                    def initialize(version)
+                        super(version)
+                        # Path Solution
+                        @solution = {  }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Numbers.V1.PortingPortInFetchList>'
+                    end
+                end
+
+
+                ##
+                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+                class PortingPortInFetchContext < InstanceContext
+                    ##
+                    # Initialize the PortingPortInFetchContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] port_in_request_sid The SID of the Port In request. This is a unique identifier of the port in request.
+                    # @return [PortingPortInFetchContext] PortingPortInFetchContext
+                    def initialize(version, port_in_request_sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { port_in_request_sid: port_in_request_sid,  }
+                        @uri = "/Porting/PortIn/#{@solution[:port_in_request_sid]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the PortingPortInFetchInstance
+                    # @return [PortingPortInFetchInstance] Fetched PortingPortInFetchInstance
+                    def fetch
+
+                        payload = @version.fetch('GET', @uri)
+                        PortingPortInFetchInstance.new(
+                            @version,
+                            payload,
+                            port_in_request_sid: @solution[:port_in_request_sid],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Numbers.V1.PortingPortInFetchContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Numbers.V1.PortingPortInFetchContext #{context}>"
+                    end
+                end
+
+                class PortingPortInFetchPage < Page
+                    ##
+                    # Initialize the PortingPortInFetchPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [PortingPortInFetchPage] PortingPortInFetchPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of PortingPortInFetchInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [PortingPortInFetchInstance] PortingPortInFetchInstance
+                    def get_instance(payload)
+                        PortingPortInFetchInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Numbers.V1.PortingPortInFetchPage>'
+                    end
+                end
+                class PortingPortInFetchInstance < InstanceResource
+                    ##
+                    # Initialize the PortingPortInFetchInstance
+                    # @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 PortingPortInFetch
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [PortingPortInFetchInstance] PortingPortInFetchInstance
+                    def initialize(version, payload , port_in_request_sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'port_in_request_sid' => payload['port_in_request_sid'],
+                            'url' => payload['url'],
+                            'account_sid' => payload['account_sid'],
+                            'notification_emails' => payload['notification_emails'],
+                            'target_port_in_date' => Twilio.deserialize_iso8601_date(payload['target_port_in_date']),
+                            'target_port_in_time_range_start' => payload['target_port_in_time_range_start'],
+                            'target_port_in_time_range_end' => payload['target_port_in_time_range_end'],
+                            'losing_carrier_information' => payload['losing_carrier_information'],
+                            'phone_numbers' => payload['phone_numbers'],
+                            'documents' => payload['documents'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'port_in_request_sid' => port_in_request_sid  || @properties['port_in_request_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 [PortingPortInFetchContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = PortingPortInFetchContext.new(@version , @params['port_in_request_sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the Port In request. This is a unique identifier of the port in request.
+                    def port_in_request_sid
+                        @properties['port_in_request_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The URL of this Port In request
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # @return [String] The Account SID that the numbers will be added to after they are ported into Twilio.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] List of emails for getting notifications about the LOA signing process. Allowed Max 10 emails.
+                    def notification_emails
+                        @properties['notification_emails']
+                    end
+                    
+                    ##
+                    # @return [Date] Minimum number of days in the future (at least 2 days) needs to be established with the Ops team for validation.
+                    def target_port_in_date
+                        @properties['target_port_in_date']
+                    end
+                    
+                    ##
+                    # @return [String] Minimum hour in the future needs to be established with the Ops team for validation.
+                    def target_port_in_time_range_start
+                        @properties['target_port_in_time_range_start']
+                    end
+                    
+                    ##
+                    # @return [String] Maximum hour in the future needs to be established with the Ops team for validation.
+                    def target_port_in_time_range_end
+                        @properties['target_port_in_time_range_end']
+                    end
+                    
+                    ##
+                    # @return [Hash] The information for the losing carrier. 
+                    def losing_carrier_information
+                        @properties['losing_carrier_information']
+                    end
+                    
+                    ##
+                    # @return [Array<Hash>] The list of phone numbers to Port in. Phone numbers are in E.164 format (e.g. +16175551212).
+                    def phone_numbers
+                        @properties['phone_numbers']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] The list of documents SID referencing a utility bills
+                    def documents
+                        @properties['documents']
+                    end
+                    
+                    ##
+                    # Fetch the PortingPortInFetchInstance
+                    # @return [PortingPortInFetchInstance] Fetched PortingPortInFetchInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Numbers.V1.PortingPortInFetchInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Numbers.V1.PortingPortInFetchInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,263 @@
+##
+#    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 PortingPortabilityList < ListResource
+                    ##
+                    # Initialize the PortingPortabilityList
+                    # @param [Version] version Version that contains the resource
+                    # @return [PortingPortabilityList] PortingPortabilityList
+                    def initialize(version)
+                        super(version)
+                        # Path Solution
+                        @solution = {  }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Numbers.V1.PortingPortabilityList>'
+                    end
+                end
+
+
+                ##
+                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+                class PortingPortabilityContext < InstanceContext
+                    ##
+                    # Initialize the PortingPortabilityContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] phone_number The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212).
+                    # @return [PortingPortabilityContext] PortingPortabilityContext
+                    def initialize(version, phone_number)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { phone_number: phone_number,  }
+                        @uri = "/Porting/Portability/PhoneNumber/#{CGI.escape(@solution[:phone_number]).gsub("+", "%20")}"
+
+                        
+                    end
+                    ##
+                    # Fetch the PortingPortabilityInstance
+                    # @param [String] target_account_sid The SID of the account where the phone number(s) will be ported.
+                    # @return [PortingPortabilityInstance] Fetched PortingPortabilityInstance
+                    def fetch(
+                        target_account_sid: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'TargetAccountSid' => target_account_sid,
+                        })
+                        payload = @version.fetch('GET', @uri, params: params)
+                        PortingPortabilityInstance.new(
+                            @version,
+                            payload,
+                            phone_number: @solution[:phone_number],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Numbers.V1.PortingPortabilityContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Numbers.V1.PortingPortabilityContext #{context}>"
+                    end
+                end
+
+                class PortingPortabilityPage < Page
+                    ##
+                    # Initialize the PortingPortabilityPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [PortingPortabilityPage] PortingPortabilityPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of PortingPortabilityInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [PortingPortabilityInstance] PortingPortabilityInstance
+                    def get_instance(payload)
+                        PortingPortabilityInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Numbers.V1.PortingPortabilityPage>'
+                    end
+                end
+                class PortingPortabilityInstance < InstanceResource
+                    ##
+                    # Initialize the PortingPortabilityInstance
+                    # @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 PortingPortability
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [PortingPortabilityInstance] PortingPortabilityInstance
+                    def initialize(version, payload , phone_number: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'phone_number' => payload['phone_number'],
+                            'account_sid' => payload['account_sid'],
+                            'portable' => payload['portable'],
+                            'pin_and_account_number_required' => payload['pin_and_account_number_required'],
+                            'not_portable_reason' => payload['not_portable_reason'],
+                            'not_portable_reason_code' => payload['not_portable_reason_code'] == nil ? payload['not_portable_reason_code'] : payload['not_portable_reason_code'].to_i,
+                            'number_type' => payload['number_type'],
+                            'country' => payload['country'],
+                            'messaging_carrier' => payload['messaging_carrier'],
+                            'voice_carrier' => payload['voice_carrier'],
+                            'url' => payload['url'],
+                        }
+
+                        # 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 [PortingPortabilityContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = PortingPortabilityContext.new(@version , @params['phone_number'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212).
+                    def phone_number
+                        @properties['phone_number']
+                    end
+                    
+                    ##
+                    # @return [String] The target account sid to which the number will be ported
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [Boolean] Boolean flag specifying if phone number is portable or not.
+                    def portable
+                        @properties['portable']
+                    end
+                    
+                    ##
+                    # @return [Boolean] Boolean flag specifying if PIN and account number is required for the phone number.
+                    def pin_and_account_number_required
+                        @properties['pin_and_account_number_required']
+                    end
+                    
+                    ##
+                    # @return [String] Reason why the phone number cannot be ported into Twilio, `null` otherwise.
+                    def not_portable_reason
+                        @properties['not_portable_reason']
+                    end
+                    
+                    ##
+                    # @return [String] The Portability Reason Code for the phone number if it cannot be ported into Twilio, `null` otherwise. One of `22131`, `22132`, `22130`, `22133`, `22102` or `22135`.
+                    def not_portable_reason_code
+                        @properties['not_portable_reason_code']
+                    end
+                    
+                    ##
+                    # @return [NumberType] 
+                    def number_type
+                        @properties['number_type']
+                    end
+                    
+                    ##
+                    # @return [String] Country the phone number belongs to.
+                    def country
+                        @properties['country']
+                    end
+                    
+                    ##
+                    # @return [String] Current messaging carrier of the phone number
+                    def messaging_carrier
+                        @properties['messaging_carrier']
+                    end
+                    
+                    ##
+                    # @return [String] Current voice carrier of the phone number
+                    def voice_carrier
+                        @properties['voice_carrier']
+                    end
+                    
+                    ##
+                    # @return [String] This is the url of the request that you're trying to reach out to locate the resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the PortingPortabilityInstance
+                    # @param [String] target_account_sid The SID of the account where the phone number(s) will be ported.
+                    # @return [PortingPortabilityInstance] Fetched PortingPortabilityInstance
+                    def fetch(
+                        target_account_sid: :unset
+                    )
+
+                        context.fetch(
+                            target_account_sid: target_account_sid, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Numbers.V1.PortingPortabilityInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Numbers.V1.PortingPortabilityInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,94 @@
+##
+#    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
+            class V1 < Version
+                ##
+                # Initialize the V1 version of Numbers
+                def initialize(domain)
+                    super
+                    @version = 'v1'
+                    @bulk_eligibilities = nil
+                    @porting_bulk_portabilities = nil
+                    @porting_port_ins = nil
+                    @porting_portabilities = nil
+                end
+
+                ##
+                # @param [String] request_id The SID of the bulk eligibility check that you want to know about.
+                # @return [Twilio::REST::Numbers::V1::BulkEligibilityContext] if requestId was passed.
+                # @return [Twilio::REST::Numbers::V1::BulkEligibilityList]
+                def bulk_eligibilities(request_id=:unset)
+                    if request_id.nil?
+                        raise ArgumentError, 'request_id cannot be nil'
+                    end
+                    if request_id == :unset
+                        @bulk_eligibilities ||= BulkEligibilityList.new self
+                    else
+                        BulkEligibilityContext.new(self, request_id)
+                    end
+                end
+                ##
+                # @param [String] sid A 34 character string that uniquely identifies the Portability check.
+                # @return [Twilio::REST::Numbers::V1::PortingBulkPortabilityContext] if sid was passed.
+                # @return [Twilio::REST::Numbers::V1::PortingBulkPortabilityList]
+                def porting_bulk_portabilities(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+                    if sid == :unset
+                        @porting_bulk_portabilities ||= PortingBulkPortabilityList.new self
+                    else
+                        PortingBulkPortabilityContext.new(self, sid)
+                    end
+                end
+                ##
+                # @param [String] port_in_request_sid The SID of the Port In request. This is a unique identifier of the port in request.
+                # @return [Twilio::REST::Numbers::V1::PortingPortInFetchContext] if portInRequestSid was passed.
+                # @return [Twilio::REST::Numbers::V1::PortingPortInFetchList]
+                def porting_port_ins(port_in_request_sid=:unset)
+                    if port_in_request_sid.nil?
+                        raise ArgumentError, 'port_in_request_sid cannot be nil'
+                    end
+                    if port_in_request_sid == :unset
+                        @porting_port_ins ||= PortingPortInFetchList.new self
+                    else
+                        PortingPortInFetchContext.new(self, port_in_request_sid)
+                    end
+                end
+                ##
+                # @param [String] phone_number The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212).
+                # @return [Twilio::REST::Numbers::V1::PortingPortabilityContext] if phoneNumber was passed.
+                # @return [Twilio::REST::Numbers::V1::PortingPortabilityList]
+                def porting_portabilities(phone_number=:unset)
+                    if phone_number.nil?
+                        raise ArgumentError, 'phone_number cannot be nil'
+                    end
+                    if phone_number == :unset
+                        @porting_portabilities ||= PortingPortabilityList.new self
+                    else
+                        PortingPortabilityContext.new(self, phone_number)
+                    end
+                end
+                ##
+                # Provide a user friendly representation
+                def to_s
+                    '<Twilio::REST::Numbers::V1>';
+                end
+            end
+        end
+    end
+end