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

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • sid (String) (defaults to: nil)

    The SID of the Flow resource to fetch.


234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 234

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

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

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

Returns:


259
260
261
262
263
264
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 259

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

#date_createdTime

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the resource was created


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

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time)

    The ISO 8601 date and time in GMT when the resource was last updated


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the FlowInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#engagementsengagements

Access the engagements

Returns:


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

def engagements
  context.engagements
end

#executionsexecutions

Access the executions

Returns:


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

def executions
  context.executions
end

#fetchFlowInstance

Fetch the FlowInstance

Returns:


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

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


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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

Returns Nested resource URLs.

Returns:

  • (String)

    Nested resource URLs


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

def links
  @properties['links']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#statusflow.Status

Returns The status of the Flow.

Returns:

  • (flow.Status)

    The status of the Flow


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

def status
  @properties['status']
end

#to_sObject

Provide a user friendly representation


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

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

#urlString

Returns The absolute URL of the resource.

Returns:

  • (String)

    The absolute URL of the resource


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

def url
  @properties['url']
end

#versionString

Returns The latest version number of the Flow's definition.

Returns:

  • (String)

    The latest version number of the Flow's definition


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

def version
  @properties['version']
end