twilio-ruby 5.6.0 → 5.33.0

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,9 @@ module Twilio
             ##
             # Initialize the AddressList
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
+            # @param [String] account_sid The SID of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for
+            #   the Address resource.
             # @return [AddressList] AddressList
             def initialize(version, account_sid: nil)
               super(version)
@@ -26,15 +30,20 @@ module Twilio
             ##
             # Retrieve a single page of AddressInstance records from the API.
             # Request is executed immediately.
-            # @param [String] customer_name The customer_name
-            # @param [String] street The street
-            # @param [String] city The city
-            # @param [String] region The region
-            # @param [String] postal_code The postal_code
-            # @param [String] iso_country The iso_country
-            # @param [String] friendly_name The friendly_name
-            # @param [Boolean] emergency_enabled The emergency_enabled
-            # @param [Boolean] auto_correct_address The auto_correct_address
+            # @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.
+            # @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.
             # @return [AddressInstance] Newly 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)
               data = Twilio::Values.of({
@@ -55,16 +64,19 @@ module Twilio
                   data: data
               )
 
-              AddressInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              AddressInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
             # Lists AddressInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] customer_name The customer_name
-            # @param [String] friendly_name The friendly_name
-            # @param [String] iso_country The iso_country
+            # @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 [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
@@ -86,9 +98,12 @@ module Twilio
             # Streams AddressInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] customer_name The customer_name
-            # @param [String] friendly_name The friendly_name
-            # @param [String] iso_country The iso_country
+            # @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 [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
@@ -116,7 +131,7 @@ module Twilio
             def each
               limits = @version.read_limits
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page,
                               limit: limits[:limit],
@@ -126,9 +141,12 @@ module Twilio
             ##
             # Retrieve a single page of AddressInstance records from the API.
             # Request is executed immediately.
-            # @param [String] customer_name The customer_name
-            # @param [String] friendly_name The friendly_name
-            # @param [String] iso_country The iso_country
+            # @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 [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
@@ -189,7 +207,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [AddressInstance] AddressInstance
             def get_instance(payload)
-              AddressInstance.new(@version, payload, account_sid: @solution[:account_sid])
+              AddressInstance.new(@version, payload, account_sid: @solution[:account_sid], )
             end
 
             ##
@@ -203,14 +221,17 @@ module Twilio
             ##
             # Initialize the AddressContext
             # @param [Version] version Version that contains the resource
-            # @param [String] account_sid The account_sid
-            # @param [String] sid The sid
+            # @param [String] account_sid The SID of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for
+            #   the Address resource to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Address resource to fetch.
             # @return [AddressContext] AddressContext
             def initialize(version, account_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {account_sid: account_sid, sid: sid}
+              @solution = {account_sid: account_sid, sid: sid, }
               @uri = "/Accounts/#{@solution[:account_sid]}/Addresses/#{@solution[:sid]}.json"
 
               # Dependents
@@ -219,7 +240,7 @@ module Twilio
 
             ##
             # Deletes the AddressInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -236,19 +257,24 @@ module Twilio
                   params,
               )
 
-              AddressInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+              AddressInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
             end
 
             ##
             # Update the AddressInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] customer_name The customer_name
-            # @param [String] street The street
-            # @param [String] city The city
-            # @param [String] region The region
-            # @param [String] postal_code The postal_code
-            # @param [Boolean] emergency_enabled The emergency_enabled
-            # @param [Boolean] auto_correct_address The auto_correct_address
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the address. It can be up to 64 characters long.
+            # @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.
             # @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)
               data = Twilio::Values.of({
@@ -268,7 +294,7 @@ module Twilio
                   data: data,
               )
 
-              AddressInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+              AddressInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
             end
 
             ##
@@ -293,6 +319,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Api.V2010.AddressContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Api.V2010.AddressContext #{context}>"
+            end
           end
 
           class AddressInstance < InstanceResource
@@ -300,8 +333,11 @@ module Twilio
             # Initialize the AddressInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] account_sid The account_sid
-            # @param [String] sid The sid
+            # @param [String] account_sid The SID of the
+            #   [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for
+            #   the Address resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the
+            #   Address resource to fetch.
             # @return [AddressInstance] AddressInstance
             def initialize(version, payload, account_sid: nil, sid: nil)
               super(version)
@@ -322,11 +358,12 @@ module Twilio
                   'uri' => payload['uri'],
                   'emergency_enabled' => payload['emergency_enabled'],
                   'validated' => payload['validated'],
+                  'verified' => payload['verified'],
               }
 
               # Context
               @instance_context = nil
-              @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid']}
+              @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -335,98 +372,104 @@ module Twilio
             # @return [AddressContext] AddressContext for this AddressInstance
             def context
               unless @instance_context
-                @instance_context = AddressContext.new(@version, @params['account_sid'], @params['sid'])
+                @instance_context = AddressContext.new(@version, @params['account_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The SID of the Account that is responsible for the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The city
+            # @return [String] The city in which the address is located
             def city
               @properties['city']
             end
 
             ##
-            # @return [String] The customer_name
+            # @return [String] The name associated with the address
             def customer_name
               @properties['customer_name']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The RFC 2822 date and time in GMT that the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The iso_country
+            # @return [String] The ISO country code of the address
             def iso_country
               @properties['iso_country']
             end
 
             ##
-            # @return [String] The postal_code
+            # @return [String] The postal code of the address
             def postal_code
               @properties['postal_code']
             end
 
             ##
-            # @return [String] The region
+            # @return [String] The state or region of the address
             def region
               @properties['region']
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The street
+            # @return [String] The number and street address of the address
             def street
               @properties['street']
             end
 
             ##
-            # @return [String] The uri
+            # @return [String] The URI of the resource, relative to `https://api.twilio.com`
             def uri
               @properties['uri']
             end
 
             ##
-            # @return [Boolean] The emergency_enabled
+            # @return [Boolean] Whether emergency calling has been enabled on this number
             def emergency_enabled
               @properties['emergency_enabled']
             end
 
             ##
-            # @return [Boolean] The validated
+            # @return [Boolean] Whether the address has been validated to comply with local regulation
             def validated
               @properties['validated']
             end
 
+            ##
+            # @return [Boolean] Whether the address has been verified to comply with regulation
+            def verified
+              @properties['verified']
+            end
+
             ##
             # Deletes the AddressInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
@@ -440,14 +483,19 @@ module Twilio
 
             ##
             # Update the AddressInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] customer_name The customer_name
-            # @param [String] street The street
-            # @param [String] city The city
-            # @param [String] region The region
-            # @param [String] postal_code The postal_code
-            # @param [Boolean] emergency_enabled The emergency_enabled
-            # @param [Boolean] auto_correct_address The auto_correct_address
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the address. It can be up to 64 characters long.
+            # @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.
             # @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)
               context.update(