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

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

Defined Under Namespace

Classes: ExecutionContextContext, ExecutionContextInstance, ExecutionContextList, ExecutionContextPage, ExecutionStepContext, ExecutionStepInstance, ExecutionStepList, ExecutionStepPage

Instance Method Summary collapse

Constructor Details

#initialize(version, flow_sid, sid) ⇒ ExecutionContext

Initialize the ExecutionContext

Parameters:

  • version (Version)

    Version that contains the resource

  • flow_sid (String)

    The SID of the Flow with the Execution resource to fetch

  • sid (String)

    The SID of the Execution resource to fetch.


207
208
209
210
211
212
213
214
215
216
217
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 207

def initialize(version, flow_sid, sid)
  super(version)

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

  # Dependents
  @steps = nil
  @execution_context = nil
end

Instance Method Details

#deleteBoolean

Delete the ExecutionInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


231
232
233
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 231

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

#execution_contextExecutionContextList, ExecutionContextContext

Access the execution_context


274
275
276
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 274

def execution_context
  ExecutionContextContext.new(@version, @solution[:flow_sid], @solution[:sid], )
end

#fetchExecutionInstance

Fetch the ExecutionInstance

Returns:


222
223
224
225
226
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 222

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

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

#inspectObject

Provide a detailed, user friendly representation


287
288
289
290
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 287

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

#steps(sid = :unset) ⇒ ExecutionStepList, ExecutionStepContext

Access the steps

Returns:

Raises:

  • (ArgumentError)

252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 252

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

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

  unless @steps
    @steps = ExecutionStepList.new(
        @version,
        flow_sid: @solution[:flow_sid],
        execution_sid: @solution[:sid],
    )
  end

  @steps
end

#to_sObject

Provide a user friendly representation


280
281
282
283
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 280

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

#update(status: nil) ⇒ ExecutionInstance

Update the ExecutionInstance

Parameters:

  • status (execution.Status) (defaults to: nil)

    The status of the Execution. Can only be `ended`.

Returns:


240
241
242
243
244
245
246
# File 'lib/twilio-ruby/rest/studio/v2/flow/execution.rb', line 240

def update(status: nil)
  data = Twilio::Values.of({'Status' => status, })

  payload = @version.update('POST', @uri, data: data)

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