Class: Twilio::REST::Studio::V2::FlowInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/studio/v2/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.



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 325

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'friendly_name' => payload['friendly_name'],
        'definition' => payload['definition'],
        'status' => payload['status'],
        'revision' => payload['revision'] == nil ? payload['revision'] : payload['revision'].to_i,
        'commit_message' => payload['commit_message'],
        'valid' => payload['valid'],
        'errors' => payload['errors'],
        'warnings' => payload['warnings'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'webhook_url' => payload['webhook_url'],
        '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:



371
372
373
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 371

def 
    @properties['account_sid']
end

#commit_message ⇒ String

Returns Description of change made in the revision.

Returns:

  • (String) —

    Description of change made in the revision.



401
402
403
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 401

def commit_message
    @properties['commit_message']
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:



356
357
358
359
360
361
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 356

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:



425
426
427
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 425

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:



431
432
433
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 431

def date_updated
    @properties['date_updated']
end

#definition ⇒ Hash

Returns JSON representation of flow definition.

Returns:

  • (Hash) —

    JSON representation of flow definition.



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

def definition
    @properties['definition']
end

#delete ⇒ Boolean

Delete the FlowInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



456
457
458
459
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 456

def delete

    context.delete
end

#errors ⇒ Array<Hash>

Returns List of error in the flow definition.

Returns:

  • (Array<Hash>) —

    List of error in the flow definition.



413
414
415
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 413

def errors
    @properties['errors']
end

#executions ⇒ executions

Access the executions

Returns:



494
495
496
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 494

def executions
    context.executions
end

#fetch ⇒ FlowInstance

Fetch the FlowInstance

Returns:



464
465
466
467
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 464

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.



377
378
379
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 377

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



521
522
523
524
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 521

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

#links ⇒ Hash

Returns The URLs of the Flow’s nested resources.

Returns:

  • (Hash) —

    The URLs of the Flow’s nested resources.



449
450
451
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 449

def links
    @properties['links']
end

#revision ⇒ String

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

Returns:

  • (String) —

    The latest revision number of the Flow’s definition.



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

def revision
    @properties['revision']
end

#revisions ⇒ revisions

Access the revisions

Returns:



508
509
510
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 508

def revisions
    context.revisions
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.



365
366
367
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 365

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#test_users ⇒ test_users

Access the test_users

Returns:



501
502
503
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 501

def test_users
    context.test_users
end

#to_s ⇒ Object

Provide a user friendly representation



514
515
516
517
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 514

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

#update(status: nil, friendly_name: :unset, definition: :unset, commit_message: :unset) ⇒ FlowInstance

Update the FlowInstance

Parameters:

  • status (Status) (defaults to: nil)
  • friendly_name (String) (defaults to: :unset) —

    The string that you assigned to describe the Flow.

  • definition (Object) (defaults to: :unset) —

    JSON representation of flow definition.

  • commit_message (String) (defaults to: :unset) —

    Description of change made in the revision.

Returns:



476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 476

def update(
    status: nil, 
    friendly_name: :unset, 
    definition: :unset, 
    commit_message: :unset
)

    context.update(
        status: status, 
        friendly_name: friendly_name, 
        definition: definition, 
        commit_message: commit_message, 
    )
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



443
444
445
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 443

def url
    @properties['url']
end

#valid ⇒ Boolean

Returns Boolean if the flow definition is valid.

Returns:

  • (Boolean) —

    Boolean if the flow definition is valid.



407
408
409
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 407

def valid
    @properties['valid']
end

#warnings ⇒ Array<Hash>

Returns List of warnings in the flow definition.

Returns:

  • (Array<Hash>) —

    List of warnings in the flow definition.



419
420
421
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 419

def warnings
    @properties['warnings']
end

#webhook_url ⇒ String

Returns:

  • (String) 


437
438
439
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 437

def webhook_url
    @properties['webhook_url']
end