## # 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 PluginConfigurationContext < InstanceContext class ConfiguredPluginList < ListResource ## # Initialize the ConfiguredPluginList # @param [Version] version Version that contains the resource # @return [ConfiguredPluginList] ConfiguredPluginList def initialize(version, configuration_sid: nil) super(version) # Path Solution @solution = { configuration_sid: configuration_sid } @uri = "/PluginService/Configurations/#{@solution[:configuration_sid]}/Plugins" end ## # Lists ConfiguredPluginInstance 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 ConfiguredPluginInstance 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 ConfiguredPluginInstance 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 ConfiguredPluginInstance 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) ConfiguredPluginPage.new(@version, response, @solution) end ## # Retrieve a single page of ConfiguredPluginInstance records from the API. # Request is executed immediately. # @param [String] target_url API-generated URL for the requested results page # @return [Page] Page of ConfiguredPluginInstance def get_page(target_url) response = @version.domain.request( 'GET', target_url ) ConfiguredPluginPage.new(@version, response, @solution) end # Provide a user friendly representation def to_s '#' end end class ConfiguredPluginContext < InstanceContext ## # Initialize the ConfiguredPluginContext # @param [Version] version Version that contains the resource # @param [String] configuration_sid The SID of the Flex Plugin Configuration the resource to belongs to. # @param [String] plugin_sid The unique string that we created to identify the Flex Plugin resource. # @return [ConfiguredPluginContext] ConfiguredPluginContext def initialize(version, configuration_sid, plugin_sid) super(version) # Path Solution @solution = { configuration_sid: configuration_sid, plugin_sid: plugin_sid, } @uri = "/PluginService/Configurations/#{@solution[:configuration_sid]}/Plugins/#{@solution[:plugin_sid]}" end ## # Fetch the ConfiguredPluginInstance # @param [String] flex_metadata The Flex-Metadata HTTP request header # @return [ConfiguredPluginInstance] Fetched ConfiguredPluginInstance def fetch( flex_metadata: :unset ) headers = Twilio::Values.of({ 'Flex-Metadata' => flex_metadata, }) payload = @version.fetch('GET', @uri, headers: headers) ConfiguredPluginInstance.new( @version, payload, configuration_sid: @solution[:configuration_sid], plugin_sid: @solution[:plugin_sid], ) end ## # Provide a user friendly representation def to_s context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#" end ## # Provide a detailed, user friendly representation def inspect context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#" end end class ConfiguredPluginPage < Page ## # Initialize the ConfiguredPluginPage # @param [Version] version Version that contains the resource # @param [Response] response Response from the API # @param [Hash] solution Path solution for the resource # @return [ConfiguredPluginPage] ConfiguredPluginPage def initialize(version, response, solution) super(version, response) # Path Solution @solution = solution end ## # Build an instance of ConfiguredPluginInstance # @param [Hash] payload Payload response from the API # @return [ConfiguredPluginInstance] ConfiguredPluginInstance def get_instance(payload) ConfiguredPluginInstance.new(@version, payload, configuration_sid: @solution[:configuration_sid]) end ## # Provide a user friendly representation def to_s '' end end class ConfiguredPluginInstance < InstanceResource ## # Initialize the ConfiguredPluginInstance # @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 ConfiguredPlugin # resource. # @param [String] sid The SID of the Call resource to fetch. # @return [ConfiguredPluginInstance] ConfiguredPluginInstance def initialize(version, payload , configuration_sid: nil, plugin_sid: nil) super(version) # Marshaled Properties @properties = { 'account_sid' => payload['account_sid'], 'configuration_sid' => payload['configuration_sid'], 'plugin_sid' => payload['plugin_sid'], 'plugin_version_sid' => payload['plugin_version_sid'], 'phase' => payload['phase'] == nil ? payload['phase'] : payload['phase'].to_i, 'plugin_url' => payload['plugin_url'], 'unique_name' => payload['unique_name'], 'friendly_name' => payload['friendly_name'], 'description' => payload['description'], 'plugin_archived' => payload['plugin_archived'], 'version' => payload['version'], 'changelog' => payload['changelog'], 'plugin_version_archived' => payload['plugin_version_archived'], 'private' => payload['private'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'url' => payload['url'], } # Context @instance_context = nil @params = { 'configuration_sid' => configuration_sid || @properties['configuration_sid'] ,'plugin_sid' => plugin_sid || @properties['plugin_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 [ConfiguredPluginContext] CallContext for this CallInstance def context unless @instance_context @instance_context = ConfiguredPluginContext.new(@version , @params['configuration_sid'], @params['plugin_sid']) end @instance_context end ## # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Flex Plugin resource is installed for. def account_sid @properties['account_sid'] end ## # @return [String] The SID of the Flex Plugin Configuration that this Flex Plugin belongs to. def configuration_sid @properties['configuration_sid'] end ## # @return [String] The SID of the Flex Plugin. def plugin_sid @properties['plugin_sid'] end ## # @return [String] The SID of the Flex Plugin Version. def plugin_version_sid @properties['plugin_version_sid'] end ## # @return [String] The phase this Flex Plugin would initialize at runtime. def phase @properties['phase'] end ## # @return [String] The URL of where the Flex Plugin Version JavaScript bundle is hosted on. def plugin_url @properties['plugin_url'] end ## # @return [String] The name that uniquely identifies this Flex Plugin resource. def unique_name @properties['unique_name'] end ## # @return [String] The friendly name of 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 plugin_archived @properties['plugin_archived'] end ## # @return [String] The latest version of this Flex Plugin Version. def version @properties['version'] end ## # @return [String] A changelog that describes the changes this Flex Plugin Version brings. def changelog @properties['changelog'] end ## # @return [Boolean] Whether the Flex Plugin Version is archived. The default value is false. def plugin_version_archived @properties['plugin_version_archived'] end ## # @return [Boolean] Whether to validate the request is authorized to access the Flex Plugin Version. def private @properties['private'] end ## # @return [Time] The date and time in GMT when the Flex Plugin was installed specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. def date_created @properties['date_created'] end ## # @return [String] The absolute URL of the Flex Plugin resource. def url @properties['url'] end ## # Fetch the ConfiguredPluginInstance # @param [String] flex_metadata The Flex-Metadata HTTP request header # @return [ConfiguredPluginInstance] Fetched ConfiguredPluginInstance def fetch( flex_metadata: :unset ) context.fetch( flex_metadata: flex_metadata, ) end ## # Provide a user friendly representation def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "" end ## # Provide a detailed, user friendly representation def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "" end end end end end end end