Class: Twilio::REST::Studio::V1::FlowContext::ExecutionContext::ExecutionStepInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Studio::V1::FlowContext::ExecutionContext::ExecutionStepInstance
- Defined in:
- lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the ExecutionStep resource.
-
#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.
-
#execution_sid ⇒ String
The SID of the Step’s Execution resource.
-
#fetch ⇒ ExecutionStepInstance
Fetch the ExecutionStepInstance.
-
#flow_sid ⇒ String
The SID of the Flow.
-
#initialize(version, payload, flow_sid: nil, execution_sid: nil, sid: nil) ⇒ ExecutionStepInstance
constructor
Initialize the ExecutionStepInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#links ⇒ Hash
The URLs of related resources.
-
#name ⇒ String
The event that caused the Flow to transition to the Step.
-
#sid ⇒ String
The unique string that we created to identify the ExecutionStep resource.
-
#step_context ⇒ step_context
Access the step_context.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#transitioned_from ⇒ String
The Widget that preceded the Widget for the Step.
-
#transitioned_to ⇒ String
The Widget that will follow the Widget for the Step.
-
#url ⇒ String
The absolute URL of the resource.
Constructor Details
#initialize(version, payload, flow_sid: nil, execution_sid: nil, sid: nil) ⇒ ExecutionStepInstance
Initialize the ExecutionStepInstance
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 228 def initialize(version, payload , flow_sid: nil, execution_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'account_sid' => payload['account_sid'], 'flow_sid' => payload['flow_sid'], 'execution_sid' => payload['execution_sid'], 'name' => payload['name'], 'context' => payload['context'], 'transitioned_from' => payload['transitioned_from'], 'transitioned_to' => payload['transitioned_to'], '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'] ,'execution_sid' => execution_sid || @properties['execution_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 ExecutionStep resource.
271 272 273 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 271 def account_sid @properties['account_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.
256 257 258 259 260 261 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 256 def context unless @instance_context @instance_context = ExecutionStepContext.new(@version , @params['flow_sid'], @params['execution_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.
313 314 315 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 313 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.
319 320 321 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 319 def date_updated @properties['date_updated'] end |
#execution_sid ⇒ String
Returns The SID of the Step’s Execution resource.
283 284 285 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 283 def execution_sid @properties['execution_sid'] end |
#fetch ⇒ ExecutionStepInstance
Fetch the ExecutionStepInstance
338 339 340 341 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 338 def fetch context.fetch end |
#flow_sid ⇒ String
Returns The SID of the Flow.
277 278 279 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 277 def flow_sid @properties['flow_sid'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
359 360 361 362 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 359 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Studio.V1.ExecutionStepInstance #{values}>" end |
#links ⇒ Hash
Returns The URLs of related resources.
331 332 333 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 331 def links @properties['links'] end |
#name ⇒ String
Returns The event that caused the Flow to transition to the Step.
289 290 291 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 289 def name @properties['name'] end |
#sid ⇒ String
Returns The unique string that we created to identify the ExecutionStep resource.
265 266 267 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 265 def sid @properties['sid'] end |
#step_context ⇒ step_context
Access the step_context
346 347 348 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 346 def step_context context.step_context end |
#to_s ⇒ Object
Provide a user friendly representation
352 353 354 355 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 352 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Studio.V1.ExecutionStepInstance #{values}>" end |
#transitioned_from ⇒ String
Returns The Widget that preceded the Widget for the Step.
301 302 303 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 301 def transitioned_from @properties['transitioned_from'] end |
#transitioned_to ⇒ String
Returns The Widget that will follow the Widget for the Step.
307 308 309 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 307 def transitioned_to @properties['transitioned_to'] end |
#url ⇒ String
Returns The absolute URL of the resource.
325 326 327 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step.rb', line 325 def url @properties['url'] end |