twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/api/v2010/account/address.rb

@@ -20,12 +20,14 @@ module Twilio
                 class AccountContext < InstanceContext
 
                      class AddressList < ListResource
+                
                     ##
                     # Initialize the AddressList
                     # @param [Version] version Version that contains the resource
                     # @return [AddressList] AddressList
                     def initialize(version, account_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { account_sid: account_sid }
                         @uri = "/Accounts/#{@solution[:account_sid]}/Addresses.json"
@@ -39,22 +41,22 @@ module Twilio
                     # @param [String] region The state or region of the new address.
                     # @param [String] postal_code The postal code of the new address.
                     # @param [String] iso_country The ISO country code of the new address.
-                    # @param [String] friendly_name A descriptive string that you create to describe the new address. It can be up to 64 characters long.
+                    # @param [String] friendly_name A descriptive string that you create to describe the new address. It can be up to 64 characters long for Regulatory Compliance addresses and 32 characters long for Emergency addresses.
                     # @param [Boolean] emergency_enabled Whether to enable emergency calling on the new address. Can be: `true` or `false`.
                     # @param [Boolean] auto_correct_address Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide.
                     # @param [String] street_secondary The additional number and street address of the address.
                     # @return [AddressInstance] Created AddressInstance
                     def create(
-                        customer_name: nil, 
-                        street: nil, 
-                        city: nil, 
-                        region: nil, 
-                        postal_code: nil, 
-                        iso_country: nil, 
-                        friendly_name: :unset, 
-                        emergency_enabled: :unset, 
-                        auto_correct_address: :unset, 
-                        street_secondary: :unset
+                      customer_name: nil, 
+                      street: nil, 
+                      city: nil, 
+                      region: nil, 
+                      postal_code: nil, 
+                      iso_country: nil, 
+                      friendly_name: :unset, 
+                      emergency_enabled: :unset, 
+                      auto_correct_address: :unset, 
+                      street_secondary: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -70,7 +72,13 @@ module Twilio
                             'StreetSecondary' => street_secondary,
                         })
 
