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

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

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

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

    The unique SID identifier of the Flow.

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

    The unique SID identifier of the Engagement.

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

    The sid



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement/step.rb', line 213

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'],
      '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'],
  }

  # Context
  @instance_context = nil
  @params = {
      'flow_sid' => flow_sid,
      'engagement_sid' => engagement_sid,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns Account Sid.

Returns:

  • (String) —

    Account Sid.



264
265
266
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement/step.rb', line 264

def 
  @properties['account_sid']
end

#context ⇒ Hash

Returns Nested resource URLs.

Returns:

  • (Hash) —

    Nested resource URLs.



244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement/step.rb', line 244

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 this Step was created.

Returns:

  • (Time) —

    The date this Step was created



306
307
308
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement/step.rb', line 306

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Step was updated.

Returns:

  • (Time) —

    The date this Step was updated



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

def date_updated
  @properties['date_updated']
end

#engagement_sid ⇒ String

Returns Engagement Sid.

Returns:

  • (String) —

    Engagement Sid.



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

def engagement_sid
  @properties['engagement_sid']
end

#fetch ⇒ StepInstance

Fetch a StepInstance

Returns:



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

def fetch
  context.fetch
end

#flow_sid ⇒ String

Returns Flow Sid.

Returns:

  • (String) —

    Flow Sid.



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

def flow_sid
  @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



338
339
340
341
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement/step.rb', line 338

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

#name ⇒ String

Returns The Widget that implemented this Step.

Returns:

  • (String) —

    The Widget that implemented this Step.



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

def name
  @properties['name']
end

#sid ⇒ String

Returns A string that uniquely identifies this Step.

Returns:

  • (String) —

    A string that uniquely identifies this Step.



258
259
260
 
# File 'lib/twilio-ruby/rest/preview/studio/flow/engagement/step.rb', line 258

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#transitioned_from ⇒ String

Returns The Widget that preceded the Widget for this Step.

Returns:

  • (String) —

    The Widget that preceded the Widget for this Step.



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

def transitioned_from
  @properties['transitioned_from']
end

#transitioned_to ⇒ String

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

Returns:

  • (String) —

    The Widget that will follow the Widget for this Step.



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

def transitioned_to
  @properties['transitioned_to']
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



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

def url
  @properties['url']
end