##
# This code was generated by
# ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
# | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
# | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
#
# Twilio - Flex
# This is the public Twilio REST API.
#
# NOTE: This class is auto generated by OpenAPI Generator.
# https://openapi-generator.tech
# Do not edit the class manually.
#
module Twilio
module REST
class FlexApi < FlexApiBase
class V1 < Version
class PluginList < ListResource
##
# Initialize the PluginList
# @param [Version] version Version that contains the resource
# @return [PluginList] PluginList
def initialize(version)
super(version)
# Path Solution
@solution = { }
@uri = "/PluginService/Plugins"
end
##
# Create the PluginInstance
# @param [String] unique_name The Flex Plugin's unique name.
# @param [String] friendly_name The Flex Plugin's friendly name.
# @param [String] description A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long
# @param [String] flex_metadata The Flex-Metadata HTTP request header
# @return [PluginInstance] Created PluginInstance
def create(
unique_name: nil,
friendly_name: :unset,
description: :unset,
flex_metadata: :unset
)
data = Twilio::Values.of({
'UniqueName' => unique_name,
'FriendlyName' => friendly_name,
'Description' => description,
})
headers = Twilio::Values.of({ 'Flex-Metadata' => flex_metadata, })
payload = @version.create('POST', @uri, data: data, headers: headers)
PluginInstance.new(
@version,
payload,
)
end
##
# Lists PluginInstance records from the API as a list.
# Unlike stream(), this operation is eager and will load `limit` records into
# memory before returning.
# @param [String] flex_metadata The Flex-Metadata HTTP request header
# @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(flex_metadata: :unset, limit: nil, page_size: nil)
self.stream(
flex_metadata: flex_metadata,
limit: limit,
page_size: page_size
).entries
end
##
# Streams Instance records from the API as an Enumerable.
# This operation lazily loads records as efficiently as possible until the limit
# is reached.
# @param [String] flex_metadata The Flex-Metadata HTTP request header
# @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(flex_metadata: :unset, limit: nil, page_size: nil)
limits = @version.read_limits(limit, page_size)
page = self.page(
flex_metadata: flex_metadata,
page_size: limits[:page_size], )
@version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end
##
# When passed a block, yields PluginInstance 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 PluginInstance records from the API.
# Request is executed immediately.
# @param [String] flex_metadata The Flex-Metadata HTTP request header
# @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 PluginInstance
def page(flex_metadata: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
params = Twilio::Values.of({
'Flex-Metadata' => flex_metadata,
'PageToken' => page_token,
'Page' => page_number,
'PageSize' => page_size,
})
response = @version.page('GET', @uri, params: params)
PluginPage.new(@version, response, @solution)
end
##
# Retrieve a single page of PluginInstance records from the API.
# Request is executed immediately.
# @param [String] target_url API-generated URL for the requested results page
# @return [Page] Page of PluginInstance
def get_page(target_url)
response = @version.domain.request(
'GET',
target_url
)
PluginPage.new(@version, response, @solution)
end
# Provide a user friendly representation
def to_s
'#<Twilio.FlexApi.V1.PluginList>'
end
end
class PluginContext < InstanceContext
##
# Initialize the PluginContext
# @param [Version] version Version that contains the resource
# @param [String] sid The SID of the Flex Plugin resource to update.
# @return [PluginContext] PluginContext
def initialize(version, sid)
super(version)
# Path Solution
@solution = { sid: sid, }
@uri = "/PluginService/Plugins/#{@solution[:sid]}"
# Dependents
@plugin_versions = nil
end
##
# Fetch the PluginInstance
# @param [String] flex_metadata The Flex-Metadata HTTP request header
# @return [PluginInstance] Fetched PluginInstance
def fetch(
flex_metadata: :unset
)
headers = Twilio::Values.of({ 'Flex-Metadata' => flex_metadata, })
payload = @version.fetch('GET', @uri, headers: headers)
PluginInstance.new(
@version,
payload,
sid: @solution[:sid],
)
end
##
# Update the PluginInstance
# @param [String] friendly_name The Flex Plugin's friendly name.
# @param [String] description A descriptive string that you update to describe the plugin resource. It can be up to 500 characters long
# @param [String] flex_metadata The Flex-Metadata HTTP request header
# @return [PluginInstance] Updated PluginInstance
def update(
friendly_name: :unset,
description: :unset,
flex_metadata: :unset
)
data = Twilio::Values.of({
'FriendlyName' => friendly_name,
'Description' => description,
})
headers = Twilio::Values.of({ 'Flex-Metadata' => flex_metadata, })
payload = @version.update('POST', @uri, data: data, headers: headers)
PluginInstance.new(
@version,
payload,
sid: @solution[:sid],
)
end
##
# Access the plugin_versions
# @return [PluginVersionsList]
# @return [PluginVersionsContext] if sid was passed.
def plugin_versions(sid=:unset)
raise ArgumentError, 'sid cannot be nil' if sid.nil?
if sid != :unset
return PluginVersionsContext.new(@version, @solution[:sid],sid )
end
unless @plugin_versions
@plugin_versions = PluginVersionsList.new(
@version, plugin_sid: @solution[:sid], )
end
@plugin_versions
end
##
# Provide a user friendly representation
def to_s
context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
"#<Twilio.FlexApi.V1.PluginContext #{context}>"
end
##
# Provide a detailed, user friendly representation
def inspect
context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
"#<Twilio.FlexApi.V1.PluginContext #{context}>"
end
end
class PluginPage < Page
##
# Initialize the PluginPage
# @param [Version] version Version that contains the resource
# @param [Response] response Response from the API
# @param [Hash] solution Path solution for the resource
# @return [PluginPage] PluginPage
def initialize(version, response, solution)
super(version, response)
# Path Solution
@solution = solution
end
##
# Build an instance of PluginInstance
# @param [Hash] payload Payload response from the API
# @return [PluginInstance] PluginInstance
def get_instance(payload)
PluginInstance.new(@version, payload)
end
##
# Provide a user friendly representation
def to_s
'<Twilio.FlexApi.V1.PluginPage>'
end
end
class PluginInstance < InstanceResource
##
# Initialize the PluginInstance
# @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/iam/api/account] that created this Plugin
# resource.
# @param [String] sid The SID of the Call resource to fetch.
# @return [PluginInstance] PluginInstance
def initialize(version, payload , sid: nil)
super(version)
# Marshaled Properties
@properties = {
'sid' => payload['sid'],
'account_sid' => payload['account_sid'],
'unique_name' => payload['unique_name'],
'friendly_name' => payload['friendly_name'],
'description' => payload['description'],
'archived' => payload['archived'],
'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
'url' => payload['url'],
'links' => payload['links'],
}
# 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 [PluginContext] CallContext for this CallInstance
def context
unless @instance_context
@instance_context = PluginContext.new(@version , @params['sid'])
end
@instance_context
end
##
# @return [String] The unique string that we created to identify the Flex Plugin resource.
def sid
@properties['sid']
end
##
# @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin resource and owns this resource.
def account_sid
@properties['account_sid']
end
##
# @return [String] The name that uniquely identifies this Flex Plugin resource.
def unique_name
@properties['unique_name']
end
##
# @return [String] The friendly name this Flex Plugin resource.
def friendly_name
@properties['friendly_name']
end
##
# @return [String] A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long
def description
@properties['description']
end
##
# @return [Boolean] Whether the Flex Plugin is archived. The default value is false.
def archived
@properties['archived']
end
##
# @return [Time] The date and time in GMT-7 when the Flex Plugin was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
def date_created
@properties['date_created']
end
##
# @return [Time] The date and time in GMT-7 when the Flex Plugin was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
def date_updated
@properties['date_updated']
end
##
# @return [String] The absolute URL of the Flex Plugin resource.
def url
@properties['url']
end
##
# @return [Hash]
def links
@properties['links']
end
##
# Fetch the PluginInstance
# @param [String] flex_metadata The Flex-Metadata HTTP request header
# @return [PluginInstance] Fetched PluginInstance
def fetch(
flex_metadata: :unset
)
context.fetch(
flex_metadata: flex_metadata,
)
end
##
# Update the PluginInstance
# @param [String] friendly_name The Flex Plugin's friendly name.
# @param [String] description A descriptive string that you update to describe the plugin resource. It can be up to 500 characters long
# @param [String] flex_metadata The Flex-Metadata HTTP request header
# @return [PluginInstance] Updated PluginInstance
def update(
friendly_name: :unset,
description: :unset,
flex_metadata: :unset
)
context.update(
friendly_name: friendly_name,
description: description,
flex_metadata: flex_metadata,
)
end
##
# Access the plugin_versions
# @return [plugin_versions] plugin_versions
def plugin_versions
context.plugin_versions
end
##
# Provide a user friendly representation
def to_s
values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
"<Twilio.FlexApi.V1.PluginInstance #{values}>"
end
##
# Provide a detailed, user friendly representation
def inspect
values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
"<Twilio.FlexApi.V1.PluginInstance #{values}>"
end
end
end
end
end
end