class Twilio::REST::Studio::V2::FlowList
Public Class Methods
Initialize the FlowList
@param [Version] version Version
that contains the resource @return [FlowList] FlowList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/studio/v2/flow.rb 18 def initialize(version) 19 super(version) 20 21 # Path Solution 22 @solution = {} 23 @uri = "/Flows" 24 end
Public Instance Methods
Create the FlowInstance
@param [String] friendly_name The string that you assigned to describe the Flow. @param [flow.Status] status The status of the Flow. Can be: `draft` or
`published`.
@param [Hash] definition JSON representation of flow definition. @param [String] commit_message Description of change made in the revision. @return [FlowInstance] Created FlowInstance
# File lib/twilio-ruby/rest/studio/v2/flow.rb 34 def create(friendly_name: nil, status: nil, definition: nil, commit_message: :unset) 35 data = Twilio::Values.of({ 36 'FriendlyName' => friendly_name, 37 'Status' => status, 38 'Definition' => Twilio.serialize_object(definition), 39 'CommitMessage' => commit_message, 40 }) 41 42 payload = @version.create('POST', @uri, data: data) 43 44 FlowInstance.new(@version, payload, ) 45 end
When passed a block, yields FlowInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/studio/v2/flow.rb 85 def each 86 limits = @version.read_limits 87 88 page = self.page(page_size: limits[:page_size], ) 89 90 @version.stream(page, 91 limit: limits[:limit], 92 page_limit: limits[:page_limit]).each {|x| yield x} 93 end
Retrieve a single page of FlowInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of FlowInstance
# File lib/twilio-ruby/rest/studio/v2/flow.rb 119 def get_page(target_url) 120 response = @version.domain.request( 121 'GET', 122 target_url 123 ) 124 FlowPage.new(@version, response, @solution) 125 end
Lists FlowInstance
records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @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
# File lib/twilio-ruby/rest/studio/v2/flow.rb 58 def list(limit: nil, page_size: nil) 59 self.stream(limit: limit, page_size: page_size).entries 60 end
Retrieve a single page of FlowInstance
records from the API. Request
is executed immediately. @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 FlowInstance
# File lib/twilio-ruby/rest/studio/v2/flow.rb 102 def page(page_token: :unset, page_number: :unset, page_size: :unset) 103 params = Twilio::Values.of({ 104 'PageToken' => page_token, 105 'Page' => page_number, 106 'PageSize' => page_size, 107 }) 108 109 response = @version.page('GET', @uri, params: params) 110 111 FlowPage.new(@version, response, @solution) 112 end
Streams FlowInstance
records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @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
# File lib/twilio-ruby/rest/studio/v2/flow.rb 73 def stream(limit: nil, page_size: nil) 74 limits = @version.read_limits(limit, page_size) 75 76 page = self.page(page_size: limits[:page_size], ) 77 78 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 79 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/studio/v2/flow.rb 129 def to_s 130 '#<Twilio.Studio.V2.FlowList>' 131 end