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



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 



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

def 
    @properties['account_sid']
end

#commit_message ⇒ String 



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



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 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#definition ⇒ Hash 



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

def definition
    @properties['definition']
end

#delete ⇒ Boolean

Delete the FlowInstance



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

def delete

    context.delete
end

#errors ⇒ Array<Hash> 



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

def errors
    @properties['errors']
end

#executions ⇒ executions

Access the executions



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

def executions
    context.executions
end

#fetch ⇒ FlowInstance

Fetch the FlowInstance



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

def fetch

    context.fetch
end

#friendly_name ⇒ String 



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 



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

def links
    @properties['links']
end

#revision ⇒ String 



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

def revision
    @properties['revision']
end

#revisions ⇒ revisions

Access the revisions



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

def revisions
    context.revisions
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#status ⇒ 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



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



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 



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

def url
    @properties['url']
end

#valid ⇒ Boolean 



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

def valid
    @properties['valid']
end

#warnings ⇒ Array<Hash> 



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

def warnings
    @properties['warnings']
end

#webhook_url ⇒ String 



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

def webhook_url
    @properties['webhook_url']
end