Class: Twilio::REST::Api::V2010::AccountContext::AuthorizedConnectAppInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, connect_app_sid: nil) ⇒ AuthorizedConnectAppInstance

Initialize the AuthorizedConnectAppInstance

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 AuthorizedConnectApp resource.

  • sid (String)

    The SID of the Call resource to fetch.



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb', line 222

def initialize(version, payload , account_sid: nil, connect_app_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'connect_app_company_name' => payload['connect_app_company_name'],
        'connect_app_description' => payload['connect_app_description'],
        'connect_app_friendly_name' => payload['connect_app_friendly_name'],
        'connect_app_homepage_url' => payload['connect_app_homepage_url'],
        'connect_app_sid' => payload['connect_app_sid'],
        'permissions' => payload['permissions'],
        'uri' => payload['uri'],
    }

    # Context
    @instance_context = nil
    @params = { 'account_sid' =>   ,'connect_app_sid' => connect_app_sid  || @properties['connect_app_sid']  , }
end

Instance Method Details

#account_sidString

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the AuthorizedConnectApp resource.

Returns:



255
256
257
# File 'lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb', line 255

def 
    @properties['account_sid']
end

#connect_app_company_nameString

Returns The company name set for the Connect App.

Returns:

  • (String)

    The company name set for the Connect App.



261
262
263
# File 'lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb', line 261

def connect_app_company_name
    @properties['connect_app_company_name']
end

#connect_app_descriptionString

Returns A detailed description of the Connect App.

Returns:

  • (String)

    A detailed description of the Connect App.



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

def connect_app_description
    @properties['connect_app_description']
end

#connect_app_friendly_nameString

Returns The name of the Connect App.

Returns:

  • (String)

    The name of the Connect App.



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

def connect_app_friendly_name
    @properties['connect_app_friendly_name']
end

#connect_app_homepage_urlString

Returns The public URL for the Connect App.

Returns:

  • (String)

    The public URL for the Connect App.



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

def connect_app_homepage_url
    @properties['connect_app_homepage_url']
end

#connect_app_sidString

Returns The SID that we assigned to the Connect App.

Returns:

  • (String)

    The SID that we assigned to the Connect App.



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

def connect_app_sid
    @properties['connect_app_sid']
end

#contextAuthorizedConnectAppContext

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

Returns:



246
247
248
249
250
251
# File 'lib/twilio-ruby/rest/api/v2010/account/authorized_connect_app.rb', line 246

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

#fetchAuthorizedConnectAppInstance

Fetch the AuthorizedConnectAppInstance

Returns:



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

def fetch

    context.fetch
end

#inspectObject

Provide a detailed, user friendly representation



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

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

#permissionsArray<Permission>

Returns The set of permissions that you authorized for the Connect App. Can be: ‘get-all` or `post-all`.

Returns:

  • (Array<Permission>)

    The set of permissions that you authorized for the Connect App. Can be: ‘get-all` or `post-all`.



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

def permissions
    @properties['permissions']
end

#to_sObject

Provide a user friendly representation



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

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

#uriString

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

Returns:

  • (String)

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



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

def uri
    @properties['uri']
end