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.



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 514

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:



551
552
553
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 551

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.



557
558
559
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 557

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.



563
564
565
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 563

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:



542
543
544
545
546
547
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 542

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.



569
570
571
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 569

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.



575
576
577
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 575

def deauthorize_callback_url
    @properties['deauthorize_callback_url']
end

#delete ⇒ Boolean

Delete the ConnectAppInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



618
619
620
621
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 618

def delete

    context.delete
end

#description ⇒ String

Returns The description of the Connect App.

Returns:

  • (String) —

    The description of the Connect App.



581
582
583
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 581

def description
    @properties['description']
end

#fetch ⇒ ConnectAppInstance

Fetch the ConnectAppInstance

Returns:



626
627
628
629
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 626

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.



587
588
589
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 587

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.



593
594
595
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 593

def homepage_url
    @properties['homepage_url']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



674
675
676
677
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 674

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.



599
600
601
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 599

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.



605
606
607
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 605

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



667
668
669
670
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 667

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:



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 642

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 https://api.twilio.com.

Returns:

  • (String) —

    The URI of the resource, relative to https://api.twilio.com.



611
612
613
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 611

def uri
    @properties['uri']
end