lib/twilio-ruby/rest/api/v2010/account/address.rb in twilio-ruby-5.0.0.rc18 vs lib/twilio-ruby/rest/api/v2010/account/address.rb in twilio-ruby-5.0.0.rc19
- old
+ new
@@ -1,10 +1,10 @@
##
# This code was generated by
# \ / _ _ _| _ _
# | (_)\/(_)(_|\/| |(/_ v1.0.0
-# / /
+# / /
module Twilio
module REST
class Api < Domain
class V2010 < Version
@@ -15,53 +15,55 @@
# @param [Version] version Version that contains the resource
# @param [String] account_sid The account_sid
# @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"
end
-
+
##
# 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
# @return [AddressInstance] Newly created AddressInstance
- def create(customer_name: nil, street: nil, city: nil, region: nil, postal_code: nil, iso_country: nil, friendly_name: nil)
+ def create(customer_name: nil, street: nil, city: nil, region: nil, postal_code: nil, iso_country: nil, friendly_name: nil, emergency_enabled: nil)
data = {
'CustomerName' => customer_name,
'Street' => street,
'City' => city,
'Region' => region,
'PostalCode' => postal_code,
'IsoCountry' => iso_country,
'FriendlyName' => friendly_name,
+ 'EmergencyEnabled' => emergency_enabled,
}
-
+
payload = @version.create(
'POST',
@uri,
data: data
)
-
+
return 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
@@ -81,11 +83,11 @@
iso_country: iso_country,
limit: limit,
page_size: page_size
).entries
end
-
+
##
# 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
@@ -98,21 +100,21 @@
# 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: nil, friendly_name: nil, iso_country: nil, limit: nil, page_size: nil)
limits = @version.read_limits(limit, page_size)
-
+
page = self.page(
customer_name: customer_name,
friendly_name: friendly_name,
iso_country: iso_country,
page_size: limits[:page_size],
)
-
+
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end
-
+
##
# When passed a block, yields AddressInstance records from the API.
# This operation lazily loads records as efficiently as possible until the limit
# is reached.
# @param [String] customer_name The customer_name
@@ -124,20 +126,20 @@
# 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)
def each
limits = @version.read_limits
-
+
page = self.page(
page_size: limits[:page_size],
)
-
+
@version.stream(page,
limit: limits[:limit],
page_limit: limits[:page_limit]).each {|x| yield x}
end
-
+
##
# 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
@@ -160,33 +162,33 @@
@uri,
params
)
return AddressPage.new(@version, response, @solution)
end
-
+
##
# Provide a user friendly representation
def to_s
'#<Twilio.Api.V2010.AddressList>'
end
end
-
+
class AddressPage < Page
##
# Initialize the AddressPage
# @param [Version] version Version that contains the resource
# @param [Response] response Response from the API
# @param [Hash] solution Path solution for the resource
# @param [String] account_sid The account_sid
# @return [AddressPage] AddressPage
def initialize(version, response, solution)
super(version, response)
-
+
# Path Solution
@solution = solution
end
-
+
##
# Build an instance of AddressInstance
# @param [Hash] payload Payload response from the API
# @return [AddressInstance] AddressInstance
def get_instance(payload)
@@ -194,99 +196,101 @@
@version,
payload,
account_sid: @solution[:account_sid],
)
end
-
+
##
# Provide a user friendly representation
def to_s
'<Twilio.Api.V2010.AddressPage>'
end
end
-
+
class AddressContext < InstanceContext
##
# Initialize the AddressContext
# @param [Version] version Version that contains the resource
# @param [String] account_sid The account_sid
# @param [String] sid The sid
# @return [AddressContext] AddressContext
def initialize(version, account_sid, sid)
super(version)
-
+
# Path Solution
@solution = {
account_sid: account_sid,
sid: sid,
}
@uri = "/Accounts/#{@solution[:account_sid]}/Addresses/#{@solution[:sid]}.json"
-
+
# Dependents
@dependent_phone_numbers = nil
end
-
+
##
# Deletes the AddressInstance
# @return [Boolean] true if delete succeeds, true otherwise
def delete
return @version.delete('delete', @uri)
end
-
+
##
# Fetch a AddressInstance
# @return [AddressInstance] Fetched AddressInstance
def fetch
params = {}
-
+
payload = @version.fetch(
'GET',
@uri,
params,
)
-
+
return 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
# @return [AddressInstance] Updated AddressInstance
- def update(friendly_name: nil, customer_name: nil, street: nil, city: nil, region: nil, postal_code: nil)
+ def update(friendly_name: nil, customer_name: nil, street: nil, city: nil, region: nil, postal_code: nil, emergency_enabled: nil)
data = {
'FriendlyName' => friendly_name,
'CustomerName' => customer_name,
'Street' => street,
'City' => city,
'Region' => region,
'PostalCode' => postal_code,
+ 'EmergencyEnabled' => emergency_enabled,
}
-
+
payload = @version.update(
'POST',
@uri,
data: data,
)
-
+
return AddressInstance.new(
@version,
payload,
account_sid: @solution[:account_sid],
sid: @solution[:sid],
)
end
-
+
##
# Access the dependent_phone_numbers
# @return [DependentPhoneNumberList] DependentPhoneNumberList
def dependent_phone_numbers
unless @dependent_phone_numbers
@@ -294,33 +298,33 @@
@version,
account_sid: @solution[:account_sid],
address_sid: @solution[:sid],
)
end
-
+
@dependent_phone_numbers
end
-
+
##
# Provide a user friendly representation
def to_s
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
"#<Twilio.Api.V2010.AddressContext #{context}>"
end
end
-
+
class AddressInstance < InstanceResource
##
# 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
# @return [AddressInstance] AddressInstance
def initialize(version, payload, account_sid: nil, sid: nil)
super(version)
-
+
# Marshaled Properties
@properties = {
'account_sid' => payload['account_sid'],
'city' => payload['city'],
'customer_name' => payload['customer_name'],
@@ -331,20 +335,22 @@
'postal_code' => payload['postal_code'],
'region' => payload['region'],
'sid' => payload['sid'],
'street' => payload['street'],
'uri' => payload['uri'],
+ 'emergency_enabled' => payload['emergency_enabled'],
+ 'validated' => payload['validated'],
}
-
+
# Context
@instance_context = nil
@params = {
'account_sid' => account_sid,
'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
# @param [Version] version Version that contains the resource
# @return [AddressContext] AddressContext for this AddressInstance
@@ -356,99 +362,109 @@
@params['sid'],
)
end
@instance_context
end
-
+
def account_sid
@properties['account_sid']
end
-
+
def city
@properties['city']
end
-
+
def customer_name
@properties['customer_name']
end
-
+
def date_created
@properties['date_created']
end
-
+
def date_updated
@properties['date_updated']
end
-
+
def friendly_name
@properties['friendly_name']
end
-
+
def iso_country
@properties['iso_country']
end
-
+
def postal_code
@properties['postal_code']
end
-
+
def region
@properties['region']
end
-
+
def sid
@properties['sid']
end
-
+
def street
@properties['street']
end
-
+
def uri
@properties['uri']
end
-
+
+ def emergency_enabled
+ @properties['emergency_enabled']
+ end
+
+ def validated
+ @properties['validated']
+ end
+
##
# Deletes the AddressInstance
# @return [Boolean] true if delete succeeds, true otherwise
def delete
context.delete
end
-
+
##
# Fetch a AddressInstance
# @return [AddressInstance] Fetched AddressInstance
def fetch
context.fetch
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
# @return [AddressInstance] Updated AddressInstance
- def update(friendly_name: nil, customer_name: nil, street: nil, city: nil, region: nil, postal_code: nil)
+ def update(friendly_name: nil, customer_name: nil, street: nil, city: nil, region: nil, postal_code: nil, emergency_enabled: nil)
context.update(
friendly_name: friendly_name,
customer_name: customer_name,
street: street,
city: city,
region: region,
postal_code: postal_code,
+ emergency_enabled: emergency_enabled,
)
end
-
+
##
# Access the dependent_phone_numbers
# @return [dependent_phone_numbers] dependent_phone_numbers
def dependent_phone_numbers
context.dependent_phone_numbers
end
-
+
##
# Provide a user friendly representation
def to_s
values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
"<Twilio.Api.V2010.AddressInstance #{values}>"
\ No newline at end of file