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

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/studio/v2/flow.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ FlowInstance

Initialize the FlowInstance



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 310

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'].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 



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

def 
  @properties['account_sid']
end

#commit_message ⇒ String 



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

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



341
342
343
344
345
346
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 341

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

#date_created ⇒ Time 



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#definition ⇒ Hash 



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

def definition
  @properties['definition']
end

#delete ⇒ Boolean

Deletes the FlowInstance



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

def delete
  context.delete
end

#errors ⇒ Hash 



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

def errors
  @properties['errors']
end

#executions ⇒ executions

Access the executions



486
487
488
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 486

def executions
  context.executions
end

#fetch ⇒ FlowInstance

Fetch a FlowInstance



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

def fetch
  context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String 



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

def links
  @properties['links']
end

#revision ⇒ String 



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

def revision
  @properties['revision']
end

#revisions ⇒ revisions

Access the revisions



472
473
474
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 472

def revisions
  context.revisions
end

#sid ⇒ String 



350
351
352
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 350

def sid
  @properties['sid']
end

#status ⇒ flow.Status 



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

def status
  @properties['status']
end

#test_users ⇒ test_users

Access the test_users



479
480
481
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 479

def test_users
  context.test_users
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



446
447
448
449
450
451
452
453
 
# File 'lib/twilio-ruby/rest/studio/v2/flow.rb', line 446

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 



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

def url
  @properties['url']
end

#valid ⇒ Boolean 



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

def valid
  @properties['valid']
end

#warnings ⇒ Hash 



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

def warnings
  @properties['warnings']
end

#webhook_url ⇒ String 



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

def webhook_url
  @properties['webhook_url']
end