lib/twilio-ruby/rest/monitor/v1/alert.rb in twilio-ruby-5.0.0.rc18 vs lib/twilio-ruby/rest/monitor/v1/alert.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 Monitor < Domain
class V1 < Version
@@ -13,135 +13,107 @@
# Initialize the AlertList
# @param [Version] version Version that contains the resource
# @return [AlertList] AlertList
def initialize(version)
super(version)
-
+
# Path Solution
@solution = {}
@uri = "/Alerts"
end
-
+
##
# Lists AlertInstance records from the API as a list.
# Unlike stream(), this operation is eager and will load `limit` records into
# memory before returning.
# @param [String] log_level The log_level
- # @param [Time] start_date_before The start_date
- # @param [Time] start_date The start_date
- # @param [Time] start_date_after: The start_date
- # @param [Time] end_date_before The end_date
- # @param [Time] end_date The end_date
- # @param [Time] end_date_after: The end_date
+ # @param [Date] start_date The start_date
+ # @param [Date] end_date The end_date
# @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(log_level: nil, start_date_before: nil, start_date: nil, start_date_after: nil, end_date_before: nil, end_date: nil, end_date_after: nil, limit: nil, page_size: nil)
+ def list(log_level: nil, start_date: nil, end_date: nil, limit: nil, page_size: nil)
self.stream(
log_level: log_level,
- start_date_before: start_date_before,
start_date: start_date,
- start_date_after: start_date_after,
- end_date_before: end_date_before,
end_date: end_date,
- end_date_after: end_date_after,
limit: limit,
page_size: page_size
).entries
end
-
+
##
# Streams AlertInstance records from the API as an Enumerable.
# This operation lazily loads records as efficiently as possible until the limit
# is reached.
# @param [String] log_level The log_level
- # @param [Time] start_date_before The start_date
- # @param [Time] start_date The start_date
- # @param [Time] start_date_after: The start_date
- # @param [Time] end_date_before The end_date
- # @param [Time] end_date The end_date
- # @param [Time] end_date_after: The end_date
+ # @param [Date] start_date The start_date
+ # @param [Date] end_date The end_date
# @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(log_level: nil, start_date_before: nil, start_date: nil, start_date_after: nil, end_date_before: nil, end_date: nil, end_date_after: nil, limit: nil, page_size: nil)
+ def stream(log_level: nil, start_date: nil, end_date: nil, limit: nil, page_size: nil)
limits = @version.read_limits(limit, page_size)
-
+
page = self.page(
log_level: log_level,
- start_date_before: start_date_before,
start_date: start_date,
- start_date_after: start_date_after,
- end_date_before: end_date_before,
end_date: end_date,
- end_date_after: end_date_after,
page_size: limits[:page_size],
)
-
+
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end
-
+
##
# When passed a block, yields AlertInstance records from the API.
# This operation lazily loads records as efficiently as possible until the limit
# is reached.
# @param [String] log_level The log_level
- # @param [Time] start_date_before The start_date
- # @param [Time] start_date The start_date
- # @param [Time] start_date_after: The start_date
- # @param [Time] end_date_before The end_date
- # @param [Time] end_date The end_date
- # @param [Time] end_date_after: The end_date
+ # @param [Date] start_date The start_date
+ # @param [Date] end_date The end_date
# @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)
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 AlertInstance records from the API.
# Request is executed immediately.
# @param [String] log_level The log_level
- # @param [Time] start_date_before The start_date
- # @param [Time] start_date The start_date
- # @param [Time] start_date_after: The start_date
- # @param [Time] end_date_before The end_date
- # @param [Time] end_date The end_date
- # @param [Time] end_date_after: The end_date
+ # @param [Date] start_date The start_date
+ # @param [Date] end_date The end_date
# @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 AlertInstance
- def page(log_level: nil, start_date_before: nil, start_date: nil, start_date_after: nil, end_date_before: nil, end_date: nil, end_date_after: nil, page_token: nil, page_number: nil, page_size: nil)
+ def page(log_level: nil, start_date: nil, end_date: nil, page_token: nil, page_number: nil, page_size: nil)
params = {
'LogLevel' => log_level,
- 'StartDate<' => Twilio.serialize_iso8601(start_date_before),
'StartDate' => Twilio.serialize_iso8601(start_date),
- 'StartDate>' => Twilio.serialize_iso8601(start_date_after),
- 'EndDate<' => Twilio.serialize_iso8601(end_date_before),
'EndDate' => Twilio.serialize_iso8601(end_date),
- 'EndDate>' => Twilio.serialize_iso8601(end_date_after),
'PageToken' => page_token,
'Page' => page_number,
'PageSize' => page_size,
}
response = @version.page(
@@ -149,110 +121,110 @@
@uri,
params
)
return AlertPage.new(@version, response, @solution)
end
-
+
##
# Provide a user friendly representation
def to_s
'#<Twilio.Monitor.V1.AlertList>'
end
end
-
+
class AlertPage < Page
##
# Initialize the AlertPage
# @param [Version] version Version that contains the resource
# @param [Response] response Response from the API
# @param [Hash] solution Path solution for the resource
# @return [AlertPage] AlertPage
def initialize(version, response, solution)
super(version, response)
-
+
# Path Solution
@solution = solution
end
-
+
##
# Build an instance of AlertInstance
# @param [Hash] payload Payload response from the API
# @return [AlertInstance] AlertInstance
def get_instance(payload)
return AlertInstance.new(
@version,
payload,
)
end
-
+
##
# Provide a user friendly representation
def to_s
'<Twilio.Monitor.V1.AlertPage>'
end
end
-
+
class AlertContext < InstanceContext
##
# Initialize the AlertContext
# @param [Version] version Version that contains the resource
# @param [String] sid The sid
# @return [AlertContext] AlertContext
def initialize(version, sid)
super(version)
-
+
# Path Solution
@solution = {
sid: sid,
}
@uri = "/Alerts/#{@solution[:sid]}"
end
-
+
##
# Fetch a AlertInstance
# @return [AlertInstance] Fetched AlertInstance
def fetch
params = {}
-
+
payload = @version.fetch(
'GET',
@uri,
params,
)
-
+
return AlertInstance.new(
@version,
payload,
sid: @solution[:sid],
)
end
-
+
##
# Deletes the AlertInstance
# @return [Boolean] true if delete succeeds, true otherwise
def delete
return @version.delete('delete', @uri)
end
-
+
##
# Provide a user friendly representation
def to_s
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
"#<Twilio.Monitor.V1.AlertContext #{context}>"
end
end
-
+
class AlertInstance < InstanceResource
##
# Initialize the AlertInstance
# @param [Version] version Version that contains the resource
# @param [Hash] payload payload that contains response from Twilio
# @param [String] sid The sid
# @return [AlertInstance] AlertInstance
def initialize(version, payload, sid: nil)
super(version)
-
+
# Marshaled Properties
@properties = {
'account_sid' => payload['account_sid'],
'alert_text' => payload['alert_text'],
'api_version' => payload['api_version'],
@@ -269,18 +241,18 @@
'url' => payload['url'],
'request_variables' => payload['request_variables'],
'response_body' => payload['response_body'],
'response_headers' => payload['response_headers'],
}
-
+
# 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
# @param [Version] version Version that contains the resource
# @return [AlertContext] AlertContext for this AlertInstance
@@ -291,92 +263,92 @@
@params['sid'],
)
end
@instance_context
end
-
+
def account_sid
@properties['account_sid']
end
-
+
def alert_text
@properties['alert_text']
end
-
+
def api_version
@properties['api_version']
end
-
+
def date_created
@properties['date_created']
end
-
+
def date_generated
@properties['date_generated']
end
-
+
def date_updated
@properties['date_updated']
end
-
+
def error_code
@properties['error_code']
end
-
+
def log_level
@properties['log_level']
end
-
+
def more_info
@properties['more_info']
end
-
+
def request_method
@properties['request_method']
end
-
+
def request_url
@properties['request_url']
end
-
+
def request_variables
@properties['request_variables']
end
-
+
def resource_sid
@properties['resource_sid']
end
-
+
def response_body
@properties['response_body']
end
-
+
def response_headers
@properties['response_headers']
end
-
+
def sid
@properties['sid']
end
-
+
def url
@properties['url']
end
-
+
##
# Fetch a AlertInstance
# @return [AlertInstance] Fetched AlertInstance
def fetch
context.fetch
end
-
+
##
# Deletes the AlertInstance
# @return [Boolean] true if delete succeeds, true otherwise
def delete
context.delete
end
-
+
##
# Provide a user friendly representation
def to_s
values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
"<Twilio.Monitor.V1.AlertInstance #{values}>"
\ No newline at end of file