##
# This code was generated by
# \ / _ _ _| _ _
# | (_)\/(_)(_|\/| |(/_ v1.0.0
# / /
#
# frozen_string_literal: true
module Twilio
module REST
class Accounts < Domain
class V1 < Version
class CredentialList < ListResource
class AwsList < ListResource
##
# Initialize the AwsList
# @param [Version] version Version that contains the resource
# @return [AwsList] AwsList
def initialize(version)
super(version)
# Path Solution
@solution = {}
@uri = "/Credentials/AWS"
end
##
# Lists AwsInstance records from the API as a list.
# Unlike stream(), this operation is eager and will load `limit` records into
# memory before returning.
# @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(limit: nil, page_size: nil)
self.stream(limit: limit, page_size: page_size).entries
end
##
# Streams AwsInstance records from the API as an Enumerable.
# This operation lazily loads records as efficiently as possible until the limit
# is reached.
# @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 [Enumerable] Enumerable that will yield up to limit results
def stream(limit: nil, page_size: nil)
limits = @version.read_limits(limit, page_size)
page = self.page(page_size: limits[:page_size], )
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end
##
# When passed a block, yields AwsInstance records from the API.
# This operation lazily loads records as efficiently as possible until the limit
# is reached.
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 AwsInstance records from the API.
# Request is executed immediately.
# @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 AwsInstance
def page(page_token: :unset, page_number: :unset, page_size: :unset)
params = Twilio::Values.of({
'PageToken' => page_token,
'Page' => page_number,
'PageSize' => page_size,
})
response = @version.page('GET', @uri, params)
AwsPage.new(@version, response, @solution)
end
##
# Retrieve a single page of AwsInstance records from the API.
# Request is executed immediately.
# @param [String] target_url API-generated URL for the requested results page
# @return [Page] Page of AwsInstance
def get_page(target_url)
response = @version.domain.request(
'GET',
target_url
)
AwsPage.new(@version, response, @solution)
end
##
# Create the AwsInstance
# @param [String] credentials A string that contains the AWS access credentials in
# the format `<AWS_ACCESS_KEY_ID>:<AWS_SECRET_ACCESS_KEY>`. For example,
# `AKIAIOSFODNN7EXAMPLE:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`
# @param [String] friendly_name A descriptive string that you create to describe
# the resource. It can be up to 64 characters long.
# @param [String] account_sid The SID of the Subaccount that this Credential
# should be associated with. Must be a valid Subaccount of the account issuing the
# request.
# @return [AwsInstance] Created AwsInstance
def create(credentials: nil, friendly_name: :unset, account_sid: :unset)
data = Twilio::Values.of({
'Credentials' => credentials,
'FriendlyName' => friendly_name,
'AccountSid' => account_sid,
})
payload = @version.create('POST', @uri, data: data)
AwsInstance.new(@version, payload, )
end
##
# Provide a user friendly representation
def to_s
'#<Twilio.Accounts.V1.AwsList>'
end
end
class AwsPage < Page
##
# Initialize the AwsPage
# @param [Version] version Version that contains the resource
# @param [Response] response Response from the API
# @param [Hash] solution Path solution for the resource
# @return [AwsPage] AwsPage
def initialize(version, response, solution)
super(version, response)
# Path Solution
@solution = solution
end
##
# Build an instance of AwsInstance
# @param [Hash] payload Payload response from the API
# @return [AwsInstance] AwsInstance
def get_instance(payload)
AwsInstance.new(@version, payload, )
end
##
# Provide a user friendly representation
def to_s
'<Twilio.Accounts.V1.AwsPage>'
end
end
class AwsContext < InstanceContext
##
# Initialize the AwsContext
# @param [Version] version Version that contains the resource
# @param [String] sid The Twilio-provided string that uniquely identifies the AWS
# resource to fetch.
# @return [AwsContext] AwsContext
def initialize(version, sid)
super(version)
# Path Solution
@solution = {sid: sid, }
@uri = "/Credentials/AWS/#{@solution[:sid]}"
end
##
# Fetch the AwsInstance
# @return [AwsInstance] Fetched AwsInstance
def fetch
payload = @version.fetch('GET', @uri)
AwsInstance.new(@version, payload, sid: @solution[:sid], )
end
##
# Update the AwsInstance
# @param [String] friendly_name A descriptive string that you create to describe
# the resource. It can be up to 64 characters long.
# @return [AwsInstance] Updated AwsInstance
def update(friendly_name: :unset)
data = Twilio::Values.of({'FriendlyName' => friendly_name, })
payload = @version.update('POST', @uri, data: data)
AwsInstance.new(@version, payload, sid: @solution[:sid], )
end
##
# Delete the AwsInstance
# @return [Boolean] true if delete succeeds, false otherwise
def delete
@version.delete('DELETE', @uri)
end
##
# Provide a user friendly representation
def to_s
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
"#<Twilio.Accounts.V1.AwsContext #{context}>"
end
##
# Provide a detailed, user friendly representation
def inspect
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
"#<Twilio.Accounts.V1.AwsContext #{context}>"
end
end
class AwsInstance < InstanceResource
##
# Initialize the AwsInstance
# @param [Version] version Version that contains the resource
# @param [Hash] payload payload that contains response from Twilio
# @param [String] sid The Twilio-provided string that uniquely identifies the AWS
# resource to fetch.
# @return [AwsInstance] AwsInstance
def initialize(version, payload, sid: nil)
super(version)
# Marshaled Properties
@properties = {
'sid' => payload['sid'],
'account_sid' => payload['account_sid'],
'friendly_name' => payload['friendly_name'],
'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
'url' => payload['url'],
}
# Context
@instance_context = nil
@params = {'sid' => sid || @properties['sid'], }
end
##
# Generate an instance context for the instance, the context is capable of
# performing various actions. All instance actions are proxied to the context
# @return [AwsContext] AwsContext for this AwsInstance
def context
unless @instance_context
@instance_context = AwsContext.new(@version, @params['sid'], )
end
@instance_context
end
##
# @return [String] The unique string that identifies the resource
def sid
@properties['sid']
end
##
# @return [String] The SID of the Account that created the resource
def account_sid
@properties['account_sid']
end
##
# @return [String] The string that you assigned to describe the resource
def friendly_name
@properties['friendly_name']
end
##
# @return [Time] The RFC 2822 date and time in GMT when the resource was created
def date_created
@properties['date_created']
end
##
# @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
def date_updated
@properties['date_updated']
end
##
# @return [String] The URI for this resource, relative to `https://accounts.twilio.com`
def url
@properties['url']
end
##
# Fetch the AwsInstance
# @return [AwsInstance] Fetched AwsInstance
def fetch
context.fetch
end
##
# Update the AwsInstance
# @param [String] friendly_name A descriptive string that you create to describe
# the resource. It can be up to 64 characters long.
# @return [AwsInstance] Updated AwsInstance
def update(friendly_name: :unset)
context.update(friendly_name: friendly_name, )
end
##
# Delete the AwsInstance
# @return [Boolean] true if delete succeeds, false otherwise
def delete
context.delete
end
##
# Provide a user friendly representation
def to_s
values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
"<Twilio.Accounts.V1.AwsInstance #{values}>"
end
##
# Provide a detailed, user friendly representation
def inspect
values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
"<Twilio.Accounts.V1.AwsInstance #{values}>"
end
end
end
end
end
end
end