##
# This code was generated by
# \ / _ _ _| _ _
# | (_)\/(_)(_|\/| |(/_ v1.0.0
# / /
#
# frozen_string_literal: true
module Twilio
module REST
class Api < Domain
class V2010 < Version
class AccountContext < InstanceContext
class NotificationList < ListResource
##
# Initialize the NotificationList
# @param [Version] version Version that contains the resource
# @param [String] account_sid The SID of the
# [Account](https://www.twilio.com/docs/api/rest/account) that created the
# Notification resource.
# @return [NotificationList] NotificationList
def initialize(version, account_sid: nil)
super(version)
# Path Solution
@solution = {account_sid: account_sid}
@uri = "/Accounts/#{@solution[:account_sid]}/Notifications.json"
end
##
# Lists NotificationInstance 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 Only read notifications of the specified log level. Can be:
# `0` to read only ERROR notifications or `1` to read only WARNING notifications.
# By default, all notifications are read.
# @param [Time] message_date_before Filter by date
# @param [Time] message_date Filter by date
# @param [Time] message_date_after Filter by 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: :unset, message_date_before: :unset, message_date: :unset, message_date_after: :unset, limit: nil, page_size: nil)
self.stream(
log: log,
message_date_before: message_date_before,
message_date: message_date,
message_date_after: message_date_after,
limit: limit,
page_size: page_size
).entries
end
##
# Streams NotificationInstance records from the API as an Enumerable.
# This operation lazily loads records as efficiently as possible until the limit
# is reached.
# @param [String] log Only read notifications of the specified log level. Can be:
# `0` to read only ERROR notifications or `1` to read only WARNING notifications.
# By default, all notifications are read.
# @param [Time] message_date_before Filter by date
# @param [Time] message_date Filter by date
# @param [Time] message_date_after Filter by 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: :unset, message_date_before: :unset, message_date: :unset, message_date_after: :unset, limit: nil, page_size: nil)
limits = @version.read_limits(limit, page_size)
page = self.page(
log: log,
message_date_before: message_date_before,
message_date: message_date,
message_date_after: message_date_after,
page_size: limits[:page_size],
)
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end
##
# When passed a block, yields NotificationInstance 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 NotificationInstance records from the API.
# Request is executed immediately.
# @param [String] log Only read notifications of the specified log level. Can be:
# `0` to read only ERROR notifications or `1` to read only WARNING notifications.
# By default, all notifications are read.
# @param [Time] message_date_before Filter by date
# @param [Time] message_date Filter by date
# @param [Time] message_date_after Filter by 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 NotificationInstance
def page(log: :unset, message_date_before: :unset, message_date: :unset, message_date_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
params = Twilio::Values.of({
'Log' => log,
'MessageDate<' => Twilio.serialize_iso8601_date(message_date_before),
'MessageDate' => Twilio.serialize_iso8601_date(message_date),
'MessageDate>' => Twilio.serialize_iso8601_date(message_date_after),
'PageToken' => page_token,
'Page' => page_number,
'PageSize' => page_size,
})
response = @version.page(
'GET',
@uri,
params
)
NotificationPage.new(@version, response, @solution)
end
##
# Retrieve a single page of NotificationInstance records from the API.
# Request is executed immediately.
# @param [String] target_url API-generated URL for the requested results page
# @return [Page] Page of NotificationInstance
def get_page(target_url)
response = @version.domain.request(
'GET',
target_url
)
NotificationPage.new(@version, response, @solution)
end
##
# Provide a user friendly representation
def to_s
'#<Twilio.Api.V2010.NotificationList>'
end
end
class NotificationPage < Page
##
# Initialize the NotificationPage
# @param [Version] version Version that contains the resource
# @param [Response] response Response from the API
# @param [Hash] solution Path solution for the resource
# @return [NotificationPage] NotificationPage
def initialize(version, response, solution)
super(version, response)
# Path Solution
@solution = solution
end
##
# Build an instance of NotificationInstance
# @param [Hash] payload Payload response from the API
# @return [NotificationInstance] NotificationInstance
def get_instance(payload)
NotificationInstance.new(@version, payload, account_sid: @solution[:account_sid], )
end
##
# Provide a user friendly representation
def to_s
'<Twilio.Api.V2010.NotificationPage>'
end
end
class NotificationContext < InstanceContext
##
# Initialize the NotificationContext
# @param [Version] version Version that contains the resource
# @param [String] account_sid The SID of the
# [Account](https://www.twilio.com/docs/api/rest/account) that created the
# Notification resource to fetch.
# @param [String] sid The Twilio-provided string that uniquely identifies the
# Notification resource to fetch.
# @return [NotificationContext] NotificationContext
def initialize(version, account_sid, sid)
super(version)
# Path Solution
@solution = {account_sid: account_sid, sid: sid, }
@uri = "/Accounts/#{@solution[:account_sid]}/Notifications/#{@solution[:sid]}.json"
end
##
# Fetch a NotificationInstance
# @return [NotificationInstance] Fetched NotificationInstance
def fetch
params = Twilio::Values.of({})
payload = @version.fetch(
'GET',
@uri,
params,
)
NotificationInstance.new(
@version,
payload,
account_sid: @solution[:account_sid],
sid: @solution[:sid],
)
end
##
# Deletes the NotificationInstance
# @return [Boolean] true if delete succeeds, true 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.Api.V2010.NotificationContext #{context}>"
end
##
# Provide a detailed, user friendly representation
def inspect
context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
"#<Twilio.Api.V2010.NotificationContext #{context}>"
end
end
class NotificationInstance < InstanceResource
##
# Initialize the NotificationInstance
# @param [Version] version Version that contains the resource
# @param [Hash] payload payload that contains response from Twilio
# @param [String] account_sid The SID of the
# [Account](https://www.twilio.com/docs/api/rest/account) that created the
# Notification resource.
# @param [String] sid The Twilio-provided string that uniquely identifies the
# Notification resource to fetch.
# @return [NotificationInstance] NotificationInstance
def initialize(version, payload, account_sid: nil, sid: nil)
super(version)
# Marshaled Properties
@properties = {
'account_sid' => payload['account_sid'],
'api_version' => payload['api_version'],
'call_sid' => payload['call_sid'],
'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
'error_code' => payload['error_code'],
'log' => payload['log'],
'message_date' => Twilio.deserialize_rfc2822(payload['message_date']),
'message_text' => payload['message_text'],
'more_info' => payload['more_info'],
'request_method' => payload['request_method'],
'request_url' => payload['request_url'],
'sid' => payload['sid'],
'uri' => payload['uri'],
'request_variables' => payload['request_variables'],
'response_body' => payload['response_body'],
'response_headers' => payload['response_headers'],
}
# 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
# @return [NotificationContext] NotificationContext for this NotificationInstance
def context
unless @instance_context
@instance_context = NotificationContext.new(@version, @params['account_sid'], @params['sid'], )
end
@instance_context
end
##
# @return [String] The SID of the Account that created the resource
def account_sid
@properties['account_sid']
end
##
# @return [String] The API version used to generate the notification
def api_version
@properties['api_version']
end
##
# @return [String] The SID of the Call the resource is associated with
def call_sid
@properties['call_sid']
end
##
# @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 RFC 2822 date and time in GMT that the resource was last updated
def date_updated
@properties['date_updated']
end
##
# @return [String] A unique error code corresponding to the notification
def error_code
@properties['error_code']
end
##
# @return [String] An integer log level
def log
@properties['log']
end
##
# @return [Time] The date the notification was generated
def message_date
@properties['message_date']
end
##
# @return [String] The text of the notification
def message_text
@properties['message_text']
end
##
# @return [String] A URL for more information about the error code
def more_info
@properties['more_info']
end
##
# @return [String] HTTP method used with the request url
def request_method
@properties['request_method']
end
##
# @return [String] URL of the resource that generated the notification
def request_url
@properties['request_url']
end
##
# @return [String] Twilio-generated HTTP variables sent to the server
def request_variables
@properties['request_variables']
end
##
# @return [String] The HTTP body returned by your server
def response_body
@properties['response_body']
end
##
# @return [String] The HTTP headers returned by your server
def response_headers
@properties['response_headers']
end
##
# @return [String] The unique string that identifies the resource
def sid
@properties['sid']
end
##
# @return [String] The URI of the resource, relative to `https://api.twilio.com`
def uri
@properties['uri']
end
##
# Fetch a NotificationInstance
# @return [NotificationInstance] Fetched NotificationInstance
def fetch
context.fetch
end
##
# Deletes the NotificationInstance
# @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.Api.V2010.NotificationInstance #{values}>"
end
##
# Provide a detailed, user friendly representation
def inspect
values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
"<Twilio.Api.V2010.NotificationInstance #{values}>"
end
end
end
end
end
end
end