Class: Twilio::REST::Studio::V1::FlowInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Studio::V1::FlowInstance
- Defined in:
- lib/twilio-ruby/rest/studio/v1/flow.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Flow resource.
-
#context ⇒ FlowContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#delete ⇒ Boolean
Delete the FlowInstance.
-
#engagements ⇒ engagements
Access the engagements.
-
#executions ⇒ executions
Access the executions.
-
#fetch ⇒ FlowInstance
Fetch the FlowInstance.
-
#friendly_name ⇒ String
The string that you assigned to describe the Flow.
-
#initialize(version, payload, sid: nil) ⇒ FlowInstance
constructor
Initialize the FlowInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#links ⇒ Hash
The URLs of the Flow’s nested resources.
-
#sid ⇒ String
The unique string that we created to identify the Flow resource.
- #status ⇒ Status
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#url ⇒ String
The absolute URL of the resource.
-
#version ⇒ String
The latest version number of the Flow’s definition.
Constructor Details
#initialize(version, payload, sid: nil) ⇒ FlowInstance
Initialize the FlowInstance
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 257 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'] == nil ? payload['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 The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Flow resource.
297 298 299 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 297 def account_sid @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
282 283 284 285 286 287 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 282 def context unless @instance_context @instance_context = FlowContext.new(@version , @params['sid']) end @instance_context end |
#date_created ⇒ Time
Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
321 322 323 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 321 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
327 328 329 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 327 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the FlowInstance
346 347 348 349 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 346 def delete context.delete end |
#engagements ⇒ engagements
Access the engagements
369 370 371 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 369 def engagements context.engagements end |
#executions ⇒ executions
Access the executions
362 363 364 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 362 def executions context.executions end |
#fetch ⇒ FlowInstance
Fetch the FlowInstance
354 355 356 357 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 354 def fetch context.fetch end |
#friendly_name ⇒ String
Returns The string that you assigned to describe the Flow.
303 304 305 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 303 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
382 383 384 385 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 382 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Studio.V1.FlowInstance #{values}>" end |
#links ⇒ Hash
Returns The URLs of the Flow’s nested resources.
339 340 341 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 339 def links @properties['links'] end |
#sid ⇒ String
Returns The unique string that we created to identify the Flow resource.
291 292 293 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 291 def sid @properties['sid'] end |
#status ⇒ Status
309 310 311 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 309 def status @properties['status'] end |
#to_s ⇒ Object
Provide a user friendly representation
375 376 377 378 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 375 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Studio.V1.FlowInstance #{values}>" end |
#url ⇒ String
Returns The absolute URL of the resource.
333 334 335 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 333 def url @properties['url'] end |
#version ⇒ String
Returns The latest version number of the Flow’s definition.
315 316 317 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 315 def version @properties['version'] end |