twilio-ruby 6.1.0 → 6.2.0

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

@@ -0,0 +1,229 @@
+##
+#    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 PortingBulkPortabilityList < ListResource
+                    ##
+                    # Initialize the PortingBulkPortabilityList
+                    # @param [Version] version Version that contains the resource
+                    # @return [PortingBulkPortabilityList] PortingBulkPortabilityList
+                    def initialize(version)
+                        super(version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Porting/Portability"
+                        
+                    end
+                    ##
+                    # Create the PortingBulkPortabilityInstance
+                    # @param [Array[String]] phone_numbers The phone numbers which portability is to be checked. This should be a list of strings. Phone numbers are in E.164 format (e.g. +16175551212). .
+                    # @return [PortingBulkPortabilityInstance] Created PortingBulkPortabilityInstance
+                    def create(
+                        phone_numbers: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'PhoneNumbers' => Twilio.serialize_list(phone_numbers) { |e| e },
+                        })
+
+                        payload = @version.create('POST', @uri, data: data)
+                        PortingBulkPortabilityInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Numbers.V1.PortingBulkPortabilityList>'
+                    end
+                end
+
+
+                ##
+                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+                class PortingBulkPortabilityContext < InstanceContext
+                    ##
+                    # Initialize the PortingBulkPortabilityContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] sid A 34 character string that uniquely identifies the Portability check.
+                    # @return [PortingBulkPortabilityContext] PortingBulkPortabilityContext
+                    def initialize(version, sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { sid: sid,  }
+                        @uri = "/Porting/Portability/#{@solution[:sid]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the PortingBulkPortabilityInstance
+                    # @return [PortingBulkPortabilityInstance] Fetched PortingBulkPortabilityInstance
+                    def fetch
+
+                        payload = @version.fetch('GET', @uri)
+                        PortingBulkPortabilityInstance.new(
+                            @version,
+                            payload,
+                            sid: @solution[:sid],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Numbers.V1.PortingBulkPortabilityContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Numbers.V1.PortingBulkPortabilityContext #{context}>"
+                    end
+                end
+
+                class PortingBulkPortabilityPage < Page
+                    ##
+                    # Initialize the PortingBulkPortabilityPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [PortingBulkPortabilityPage] PortingBulkPortabilityPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of PortingBulkPortabilityInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [PortingBulkPortabilityInstance] PortingBulkPortabilityInstance
+                    def get_instance(payload)
+                        PortingBulkPortabilityInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Numbers.V1.PortingBulkPortabilityPage>'
+                    end
+                end
+                class PortingBulkPortabilityInstance < InstanceResource
+                    ##
+                    # Initialize the PortingBulkPortabilityInstance
+                    # @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 PortingBulkPortability
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [PortingBulkPortabilityInstance] PortingBulkPortabilityInstance
+                    def initialize(version, payload , sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'status' => payload['status'],
+                            'datetime_created' => Twilio.deserialize_iso8601_datetime(payload['datetime_created']),
+                            'phone_numbers' => payload['phone_numbers'],
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'sid' => sid  || @properties['sid']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [PortingBulkPortabilityContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = PortingBulkPortabilityContext.new(@version , @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] A 34 character string that uniquely identifies this Portability check.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [Status] 
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [Time] The date that the Portability check was created, given in ISO 8601 format.
+                    def datetime_created
+                        @properties['datetime_created']
+                    end
+                    
+                    ##
+                    # @return [Array<Hash>] Contains a list with all the information of the requested phone numbers. Each phone number contains the following properties: `phone_number`: The phone number which portability is to be checked. `portable`: Boolean flag specifying if phone number is portable or not. `not_portable_reason`: Reason why the phone number cannot be ported into Twilio, `null` otherwise. `not_portable_reason_code`: The Portability Reason Code for the phone number if it cannot be ported in Twilio, `null` otherwise. `pin_and_account_number_required`: Boolean flag specifying if PIN and account number is required for the phone number. `number_type`: The type of the requested phone number. `country` Country the phone number belongs to. `messaging_carrier` Current messaging carrier of the phone number. `voice_carrier` Current voice carrier of the phone number.
+                    def phone_numbers
+                        @properties['phone_numbers']
+                    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 PortingBulkPortabilityInstance
+                    # @return [PortingBulkPortabilityInstance] Fetched PortingBulkPortabilityInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Numbers.V1.PortingBulkPortabilityInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Numbers.V1.PortingBulkPortabilityInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end

data/lib/twilio-ruby/rest/numbers/v1/porting_portability.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 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
+                    # @return [PortingPortabilityInstance] Fetched PortingPortabilityInstance
+                    def fetch
+
+                        payload = @version.fetch('GET', @uri)
+                        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'],
+                            '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 [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
+                    # @return [PortingPortabilityInstance] Fetched PortingPortabilityInstance
+                    def fetch
+
+                        context.fetch
+                    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

@@ -22,6 +22,8 @@ module Twilio
                     super
                     @version = 'v1'
                     @bulk_eligibilities = nil
+                    @porting_bulk_portabilities = nil
+                    @porting_portabilities = nil
                 end
 
                 ##
@@ -39,6 +41,34 @@ module Twilio
                     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] 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>';