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.



324
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
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 324

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_sidString

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Flow resource.

Returns:



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

def 
    @properties['account_sid']
end

#commit_messageString

Returns Description of change made in the revision.

Returns:

  • (String)

    Description of change made in the revision.



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

def commit_message
    @properties['commit_message']
end

#contextFlowContext

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

Returns:



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

def context
    unless @instance_context
        @instance_context = FlowContext.new(@version , @params['sid'])
    end
    @instance_context
end

#date_createdTime

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updatedTime

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:



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

def date_updated
    @properties['date_updated']
end

#definitionHash

Returns JSON representation of flow definition.

Returns:

  • (Hash)

    JSON representation of flow definition.



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

def definition
    @properties['definition']
end

#deleteBoolean

Delete the FlowInstance

Returns:

  • (Boolean)

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#errorsArray<Hash>

Returns List of error in the flow definition.

Returns:

  • (Array<Hash>)

    List of error in the flow definition.



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

def errors
    @properties['errors']
end

#executionsexecutions

Access the executions

Returns:



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

def executions
    context.executions
end

#fetchFlowInstance

Fetch the FlowInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_nameString

Returns The string that you assigned to describe the Flow.

Returns:

  • (String)

    The string that you assigned to describe the Flow.



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

def friendly_name
    @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation



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

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

Returns The URLs of the Flow’s nested resources.

Returns:

  • (Hash)

    The URLs of the Flow’s nested resources.



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

def links
    @properties['links']
end

#revisionString

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

Returns:

  • (String)

    The latest revision number of the Flow’s definition.



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

def revision
    @properties['revision']
end

#revisionsrevisions

Access the revisions

Returns:



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

def revisions
    context.revisions
end

#sidString

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.



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

def sid
    @properties['sid']
end

#statusStatus

Returns:

  • (Status)


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

def status
    @properties['status']
end

#test_userstest_users

Access the test_users

Returns:



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

def test_users
    context.test_users
end

#to_sObject

Provide a user friendly representation



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

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:



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

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

#urlString

Returns The absolute URL of the resource.

Returns:

  • (String)

    The absolute URL of the resource.



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

def url
    @properties['url']
end

#validBoolean

Returns Boolean if the flow definition is valid.

Returns:

  • (Boolean)

    Boolean if the flow definition is valid.



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

def valid
    @properties['valid']
end

#warningsArray<Hash>

Returns List of warnings in the flow definition.

Returns:

  • (Array<Hash>)

    List of warnings in the flow definition.



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

def warnings
    @properties['warnings']
end

#webhook_urlString

Returns:

  • (String)


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

def webhook_url
    @properties['webhook_url']
end