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.



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 270

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:



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

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:



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

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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the FlowInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#engagements ⇒ engagements

Access the engagements

Returns:



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

def engagements
    context.engagements
end

#executions ⇒ executions

Access the executions

Returns:



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

def executions
    context.executions
end

#fetch ⇒ FlowInstance

Fetch the FlowInstance

Returns:



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

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.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



395
396
397
398
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 395

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.



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

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.



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

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



388
389
390
391
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 388

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.



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

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.



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

def version
    @properties['version']
end