Class: Twilio::REST::Studio::V1::FlowContext::EngagementContext::StepInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, flow_sid: nil, engagement_sid: nil, sid: nil) ⇒ StepInstance

Initialize the StepInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Step resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 238

def initialize(version, payload , flow_sid: nil, engagement_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'flow_sid' => payload['flow_sid'],
        'engagement_sid' => payload['engagement_sid'],
        'name' => payload['name'],
        'context' => payload['context'],
        'parent_step_sid' => payload['parent_step_sid'],
        'transitioned_from' => payload['transitioned_from'],
        'transitioned_to' => payload['transitioned_to'],
        'type' => payload['type'],
        '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']  ,'engagement_sid' => engagement_sid  || @properties['engagement_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 Step resource.

Returns:



283
284
285
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 283

def 
    @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.

Returns:

  • (Hash) —

    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.



268
269
270
271
272
273
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 268

def context
    unless @instance_context
        @instance_context = StepContext.new(@version , @params['flow_sid'], @params['engagement_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.

Returns:



337
338
339
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 337

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.

Returns:



343
344
345
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 343

def date_updated
    @properties['date_updated']
end

#engagement_sid ⇒ String

Returns The SID of the Engagement.

Returns:

  • (String) —

    The SID of the Engagement.



295
296
297
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 295

def engagement_sid
    @properties['engagement_sid']
end

#fetch ⇒ StepInstance

Fetch the StepInstance

Returns:



362
363
364
365
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 362

def fetch

    context.fetch
end

#flow_sid ⇒ String

Returns The SID of the Flow.

Returns:

  • (String) —

    The SID of the Flow.



289
290
291
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 289

def flow_sid
    @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



383
384
385
386
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 383

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Studio.V1.StepInstance #{values}>"
end

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



355
356
357
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 355

def links
    @properties['links']
end

#name ⇒ String

Returns The event that caused the Flow to transition to the Step.

Returns:

  • (String) —

    The event that caused the Flow to transition to the Step.



301
302
303
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 301

def name
    @properties['name']
end

#parent_step_sid ⇒ String

Returns The SID of the parent Step.

Returns:

  • (String) —

    The SID of the parent Step.



313
314
315
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 313

def parent_step_sid
    @properties['parent_step_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Step resource.

Returns:

  • (String) —

    The unique string that we created to identify the Step resource.



277
278
279
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 277

def sid
    @properties['sid']
end

#step_context ⇒ step_context

Access the step_context

Returns:



370
371
372
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 370

def step_context
    context.step_context
end

#to_s ⇒ Object

Provide a user friendly representation



376
377
378
379
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 376

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Studio.V1.StepInstance #{values}>"
end

#transitioned_from ⇒ String

Returns The Widget that preceded the Widget for the Step.

Returns:

  • (String) —

    The Widget that preceded the Widget for the Step.



319
320
321
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 319

def transitioned_from
    @properties['transitioned_from']
end

#transitioned_to ⇒ String

Returns The Widget that will follow the Widget for the Step.

Returns:

  • (String) —

    The Widget that will follow the Widget for the Step.



325
326
327
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 325

def transitioned_to
    @properties['transitioned_to']
end

#type ⇒ String

Returns The type of the widget that was executed.

Returns:

  • (String) —

    The type of the widget that was executed.



331
332
333
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 331

def type
    @properties['type']
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



349
350
351
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 349

def url
    @properties['url']
end