Class: Twilio::REST::Studio::V1::FlowContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/studio/v1/flow.rb,
lib/twilio-ruby/rest/studio/v1/flow/execution.rb,
lib/twilio-ruby/rest/studio/v1/flow/engagement.rb,
lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb,
lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb,
lib/twilio-ruby/rest/studio/v1/flow/execution/execution_context.rb,
lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb,
lib/twilio-ruby/rest/studio/v1/flow/engagement/engagement_context.rb,
lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb

Defined Under Namespace

Classes: EngagementContext, EngagementInstance, EngagementList, EngagementPage, ExecutionContext, ExecutionInstance, ExecutionList, ExecutionPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ FlowContext

Initialize the FlowContext

Parameters:

  • version (Version)

    Version that contains the resource

  • sid (String)

    The SID of the Flow resource to fetch.


148
149
150
151
152
153
154
155
156
157
158
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 148

def initialize(version, sid)
  super(version)

  # Path Solution
  @solution = {sid: sid, }
  @uri = "/Flows/#{@solution[:sid]}"

  # Dependents
  @engagements = nil
  @executions = nil
end

Instance Method Details

#deleteBoolean

Delete the FlowInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


172
173
174
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 172

def delete
   @version.delete('DELETE', @uri)
end

#engagements(sid = :unset) ⇒ EngagementList, EngagementContext

Access the engagements

Returns:

Raises:

  • (ArgumentError)

180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 180

def engagements(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return EngagementContext.new(@version, @solution[:sid], sid, )
  end

  unless @engagements
    @engagements = EngagementList.new(@version, flow_sid: @solution[:sid], )
  end

  @engagements
end

#executions(sid = :unset) ⇒ ExecutionList, ExecutionContext

Access the executions

Returns:

Raises:

  • (ArgumentError)

198
199
200
201
202
203
204
205
206
207
208
209
210
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 198

def executions(sid=:unset)
  raise ArgumentError, 'sid cannot be nil' if sid.nil?

  if sid != :unset
    return ExecutionContext.new(@version, @solution[:sid], sid, )
  end

  unless @executions
    @executions = ExecutionList.new(@version, flow_sid: @solution[:sid], )
  end

  @executions
end

#fetchFlowInstance

Fetch the FlowInstance

Returns:


163
164
165
166
167
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 163

def fetch
  payload = @version.fetch('GET', @uri)

  FlowInstance.new(@version, payload, sid: @solution[:sid], )
end

#inspectObject

Provide a detailed, user friendly representation


221
222
223
224
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 221

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Studio.V1.FlowContext #{context}>"
end

#to_sObject

Provide a user friendly representation


214
215
216
217
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 214

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Studio.V1.FlowContext #{context}>"
end