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 that created this ConnectApp.

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

    The connect-app Sid that uniquely identifies this resource



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 231

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



267
268
269
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 267

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



273
274
275
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 273

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.



279
280
281
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 279

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:



258
259
260
261
262
263
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 258

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



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

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



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

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



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

def description
  @properties['description']
end

#fetch ⇒ ConnectAppInstance

Fetch a ConnectAppInstance

Returns:



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

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.



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

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



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

def homepage_url
  @properties['homepage_url']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

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



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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`.

  • 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 name for the Connect App.

  • 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) —

    The set of permissions that your ConnectApp requests.

Returns:



356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 356

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



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

def uri
  @properties['uri']
end