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 unique id of the [Account](www.twilio.com/docs/api/rest/account) that created this ConnectApp.

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

    The connect-app Sid that uniquely identifies this resource



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 247

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 unique sid that identifies this account.

Returns:

  • (String) —

    The unique sid that identifies this account



283
284
285
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 283

def 
  @properties['account_sid']
end

#authorize_redirect_url ⇒ String

Returns URIL Twilio sends requests when users authorize.

Returns:

  • (String) —

    URIL Twilio sends requests when users authorize



289
290
291
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 289

def authorize_redirect_url
  @properties['authorize_redirect_url']
end

#company_name ⇒ String

Returns The company name set for this Connect App.

Returns:

  • (String) —

    The company name set for this Connect App.



295
296
297
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 295

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:



274
275
276
277
278
279
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 274

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

#deauthorize_callback_method ⇒ String

Returns HTTP method Twilio will use making requests to the url.

Returns:

  • (String) —

    HTTP method Twilio will use making requests to the url



301
302
303
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 301

def deauthorize_callback_method
  @properties['deauthorize_callback_method']
end

#deauthorize_callback_url ⇒ String

Returns URL Twilio will send a request when a user de-authorizes this app.

Returns:

  • (String) —

    URL Twilio will send a request when a user de-authorizes this app



307
308
309
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 307

def deauthorize_callback_url
  @properties['deauthorize_callback_url']
end

#description ⇒ String

Returns A more detailed human readable description.

Returns:

  • (String) —

    A more detailed human readable description



313
314
315
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 313

def description
  @properties['description']
end

#fetch ⇒ ConnectAppInstance

Fetch a ConnectAppInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A human readable name for the Connect App.

Returns:

  • (String) —

    A human readable name for the Connect App.



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

def friendly_name
  @properties['friendly_name']
end

#homepage_url ⇒ String

Returns The URL users can obtain more information.

Returns:

  • (String) —

    The URL users can obtain more information



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

def homepage_url
  @properties['homepage_url']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



396
397
398
399
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 396

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

#permissions ⇒ connect_app.Permission

Returns The set of permissions that your ConnectApp requests.

Returns:

  • (connect_app.Permission) —

    The set of permissions that your ConnectApp requests.



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

def permissions
  @properties['permissions']
end

#sid ⇒ String

Returns A string that uniquely identifies this connect-apps.

Returns:

  • (String) —

    A string that uniquely identifies this connect-apps



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



389
390
391
392
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 389

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 the user’s browser will redirect to after Twilio authenticates the user and obtains authorization for this Connect App.

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

    The company name set for this Connect App.

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

    The HTTP method to be used when making a request to the ‘DeauthorizeCallbackUrl`. Either `GET` or `POST`.

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

    The URL to which Twilio will send a request when a user de-authorizes this Connect App.

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

    A more detailed human readable description of the Connect App.

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

    A human readable description of the Connect App, with maximum length 64 characters.

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

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

  • permissions (connect_app.Permission) (defaults to: :unset) —

    A comma-separated list of permssions you will request from users of this ConnectApp. Valid permssions are ‘get-all` or `post-all`.

Returns:



374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 374

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 for this resource.

Returns:

  • (String) —

    The URI for this resource



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

def uri
  @properties['uri']
end