## # 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 PluginReleaseList < ListResource ## # Initialize the PluginReleaseList # @param [Version] version Version that contains the resource # @return [PluginReleaseList] PluginReleaseList def initialize(version) super(version) # Path Solution @solution = { } @uri = "/PluginService/Releases" end ## # Create the PluginReleaseInstance # @param [String] configuration_id The SID or the Version of the Flex Plugin Configuration to release. # @param [String] flex_metadata The Flex-Metadata HTTP request header # @return [PluginReleaseInstance] Created PluginReleaseInstance def create( configuration_id: nil, flex_metadata: :unset ) data = Twilio::Values.of({ 'ConfigurationId' => configuration_id, }) headers = Twilio::Values.of({ 'Flex-Metadata' => flex_metadata, }) payload = @version.create('POST', @uri, data: data, headers: headers) PluginReleaseInstance.new( @version, payload, ) end ## # Lists PluginReleaseInstance 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 PluginReleaseInstance 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 PluginReleaseInstance 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 PluginReleaseInstance 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) PluginReleasePage.new(@version, response, @solution) end ## # Retrieve a single page of PluginReleaseInstance records from the API. # Request is executed immediately. # @param [String] target_url API-generated URL for the requested results page # @return [Page] Page of PluginReleaseInstance def get_page(target_url) response = @version.domain.request( 'GET', target_url ) PluginReleasePage.new(@version, response, @solution) end # Provide a user friendly representation def to_s '#' end end class PluginReleaseContext < InstanceContext ## # Initialize the PluginReleaseContext # @param [Version] version Version that contains the resource # @param [String] sid The SID of the Flex Plugin Release resource to fetch. # @return [PluginReleaseContext] PluginReleaseContext def initialize(version, sid) super(version) # Path Solution @solution = { sid: sid, } @uri = "/PluginService/Releases/#{@solution[:sid]}" end ## # Fetch the PluginReleaseInstance # @param [String] flex_metadata The Flex-Metadata HTTP request header # @return [PluginReleaseInstance] Fetched PluginReleaseInstance def fetch( flex_metadata: :unset ) headers = Twilio::Values.of({ 'Flex-Metadata' => flex_metadata, }) payload = @version.fetch('GET', @uri, headers: headers) PluginReleaseInstance.new( @version, payload, sid: @solution[: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 PluginReleasePage < Page ## # Initialize the PluginReleasePage # @param [Version] version Version that contains the resource # @param [Response] response Response from the API # @param [Hash] solution Path solution for the resource # @return [PluginReleasePage] PluginReleasePage def initialize(version, response, solution) super(version, response) # Path Solution @solution = solution end ## # Build an instance of PluginReleaseInstance # @param [Hash] payload Payload response from the API # @return [PluginReleaseInstance] PluginReleaseInstance def get_instance(payload) PluginReleaseInstance.new(@version, payload) end ## # Provide a user friendly representation def to_s '' end end class PluginReleaseInstance < InstanceResource ## # Initialize the PluginReleaseInstance # @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 PluginRelease # resource. # @param [String] sid The SID of the Call resource to fetch. # @return [PluginReleaseInstance] PluginReleaseInstance def initialize(version, payload , sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'account_sid' => payload['account_sid'], 'configuration_sid' => payload['configuration_sid'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), '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 [PluginReleaseContext] CallContext for this CallInstance def context unless @instance_context @instance_context = PluginReleaseContext.new(@version , @params['sid']) end @instance_context end ## # @return [String] The unique string that we created to identify the Plugin Release resource. def sid @properties['sid'] end ## # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Plugin Release resource and owns this resource. def account_sid @properties['account_sid'] end ## # @return [String] The SID of the Plugin Configuration resource to release. def configuration_sid @properties['configuration_sid'] end ## # @return [Time] The date and time in GMT when the Flex Plugin Release was created 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 Plugin Release resource. def url @properties['url'] end ## # Fetch the PluginReleaseInstance # @param [String] flex_metadata The Flex-Metadata HTTP request header # @return [PluginReleaseInstance] Fetched PluginReleaseInstance 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