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.



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

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:



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

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.



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

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:



360
361
362
363
364
365
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 360

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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#definition ⇒ Hash

Returns JSON representation of flow definition.

Returns:

  • (Hash) —

    JSON representation of flow definition.



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

def definition
    @properties['definition']
end

#delete ⇒ Boolean

Delete the FlowInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



460
461
462
463
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 460

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.



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

def errors
    @properties['errors']
end

#executions ⇒ executions

Access the executions

Returns:



498
499
500
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 498

def executions
    context.executions
end

#fetch ⇒ FlowInstance

Fetch the FlowInstance

Returns:



468
469
470
471
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 468

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.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



525
526
527
528
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 525

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.



453
454
455
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 453

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.



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

def revision
    @properties['revision']
end

#revisions ⇒ revisions

Access the revisions

Returns:



512
513
514
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 512

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.



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

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#test_users ⇒ test_users

Access the test_users

Returns:



505
506
507
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 505

def test_users
    context.test_users
end

#to_s ⇒ Object

Provide a user friendly representation



518
519
520
521
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 518

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:



480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 480

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.



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

def url
    @properties['url']
end

#valid ⇒ Boolean

Returns Boolean if the flow definition is valid.

Returns:

  • (Boolean) —

    Boolean if the flow definition is valid.



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

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.



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

def warnings
    @properties['warnings']
end

#webhook_url ⇒ String

Returns:

  • (String) 


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

def webhook_url
    @properties['webhook_url']
end