-                        payload = @version.create('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
                         AddressInstance.new(
                             @version,
                             payload,
@@ -78,6 +86,65 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the AddressInstanceMetadata
+                    # @param [String] customer_name The name to associate with the new address.
+                    # @param [String] street The number and street address of the new address.
+                    # @param [String] city The city of the new address.
+                    # @param [String] region The state or region of the new address.
+                    # @param [String] postal_code The postal code of the new address.
+                    # @param [String] iso_country The ISO country code of the new address.
+                    # @param [String] friendly_name A descriptive string that you create to describe the new address. It can be up to 64 characters long for Regulatory Compliance addresses and 32 characters long for Emergency addresses.
+                    # @param [Boolean] emergency_enabled Whether to enable emergency calling on the new address. Can be: `true` or `false`.
+                    # @param [Boolean] auto_correct_address Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide.
+                    # @param [String] street_secondary The additional number and street address of the address.
+                    # @return [AddressInstance] Created AddressInstance
+                    def create_with_metadata(
+                      customer_name: nil, 
+                      street: nil, 
+                      city: nil, 
+                      region: nil, 
+                      postal_code: nil, 
+                      iso_country: nil, 
+                      friendly_name: :unset, 
+                      emergency_enabled: :unset, 
+                      auto_correct_address: :unset, 
+                      street_secondary: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'CustomerName' => customer_name,
+                            'Street' => street,
+                            'City' => city,
+                            'Region' => region,
+                            'PostalCode' => postal_code,
+                            'IsoCountry' => iso_country,
+                            'FriendlyName' => friendly_name,
+                            'EmergencyEnabled' => emergency_enabled,
+                            'AutoCorrectAddress' => auto_correct_address,
+                            'StreetSecondary' => street_secondary,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        address_instance = AddressInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                        )
+                        AddressInstanceMetadata.new(
+                            @version,
+                            address_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists AddressInstance records from the API as a list.
@@ -85,6 +152,7 @@ module Twilio
                     # memory before returning.
                     # @param [String] customer_name The `customer_name` of the Address resources to read.
                     # @param [String] friendly_name The string that identifies the Address resources to read.
+                    # @param [Boolean] emergency_enabled Whether the address can be associated to a number for emergency calling.
                     # @param [String] iso_country The ISO country code of the Address resources to read.
                     # @param [Integer] limit Upper limit for the number of records to return. stream()
                     #    guarantees to never return more than limit.  Default is no limit
@@ -93,10 +161,11 @@ module Twilio
                     #    but a limit is defined, stream() will attempt to read the limit with the most
                     #    efficient page size, i.e. min(limit, 1000)
                     # @return [Array] Array of up to limit results
-                    def list(customer_name: :unset, friendly_name: :unset, iso_country: :unset, limit: nil, page_size: nil)
+                    def list(customer_name: :unset, friendly_name: :unset, emergency_enabled: :unset, iso_country: :unset, limit: nil, page_size: nil)
                         self.stream(
                             customer_name: customer_name,
                             friendly_name: friendly_name,
+                            emergency_enabled: emergency_enabled,
                             iso_country: iso_country,
                             limit: limit,
                             page_size: page_size
@@ -109,6 +178,7 @@ module Twilio
                     # is reached.
                     # @param [String] customer_name The `customer_name` of the Address resources to read.
                     # @param [String] friendly_name The string that identifies the Address resources to read.
+                    # @param [Boolean] emergency_enabled Whether the address can be associated to a number for emergency calling.
                     # @param [String] iso_country The ISO country code of the Address resources to read.
                     # @param [Integer] limit Upper limit for the number of records to return. stream()
                     #    guarantees to never return more than limit.  Default is no limit
@@ -117,16 +187,51 @@ module Twilio
                     #    but a limit is defined, stream() will attempt to read the limit with the most
                     #    efficient page size, i.e. min(limit, 1000)
                     # @return [Enumerable] Enumerable that will yield up to limit results
-                    def stream(customer_name: :unset, friendly_name: :unset, iso_country: :unset, limit: nil, page_size: nil)
+                    def stream(customer_name: :unset, friendly_name: :unset, emergency_enabled: :unset, iso_country: :unset, limit: nil, page_size: nil)
                         limits = @version.read_limits(limit, page_size)
 
                         page = self.page(
                             customer_name: customer_name,
                             friendly_name: friendly_name,
+                            emergency_enabled: emergency_enabled,
                             iso_country: iso_country,
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists AddressPageMetadata records from the API as a list.
+                      # @param [String] customer_name The `customer_name` of the Address resources to read.
+                      # @param [String] friendly_name The string that identifies the Address resources to read.
+                      # @param [Boolean] emergency_enabled Whether the address can be associated to a number for emergency calling.
+                      # @param [String] iso_country The ISO country code of the Address resources to read.
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list_with_metadata(customer_name: :unset, friendly_name: :unset, emergency_enabled: :unset, iso_country: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'CustomerName' => customer_name,
+                            'FriendlyName' => friendly_name,
+                            'EmergencyEnabled' => emergency_enabled,
+                            'IsoCountry' => iso_country,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        AddressPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -138,9 +243,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -148,22 +257,27 @@ module Twilio
                     # Request is executed immediately.
                     # @param [String] customer_name The `customer_name` of the Address resources to read.
                     # @param [String] friendly_name The string that identifies the Address resources to read.
+                    # @param [Boolean] emergency_enabled Whether the address can be associated to a number for emergency calling.
                     # @param [String] iso_country The ISO country code of the Address resources to read.
                     # @param [String] page_token PageToken provided by the API
                     # @param [Integer] page_number Page Number, this value is simply for client state
                     # @param [Integer] page_size Number of records to return, defaults to 50
                     # @return [Page] Page of AddressInstance
-                    def page(customer_name: :unset, friendly_name: :unset, iso_country: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(customer_name: :unset, friendly_name: :unset, emergency_enabled: :unset, iso_country: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'CustomerName' => customer_name,
                             'FriendlyName' => friendly_name,
+                            'EmergencyEnabled' => emergency_enabled,
                             'IsoCountry' => iso_country,
                             'PageToken' => page_token,
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         AddressPage.new(@version, response, @solution)
                     end
@@ -199,6 +313,7 @@ module Twilio
                     # @return [AddressContext] AddressContext
                     def initialize(version, account_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { account_sid: account_sid, sid: sid,  }
@@ -212,7 +327,31 @@ module Twilio
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete
 
-                        @version.delete('DELETE', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+
+                        @version.delete('DELETE', @uri, headers: headers)
+                    end
+
+                    ##
+                    # Delete the AddressInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          address_instance = AddressInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          AddressInstanceMetadata.new(@version, address_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -220,7 +359,13 @@ module Twilio
                     # @return [AddressInstance] Fetched AddressInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         AddressInstance.new(
                             @version,
                             payload,
@@ -229,9 +374,35 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the AddressInstanceMetadata
+                    # @return [AddressInstance] Fetched AddressInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        address_instance = AddressInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            sid: @solution[:sid],
+                        )
+                        AddressInstanceMetadata.new(
+                            @version,
+                            address_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the AddressInstance
-                    # @param [String] friendly_name A descriptive string that you create to describe the address. It can be up to 64 characters long.
+                    # @param [String] friendly_name A descriptive string that you create to describe the new address. It can be up to 64 characters long for Regulatory Compliance addresses and 32 characters long for Emergency addresses.
                     # @param [String] customer_name The name to associate with the address.
                     # @param [String] street The number and street address of the address.
                     # @param [String] city The city of the address.
@@ -242,15 +413,15 @@ module Twilio
                     # @param [String] street_secondary The additional number and street address of the address.
                     # @return [AddressInstance] Updated AddressInstance
                     def update(
-                        friendly_name: :unset, 
-                        customer_name: :unset, 
-                        street: :unset, 
-                        city: :unset, 
-                        region: :unset, 
-                        postal_code: :unset, 
-                        emergency_enabled: :unset, 
-                        auto_correct_address: :unset, 
-                        street_secondary: :unset
+                      friendly_name: :unset, 
+                      customer_name: :unset, 
+                      street: :unset, 
+                      city: :unset, 
+                      region: :unset, 
+                      postal_code: :unset, 
+                      emergency_enabled: :unset, 
+                      auto_correct_address: :unset, 
+                      street_secondary: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -265,7 +436,13 @@ module Twilio
                             'StreetSecondary' => street_secondary,
                         })
 
-                        payload = @version.update('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
                         AddressInstance.new(
                             @version,
                             payload,
@@ -274,6 +451,63 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the AddressInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you create to describe the new address. It can be up to 64 characters long for Regulatory Compliance addresses and 32 characters long for Emergency addresses.
+                    # @param [String] customer_name The name to associate with the address.
+                    # @param [String] street The number and street address of the address.
+                    # @param [String] city The city of the address.
+                    # @param [String] region The state or region of the address.
+                    # @param [String] postal_code The postal code of the address.
+                    # @param [Boolean] emergency_enabled Whether to enable emergency calling on the address. Can be: `true` or `false`.
+                    # @param [Boolean] auto_correct_address Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide.
+                    # @param [String] street_secondary The additional number and street address of the address.
+                    # @return [AddressInstance] Updated AddressInstance
+                    def update_with_metadata(
+                      friendly_name: :unset, 
+                      customer_name: :unset, 
+                      street: :unset, 
+                      city: :unset, 
+                      region: :unset, 
+                      postal_code: :unset, 
+                      emergency_enabled: :unset, 
+                      auto_correct_address: :unset, 
+                      street_secondary: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'CustomerName' => customer_name,
+                            'Street' => street,
+                            'City' => city,
+                            'Region' => region,
+                            'PostalCode' => postal_code,
+                            'EmergencyEnabled' => emergency_enabled,
+                            'AutoCorrectAddress' => auto_correct_address,
+                            'StreetSecondary' => street_secondary,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        address_instance = AddressInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            sid: @solution[:sid],
+                        )
+                        AddressInstanceMetadata.new(
+                            @version,
+                            address_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the dependent_phone_numbers
                     # @return [DependentPhoneNumberList]
@@ -301,6 +535,53 @@ module Twilio
                     end
                 end
 
+                class AddressInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new AddressInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}AddressInstance] address_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 [AddressInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, address_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @address_instance = address_instance
+                    end
+
+                    def address
+                        @address_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.AddressInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class AddressListResponse < InstanceListResource
+                    # @param [Array<AddressInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @address_instance = payload.body[key].map do |data|
+                        AddressInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def address_instance
+                          @instance
+                      end
+                  end
+
                 class AddressPage < Page
                     ##
                     # Initialize the AddressPage
@@ -310,6 +591,7 @@ module Twilio
                     # @return [AddressPage] AddressPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -329,6 +611,66 @@ module Twilio
                         '<Twilio.Api.V2010.AddressPage>'
                     end
                 end
+
+                class AddressPageMetadata < PageMetadata
+                    attr_reader :address_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @address_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @address_page << AddressListResponse.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
+                        @address_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Api::V2010PageMetadata>';
+                    end
+                end
+                class AddressListResponse < InstanceListResource
+
+                    # @param [Array<AddressInstance>] 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
+                      @address = data_list.map do |data|
+                        AddressInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def address
+                        @address
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class AddressInstance < InstanceResource
                     ##
                     # Initialize the AddressInstance
@@ -342,6 +684,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -492,7 +835,7 @@ module Twilio
 
                     ##
                     # Update the AddressInstance
-                    # @param [String] friendly_name A descriptive string that you create to describe the address. It can be up to 64 characters long.
+                    # @param [String] friendly_name A descriptive string that you create to describe the new address. It can be up to 64 characters long for Regulatory Compliance addresses and 32 characters long for Emergency addresses.
                     # @param [String] customer_name The name to associate with the address.
                     # @param [String] street The number and street address of the address.
                     # @param [String] city The city of the address.
@@ -503,15 +846,15 @@ module Twilio
                     # @param [String] street_secondary The additional number and street address of the address.
                     # @return [AddressInstance] Updated AddressInstance
                     def update(
-                        friendly_name: :unset, 
-                        customer_name: :unset, 
-                        street: :unset, 
-                        city: :unset, 
-                        region: :unset, 
-                        postal_code: :unset, 
-                        emergency_enabled: :unset, 
-                        auto_correct_address: :unset, 
-                        street_secondary: :unset
+                      friendly_name: :unset, 
+                      customer_name: :unset, 
+                      street: :unset, 
+                      city: :unset, 
+                      region: :unset, 
+                      postal_code: :unset, 
+                      emergency_enabled: :unset, 
+                      auto_correct_address: :unset, 
+                      street_secondary: :unset
                     )
 
                         context.update(