Class: Twilio::REST::Api::V2010::AccountContext::ConnectAppInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/connect_app.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, sid: nil) ⇒ ConnectAppInstance

Initialize the ConnectAppInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the Account that created this ConnectApp resource.

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

    The SID of the Call resource to fetch.



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 282

def initialize(version, payload , account_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'authorize_redirect_url' => payload['authorize_redirect_url'],
        'company_name' => payload['company_name'],
        'deauthorize_callback_method' => payload['deauthorize_callback_method'],
        'deauthorize_callback_url' => payload['deauthorize_callback_url'],
        'description' => payload['description'],
        'friendly_name' => payload['friendly_name'],
        'homepage_url' => payload['homepage_url'],
        'permissions' => payload['permissions'],
        'sid' => payload['sid'],
        'uri' => payload['uri'],
    }

    # Context
    @instance_context = nil
    @params = { 'account_sid' =>   ,'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 ConnectApp resource.

Returns:



318
319
320
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 318

def 
    @properties['account_sid']
end

#authorize_redirect_url ⇒ String

Returns The URL we redirect the user to after we authenticate the user and obtain authorization to access the Connect App.

Returns:

  • (String) —

    The URL we redirect the user to after we authenticate the user and obtain authorization to access the Connect App.



324
325
326
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 324

def authorize_redirect_url
    @properties['authorize_redirect_url']
end

#company_name ⇒ String

Returns The company name set for the Connect App.

Returns:

  • (String) —

    The company name set for the Connect App.



330
331
332
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 330

def company_name
    @properties['company_name']
end

#context ⇒ ConnectAppContext

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

Returns:



309
310
311
312
313
314
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 309

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

#deauthorize_callback_method ⇒ String

Returns The HTTP method we use to call ‘deauthorize_callback_url`.

Returns:

  • (String) —

    The HTTP method we use to call ‘deauthorize_callback_url`.



336
337
338
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 336

def deauthorize_callback_method
    @properties['deauthorize_callback_method']
end

#deauthorize_callback_url ⇒ String

Returns The URL we call using the ‘deauthorize_callback_method` to de-authorize the Connect App.

Returns:

  • (String) —

    The URL we call using the ‘deauthorize_callback_method` to de-authorize the Connect App.



342
343
344
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 342

def deauthorize_callback_url
    @properties['deauthorize_callback_url']
end

#delete ⇒ Boolean

Delete the ConnectAppInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



385
386
387
388
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 385

def delete

    context.delete
end

#description ⇒ String

Returns The description of the Connect App.

Returns:

  • (String) —

    The description of the Connect App.



348
349
350
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 348

def description
    @properties['description']
end

#fetch ⇒ ConnectAppInstance

Fetch the ConnectAppInstance

Returns:



393
394
395
396
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 393

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource.



354
355
356
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 354

def friendly_name
    @properties['friendly_name']
end

#homepage_url ⇒ String

Returns The public URL where users can obtain more information about this Connect App.

Returns:

  • (String) —

    The public URL where users can obtain more information about this Connect App.



360
361
362
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 360

def homepage_url
    @properties['homepage_url']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



441
442
443
444
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 441

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

#permissions ⇒ Array<Permission>

Returns The set of permissions that your ConnectApp requests.

Returns:

  • (Array<Permission>) —

    The set of permissions that your ConnectApp requests.



366
367
368
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 366

def permissions
    @properties['permissions']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



372
373
374
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 372

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



434
435
436
437
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 434

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

#update(authorize_redirect_url: :unset, company_name: :unset, deauthorize_callback_method: :unset, deauthorize_callback_url: :unset, description: :unset, friendly_name: :unset, homepage_url: :unset, permissions: :unset) ⇒ ConnectAppInstance

Update the ConnectAppInstance

Parameters:

  • authorize_redirect_url (String) (defaults to: :unset) —

    The URL to redirect the user to after we authenticate the user and obtain authorization to access the Connect App.

  • company_name (String) (defaults to: :unset) —

    The company name to set for the Connect App.

  • deauthorize_callback_method (String) (defaults to: :unset) —

    The HTTP method to use when calling ‘deauthorize_callback_url`.

  • deauthorize_callback_url (String) (defaults to: :unset) —

    The URL to call using the ‘deauthorize_callback_method` to de-authorize the Connect App.

  • description (String) (defaults to: :unset) —

    A description of the Connect App.

  • friendly_name (String) (defaults to: :unset) —

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

  • homepage_url (String) (defaults to: :unset) —

    A public URL where users can obtain more information about this Connect App.

  • permissions (Array[Permission]) (defaults to: :unset) —

    A comma-separated list of the permissions you will request from the users of this ConnectApp. Can include: ‘get-all` and `post-all`.

Returns:



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 409

def update(
    authorize_redirect_url: :unset, 
    company_name: :unset, 
    deauthorize_callback_method: :unset, 
    deauthorize_callback_url: :unset, 
    description: :unset, 
    friendly_name: :unset, 
    homepage_url: :unset, 
    permissions: :unset
)

    context.update(
        authorize_redirect_url: authorize_redirect_url, 
        company_name: company_name, 
        deauthorize_callback_method: deauthorize_callback_method, 
        deauthorize_callback_url: deauthorize_callback_url, 
        description: description, 
        friendly_name: friendly_name, 
        homepage_url: homepage_url, 
        permissions: permissions, 
    )
end

#uri ⇒ String

Returns The URI of the resource, relative to ‘api.twilio.com`.

Returns:

  • (String) —

    The URI of the resource, relative to ‘api.twilio.com`.



378
379
380
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 378

def uri
    @properties['uri']
end