Class: Twilio::REST::Iam::V1::OAuthAppInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/iam/v1/o_auth_app.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the OAuthAppInstance

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 OAuthApp resource.

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

    The SID of the Call resource to fetch.



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 311

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'type' => payload['type'],
        'sid' => payload['sid'],
        'friendly_name' => payload['friendly_name'],
        'description' => payload['description'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'created_by' => payload['created_by'],
        'secret' => payload['secret'],
        'status' => payload['status'],
        'policy' => payload['policy'],
        'access_token_ttl' => payload['access_token_ttl'] == nil ? payload['access_token_ttl'] : payload['access_token_ttl'].to_i,
        'code' => payload['code'],
        'message' => payload['message'],
        'more_info' => payload['more_info'],
    }

    # Context
    @instance_context = nil
    @params = { 'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#access_token_ttl ⇒ String

Returns:

  • (String) 


403
404
405
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 403

def access_token_ttl
    @properties['access_token_ttl']
end

#code ⇒ String

Returns Twilio-specific error code.

Returns:

  • (String) —

    Twilio-specific error code



409
410
411
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 409

def code
    @properties['code']
end

#context ⇒ OAuthAppContext

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

Returns:



340
341
342
343
344
345
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 340

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

#created_by ⇒ String

Returns:

  • (String) 


379
380
381
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 379

def created_by
    @properties['created_by']
end

#date_created ⇒ Time

Returns:

  • (Time) 


373
374
375
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 373

def date_created
    @properties['date_created']
end

#delete ⇒ Boolean

Delete the OAuthAppInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



428
429
430
431
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 428

def delete

    context.delete
end

#description ⇒ String

Returns:

  • (String) 


367
368
369
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 367

def description
    @properties['description']
end

#friendly_name ⇒ String

Returns:

  • (String) 


361
362
363
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 361

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



453
454
455
456
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 453

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

#message ⇒ String

Returns Error message.

Returns:

  • (String) —

    Error message



415
416
417
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 415

def message
    @properties['message']
end

#more_info ⇒ String

Returns Link to Error Code References.

Returns:

  • (String) —

    Link to Error Code References



421
422
423
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 421

def more_info
    @properties['more_info']
end

#policy ⇒ IamV1OrganizationVendoroauthappPolicy

Returns:

  • (IamV1OrganizationVendoroauthappPolicy) 


397
398
399
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 397

def policy
    @properties['policy']
end

#secret ⇒ String

Returns:

  • (String) 


385
386
387
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 385

def secret
    @properties['secret']
end

#sid ⇒ String

Returns:

  • (String) 


355
356
357
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 355

def sid
    @properties['sid']
end

#status ⇒ String

Returns:

  • (String) 


391
392
393
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 391

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



446
447
448
449
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 446

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

#type ⇒ String

Returns:

  • (String) 


349
350
351
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 349

def type
    @properties['type']
end

#update(iam_v1_account_vendor_oauth_app_update_request: nil) ⇒ OAuthAppInstance

Update the OAuthAppInstance

Parameters:

  • iam_v1_account_vendor_oauth_app_update_request (IamV1AccountVendorOauthAppUpdateRequest) (defaults to: nil)

Returns:



437
438
439
440
441
442
 
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 437

def update(iam_v1_account_vendor_oauth_app_update_request: nil
)

    context.update(
    )
end