Class: Twilio::REST::Studio::V2::FlowContext::ExecutionContext::ExecutionStepList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, flow_sid: nil, execution_sid: nil) ⇒ ExecutionStepList

Initialize the ExecutionStepList



22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 22

def initialize(version, flow_sid: nil, execution_sid: nil)
  super(version)

  # Path Solution
  @solution = {flow_sid: flow_sid, execution_sid: execution_sid}
  @uri = "/Flows/#{@solution[:flow_sid]}/Executions/#{@solution[:execution_sid]}/Steps"
end

Instance Method Details

#each ⇒ Object

When passed a block, yields ExecutionStepInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



68
69
70
71
72
73
74
75
76
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 68

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

#get_page(target_url) ⇒ Page

Retrieve a single page of ExecutionStepInstance records from the API. Request is executed immediately.



102
103
104
105
106
107
108
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 102

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  ExecutionStepPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists ExecutionStepInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.



41
42
43
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 41

def list(limit: nil, page_size: nil)
  self.stream(limit: limit, page_size: page_size).entries
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of ExecutionStepInstance records from the API. Request is executed immediately.



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 85

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  ExecutionStepPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams ExecutionStepInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



56
57
58
59
60
61
62
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 56

def stream(limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



112
113
114
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution/execution_step.rb', line 112

def to_s
  '#<Twilio.Studio.V2.ExecutionStepList>'
end