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
 
# 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'],
        '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:



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

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.



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

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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#engagement_sid ⇒ String

Returns The SID of the Engagement.

Returns:

  • (String) —

    The SID of the Engagement.



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

def engagement_sid
    @properties['engagement_sid']
end

#fetch ⇒ StepInstance

Fetch the StepInstance

Returns:



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

def fetch

    context.fetch
end

#flow_sid ⇒ String

Returns The SID of the Flow.

Returns:

  • (String) —

    The SID of the Flow.



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

def flow_sid
    @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

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.



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

def name
    @properties['name']
end

#parent_step_sid ⇒ String

Returns The SID of the parent Step.

Returns:

  • (String) —

    The SID of the parent Step.



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

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.



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

def sid
    @properties['sid']
end

#step_context ⇒ step_context

Access the step_context

Returns:



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

def step_context
    context.step_context
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

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.



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

def transitioned_to
    @properties['transitioned_to']
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



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

def url
    @properties['url']
end