Class: Twilio::REST::Studio::V2::FlowContext::FlowRevisionInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/studio/v2/flow/flow_revision.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil, revision: nil) ⇒ FlowRevisionInstance

Initialize the FlowRevisionInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this FlowRevision resource.

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

    The SID of the Call resource to fetch.



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/flow_revision.rb', line 215

def initialize(version, payload , sid: nil, revision: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'friendly_name' => payload['friendly_name'],
        'definition' => payload['definition'],
        'status' => payload['status'],
        'revision' => payload['revision'] == nil ? payload['revision'] : payload['revision'].to_i,
        'commit_message' => payload['commit_message'],
        'valid' => payload['valid'],
        'errors' => payload['errors'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'sid' => sid  || @properties['sid']  ,'revision' => revision  || @properties['revision']  , }
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.

Returns:



258
259
260
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/flow_revision.rb', line 258

def 
    @properties['account_sid']
end

#commit_message ⇒ String

Returns Description of change made in the revision.

Returns:

  • (String) —

    Description of change made in the revision.



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

def commit_message
    @properties['commit_message']
end

#context ⇒ FlowRevisionContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



243
244
245
246
247
248
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/flow_revision.rb', line 243

def context
    unless @instance_context
        @instance_context = FlowRevisionContext.new(@version , @params['sid'], @params['revision'])
    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.

Returns:



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

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.

Returns:



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

def date_updated
    @properties['date_updated']
end

#definition ⇒ Hash

Returns JSON representation of flow definition.

Returns:

  • (Hash) —

    JSON representation of flow definition.



270
271
272
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/flow_revision.rb', line 270

def definition
    @properties['definition']
end

#errors ⇒ Array<Hash>

Returns List of error in the flow definition.

Returns:

  • (Array<Hash>) —

    List of error in the flow definition.



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

def errors
    @properties['errors']
end

#fetch ⇒ FlowRevisionInstance

Fetch the FlowRevisionInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the Flow.

Returns:

  • (String) —

    The string that you assigned to describe the Flow.



264
265
266
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/flow_revision.rb', line 264

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#revision ⇒ String

Returns The latest revision number of the Flow’s definition.

Returns:

  • (String) —

    The latest revision number of the Flow’s definition.



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

def revision
    @properties['revision']
end

#sid ⇒ String

Returns The unique string that we created to identify the Flow resource.

Returns:

  • (String) —

    The unique string that we created to identify the Flow resource.



252
253
254
 
# File 'lib/twilio-ruby/rest/studio/v2/flow/flow_revision.rb', line 252

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



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

def url
    @properties['url']
end

#valid ⇒ Boolean

Returns Boolean if the flow definition is valid.

Returns:

  • (Boolean) —

    Boolean if the flow definition is valid.



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

def valid
    @properties['valid']
end