Class: Twilio::REST::Studio::V1::FlowInstance

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

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • sid (String) (defaults to: nil) —

    A 34 character string that uniquely identifies this Flow.



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 243

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'friendly_name' => payload['friendly_name'],
      'status' => payload['status'],
      'version' => payload['version'].to_i,
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
      'links' => payload['links'],
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns Account Sid.

Returns:

  • (String) —

    Account Sid.



283
284
285
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 283

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



268
269
270
271
272
273
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 268

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

#date_created ⇒ Time

Returns The date this Flow was created.

Returns:

  • (Time) —

    The date this Flow was created



307
308
309
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 307

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Flow was updated.

Returns:

  • (Time) —

    The date this Flow was updated



313
314
315
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 313

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the FlowInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



339
340
341
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 339

def delete
  context.delete
end

#engagements ⇒ engagements

Access the engagements

Returns:



346
347
348
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 346

def engagements
  context.engagements
end

#executions ⇒ executions

Access the executions

Returns:



353
354
355
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 353

def executions
  context.executions
end

#fetch ⇒ FlowInstance

Fetch a FlowInstance

Returns:



332
333
334
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 332

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A human readable description of this resource.

Returns:

  • (String) —

    A human readable description of this resource.



289
290
291
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 289

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



366
367
368
369
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 366

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

#links ⇒ String

Returns Nested resource URLs.

Returns:

  • (String) —

    Nested resource URLs.



325
326
327
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 325

def links
  @properties['links']
end

#sid ⇒ String

Returns A string that uniquely identifies this Flow.

Returns:

  • (String) —

    A string that uniquely identifies this Flow.



277
278
279
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 277

def sid
  @properties['sid']
end

#status ⇒ flow.Status

Returns The Status of this Flow.

Returns:

  • (flow.Status) —

    The Status of this Flow



295
296
297
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 295

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



359
360
361
362
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 359

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

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



319
320
321
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 319

def url
  @properties['url']
end

#version ⇒ String

Returns The latest version number of this Flow’s definition.

Returns:

  • (String) —

    The latest version number of this Flow’s definition.



301
302
303
 
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 301

def version
  @properties['version']
end