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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the FlowInstance



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

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_sidString



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

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



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

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

#date_createdTime



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

def date_created
  @properties['date_created']
end

#date_updatedTime



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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Deletes the FlowInstance



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

def delete
  context.delete
end

#engagementsengagements

Access the engagements



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

def engagements
  context.engagements
end

#executionsexecutions

Access the executions



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

def executions
  context.executions
end

#fetchFlowInstance

Fetch a FlowInstance



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

def fetch
  context.fetch
end

#friendly_nameString



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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation



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

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


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

def links
  @properties['links']
end

#sidString



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

def sid
  @properties['sid']
end

#statusflow.Status



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

def status
  @properties['status']
end

#to_sObject

Provide a user friendly representation



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

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

#urlString



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

def url
  @properties['url']
end

#versionString



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

def version
  @properties['version']
end