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 the ConnectApp resource.

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

    The Twilio-provided string that uniquely identifies the ConnectApp resource to fetch.


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

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 that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#authorize_redirect_url ⇒ String

Returns The URL to redirect the user to after authorization.

Returns:

  • (String) —

    The URL to redirect the user to after authorization


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

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


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

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:


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

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


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

def deauthorize_callback_method
  @properties['deauthorize_callback_method']
end

#deauthorize_callback_url ⇒ String

Returns The URL we call to de-authorize the Connect App.

Returns:

  • (String) —

    The URL we call to de-authorize the Connect App


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

def deauthorize_callback_url
  @properties['deauthorize_callback_url']
end

#delete ⇒ Boolean

Delete the ConnectAppInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#description ⇒ String

Returns The description of the Connect App.

Returns:

  • (String) —

    The description of the Connect App


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

def description
  @properties['description']
end

#fetch ⇒ ConnectAppInstance

Fetch the ConnectAppInstance

Returns:


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

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


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

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


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

def homepage_url
  @properties['homepage_url']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


405
406
407
408
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 405

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

#permissions ⇒ Array[connect_app.Permission]

Returns The set of permissions that your ConnectApp requests.

Returns:

  • (Array[connect_app.Permission]) —

    The set of permissions that your ConnectApp requests


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

def permissions
  @properties['permissions']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation


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

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[connect_app.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:


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

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:


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

def uri
  @properties['uri']
end