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
Account Sid.
-
#context ⇒ FlowContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date this Flow was created.
-
#date_updated ⇒ Time
The date this Flow was updated.
-
#delete ⇒ Boolean
Deletes the FlowInstance.
-
#engagements ⇒ engagements
Access the engagements.
-
#executions ⇒ executions
Access the executions.
-
#fetch ⇒ FlowInstance
Fetch a FlowInstance.
-
#friendly_name ⇒ String
A human readable description of this resource.
-
#initialize(version, payload, sid: nil) ⇒ FlowInstance
constructor
Initialize the FlowInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#links ⇒ String
Nested resource URLs.
-
#sid ⇒ String
A string that uniquely identifies this Flow.
-
#status ⇒ flow.Status
The Status of this Flow.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#url ⇒ String
The URL of this resource.
-
#version ⇒ String
The latest version number of this Flow’s definition.
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_sid ⇒ String
282 283 284 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 282 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
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_created ⇒ Time
306 307 308 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 306 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
312 313 314 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 312 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Deletes the FlowInstance
338 339 340 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 338 def delete context.delete end |
#engagements ⇒ engagements
Access the engagements
345 346 347 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 345 def engagements context.engagements end |
#executions ⇒ executions
Access the executions
352 353 354 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 352 def executions context.executions end |
#fetch ⇒ FlowInstance
Fetch a FlowInstance
331 332 333 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 331 def fetch context.fetch end |
#friendly_name ⇒ String
288 289 290 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 288 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
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 |
#links ⇒ String
324 325 326 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 324 def links @properties['links'] end |
#sid ⇒ String
276 277 278 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 276 def sid @properties['sid'] end |
#status ⇒ flow.Status
294 295 296 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 294 def status @properties['status'] end |
#to_s ⇒ Object
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 |
#url ⇒ String
318 319 320 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 318 def url @properties['url'] end |
#version ⇒ String
300 301 302 |
# File 'lib/twilio-ruby/rest/studio/v1/flow.rb', line 300 def version @properties['version'] end |