Class: Twilio::REST::Studio::V1::FlowInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ FlowInstance

Initialize the FlowInstance

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 Flow resource.

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

    The SID of the Call resource to fetch.



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 256

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'friendly_name' => payload['friendly_name'],
        'status' => payload['status'],
        'version' => payload['version'] == nil ? payload['version'] : payload['version'].to_i,
        '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 = { '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 Flow resource.

Returns:



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

def 
    @properties['account_sid']
end

#context ⇒ FlowContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



281
282
283
284
285
286
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 281

def context
    unless @instance_context
        @instance_context = FlowContext.new(@version , @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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the FlowInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



345
346
347
348
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 345

def delete

    context.delete
end

#engagements ⇒ engagements

Access the engagements

Returns:



368
369
370
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 368

def engagements
    context.engagements
end

#executions ⇒ executions

Access the executions

Returns:



361
362
363
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 361

def executions
    context.executions
end

#fetch ⇒ FlowInstance

Fetch the FlowInstance

Returns:



353
354
355
356
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 353

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the Flow.

Returns:

  • (String) —

    The string that you assigned to describe the Flow.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



381
382
383
384
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 381

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

#links ⇒ Hash

Returns The URLs of the Flow’s nested resources.

Returns:

  • (Hash) —

    The URLs of the Flow’s nested resources.



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

def links
    @properties['links']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



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

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


308
309
310
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 308

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



374
375
376
377
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 374

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

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



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

def url
    @properties['url']
end

#version ⇒ String

Returns The latest version number of the Flow’s definition.

Returns:

  • (String) —

    The latest version number of the Flow’s definition.



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

def version
    @properties['version']
end