twilio-ruby 5.46.0 → 7.10.1

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

@@ -0,0 +1,405 @@
+##
+#    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
+
+
+                class PortingPortabilityContext < InstanceContext
+                    ##
+                    # Initialize the PortingPortabilityContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] phone_number Phone number to check portability in e164 format.
+                    # @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 Account Sid to which the number will be ported. This can be used to determine if a sub account already has the number in its inventory or a different sub account. If this is not provided, the authenticated account will be assumed to be the target account.
+                    # @param [String] address_sid Address Sid of customer to which the number will be ported.
+                    # @return [PortingPortabilityInstance] Fetched PortingPortabilityInstance
+                    def fetch(
+                        target_account_sid: :unset, 
+                        address_sid: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'TargetAccountSid' => target_account_sid,
+                            'AddressSid' => address_sid,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
+                        PortingPortabilityInstance.new(
+                            @version,
+                            payload,
+                            phone_number: @solution[:phone_number],
+                        )
+                    end
+
+                    ##
+                    # Fetch the PortingPortabilityInstanceMetadata
+                    # @param [String] target_account_sid Account Sid to which the number will be ported. This can be used to determine if a sub account already has the number in its inventory or a different sub account. If this is not provided, the authenticated account will be assumed to be the target account.
+                    # @param [String] address_sid Address Sid of customer to which the number will be ported.
+                    # @return [PortingPortabilityInstance] Fetched PortingPortabilityInstance
+                    def fetch_with_metadata(
+                      target_account_sid: :unset, 
+                      address_sid: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'TargetAccountSid' => target_account_sid,
+                            'AddressSid' => address_sid,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        porting_portability_instance = PortingPortabilityInstance.new(
+                            @version,
+                            response.body,
+                            phone_number: @solution[:phone_number],
+                        )
+                        PortingPortabilityInstanceMetadata.new(
+                            @version,
+                            porting_portability_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    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 PortingPortabilityInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new PortingPortabilityInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}PortingPortabilityInstance] porting_portability_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 [PortingPortabilityInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, porting_portability_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @porting_portability_instance = porting_portability_instance
+                    end
+
+                    def porting_portability
+                        @porting_portability_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.PortingPortabilityInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class PortingPortabilityListResponse < InstanceListResource
+                    # @param [Array<PortingPortabilityInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @porting_portability_instance = payload.body[key].map do |data|
+                        PortingPortabilityInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def porting_portability_instance
+                          @instance
+                      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 PortingPortabilityPageMetadata < PageMetadata
+                    attr_reader :porting_portability_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @porting_portability_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @porting_portability_page << PortingPortabilityListResponse.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
+                        @porting_portability_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V1PageMetadata>';
+                    end
+                end
+                class PortingPortabilityListResponse < InstanceListResource
+
+                    # @param [Array<PortingPortabilityInstance>] 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
+                      @porting_portability = data_list.map do |data|
+                        PortingPortabilityInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def porting_portability
+                        @porting_portability
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    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'],
+                            '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] Account Sid that the phone number belongs to in Twilio. This is only returned for phone numbers that already exist in Twilio’s inventory and belong to your account or sub account.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [Boolean] Boolean flag indicates if the phone number can be ported into Twilio through the Porting API or not.
+                    def portable
+                        @properties['portable']
+                    end
+                    
+                    ##
+                    # @return [Boolean] Indicates if the port in process will require a personal identification number (PIN) and an account number for this phone number. If this is true you will be required to submit both a PIN and account number from the losing carrier for this number when opening a port in request. These fields will be required in order to complete the port in process to Twilio.
+                    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.
+                    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] 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 Account Sid to which the number will be ported. This can be used to determine if a sub account already has the number in its inventory or a different sub account. If this is not provided, the authenticated account will be assumed to be the target account.
+                    # @param [String] address_sid Address Sid of customer to which the number will be ported.
+                    # @return [PortingPortabilityInstance] Fetched PortingPortabilityInstance
+                    def fetch(
+                        target_account_sid: :unset, 
+                        address_sid: :unset
+                    )
+
+                        context.fetch(
+                            target_account_sid: target_account_sid, 
+                            address_sid: address_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/porting_webhook_configuration.rb

@@ -0,0 +1,242 @@
+##
+#    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 PortingWebhookConfigurationList < ListResource
+                
+                    ##
+                    # Initialize the PortingWebhookConfigurationList
+                    # @param [Version] version Version that contains the resource
+                    # @return [PortingWebhookConfigurationList] PortingWebhookConfigurationList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Porting/Configuration/Webhook"
+                        
+                    end
+                    ##
+                    # Create the PortingWebhookConfigurationInstance
+                    # @param [Object] body 
+                    # @return [PortingWebhookConfigurationInstance] Created PortingWebhookConfigurationInstance
+                    def create(body: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers, data: body.to_json)
+                        PortingWebhookConfigurationInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the PortingWebhookConfigurationInstanceMetadata
+                    # @param [Object] body 
+                    # @return [PortingWebhookConfigurationInstance] Created PortingWebhookConfigurationInstance
+                    def create_with_metadata(body: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: body.to_json)
+                        porting_webhook_configuration_instance = PortingWebhookConfigurationInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        PortingWebhookConfigurationInstanceMetadata.new(
+                            @version,
+                            porting_webhook_configuration_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Numbers.V1.PortingWebhookConfigurationList>'
+                    end
+                end
+
+                class PortingWebhookConfigurationPage < Page
+                    ##
+                    # Initialize the PortingWebhookConfigurationPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [PortingWebhookConfigurationPage] PortingWebhookConfigurationPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of PortingWebhookConfigurationInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [PortingWebhookConfigurationInstance] PortingWebhookConfigurationInstance
+                    def get_instance(payload)
+                        PortingWebhookConfigurationInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Numbers.V1.PortingWebhookConfigurationPage>'
+                    end
+                end
+
+                class PortingWebhookConfigurationPageMetadata < PageMetadata
+                    attr_reader :porting_webhook_configuration_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @porting_webhook_configuration_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @porting_webhook_configuration_page << PortingWebhookConfigurationListResponse.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
+                        @porting_webhook_configuration_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V1PageMetadata>';
+                    end
+                end
+                class PortingWebhookConfigurationListResponse < InstanceListResource
+
+                    # @param [Array<PortingWebhookConfigurationInstance>] 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
+                      @porting_webhook_configuration = data_list.map do |data|
+                        PortingWebhookConfigurationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def porting_webhook_configuration
+                        @porting_webhook_configuration
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class PortingWebhookConfigurationInstance < InstanceResource
+                    ##
+                    # Initialize the PortingWebhookConfigurationInstance
+                    # @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 PortingWebhookConfiguration
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [PortingWebhookConfigurationInstance] PortingWebhookConfigurationInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'url' => payload['url'],
+                            'port_in_target_url' => payload['port_in_target_url'],
+                            'port_out_target_url' => payload['port_out_target_url'],
+                            'notifications_of' => payload['notifications_of'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] The URL of the webhook configuration request
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # @return [String] The complete webhook url that will be called when a notification event for port in request or port in phone number happens
+                    def port_in_target_url
+                        @properties['port_in_target_url']
+                    end
+                    
+                    ##
+                    # @return [String] The complete webhook url that will be called when a notification event for a port out phone number happens.
+                    def port_out_target_url
+                        @properties['port_out_target_url']
+                    end
+                    
+                    ##
+                    # @return [Array<String>] A list to filter what notification events to receive for this account and its sub accounts. If it is an empty list, then it means that there are no filters for the notifications events to send in each webhook and all events will get sent.
+                    def notifications_of
+                        @properties['notifications_of']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Numbers.V1.PortingWebhookConfigurationInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Numbers.V1.PortingWebhookConfigurationInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end