Class: Twilio::REST::Studio::V1::FlowContext::ExecutionInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Studio::V1::FlowContext::ExecutionInstance
- Defined in:
- lib/twilio-ruby/rest/studio/v1/flow/execution.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Execution resource.
-
#contact_channel_address ⇒ String
The phone number, SIP address or Client identifier that triggered the Execution.
-
#contact_sid ⇒ String
The SID of the Contact.
-
#context ⇒ Hash
The current state of the Flow’s Execution.
-
#date_created ⇒ Time
The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#delete ⇒ Boolean
Delete the ExecutionInstance.
-
#execution_context ⇒ execution_context
Access the execution_context.
-
#fetch ⇒ ExecutionInstance
Fetch the ExecutionInstance.
-
#flow_sid ⇒ String
The SID of the Flow.
-
#initialize(version, payload, flow_sid: nil, sid: nil) ⇒ ExecutionInstance
constructor
Initialize the ExecutionInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#links ⇒ Hash
The URLs of nested resources.
-
#sid ⇒ String
The unique string that we created to identify the Execution resource.
- #status ⇒ Status
-
#steps ⇒ steps
Access the steps.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(status: nil) ⇒ ExecutionInstance
Update the ExecutionInstance.
-
#url ⇒ String
The absolute URL of the resource.
Constructor Details
#initialize(version, payload, flow_sid: nil, sid: nil) ⇒ ExecutionInstance
Initialize the ExecutionInstance
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 314 def initialize(version, payload , flow_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'account_sid' => payload['account_sid'], 'flow_sid' => payload['flow_sid'], 'contact_sid' => payload['contact_sid'], 'contact_channel_address' => payload['contact_channel_address'], 'context' => payload['context'], 'status' => payload['status'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'url' => payload['url'], 'links' => payload['links'], } # Context @instance_context = nil @params = { 'flow_sid' => flow_sid || @properties['flow_sid'] ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Execution resource.
356 357 358 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 356 def account_sid @properties['account_sid'] end |
#contact_channel_address ⇒ String
Returns The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as ‘[email protected]`. Client identifiers are formatted `client:name`.
374 375 376 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 374 def contact_channel_address @properties['contact_channel_address'] end |
#contact_sid ⇒ String
Returns The SID of the Contact.
368 369 370 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 368 def contact_sid @properties['contact_sid'] end |
#context ⇒ Hash
Returns The current state of the Flow’s Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.
341 342 343 344 345 346 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 341 def context unless @instance_context @instance_context = ExecutionContext.new(@version , @params['flow_sid'], @params['sid']) end @instance_context end |
#date_created ⇒ Time
Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
392 393 394 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 392 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
398 399 400 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 398 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the ExecutionInstance
417 418 419 420 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 417 def delete context.delete end |
#execution_context ⇒ execution_context
Access the execution_context
446 447 448 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 446 def execution_context context.execution_context end |
#fetch ⇒ ExecutionInstance
Fetch the ExecutionInstance
425 426 427 428 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 425 def fetch context.fetch end |
#flow_sid ⇒ String
Returns The SID of the Flow.
362 363 364 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 362 def flow_sid @properties['flow_sid'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
466 467 468 469 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 466 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Studio.V1.ExecutionInstance #{values}>" end |
#links ⇒ Hash
Returns The URLs of nested resources.
410 411 412 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 410 def links @properties['links'] end |
#sid ⇒ String
Returns The unique string that we created to identify the Execution resource.
350 351 352 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 350 def sid @properties['sid'] end |
#status ⇒ Status
386 387 388 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 386 def status @properties['status'] end |
#steps ⇒ steps
Access the steps
453 454 455 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 453 def steps context.steps end |
#to_s ⇒ Object
Provide a user friendly representation
459 460 461 462 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 459 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Studio.V1.ExecutionInstance #{values}>" end |
#update(status: nil) ⇒ ExecutionInstance
Update the ExecutionInstance
434 435 436 437 438 439 440 441 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 434 def update( status: nil ) context.update( status: status, ) end |
#url ⇒ String
Returns The absolute URL of the resource.
404 405 406 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution.rb', line 404 def url @properties['url'] end |