Class: Twilio::REST::Api::V2010::AccountContext::ConnectAppInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Api::V2010::AccountContext::ConnectAppInstance
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/connect_app.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the ConnectApp resource.
-
#authorize_redirect_url ⇒ String
The URL we redirect the user to after we authenticate the user and obtain authorization to access the Connect App.
-
#company_name ⇒ String
The company name set for the Connect App.
-
#context ⇒ ConnectAppContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#deauthorize_callback_method ⇒ String
The HTTP method we use to call ‘deauthorize_callback_url`.
-
#deauthorize_callback_url ⇒ String
The URL we call using the ‘deauthorize_callback_method` to de-authorize the Connect App.
-
#delete ⇒ Boolean
Delete the ConnectAppInstance.
-
#description ⇒ String
The description of the Connect App.
-
#fetch ⇒ ConnectAppInstance
Fetch the ConnectAppInstance.
-
#friendly_name ⇒ String
The string that you assigned to describe the resource.
-
#homepage_url ⇒ String
The public URL where users can obtain more information about this Connect App.
-
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ ConnectAppInstance
constructor
Initialize the ConnectAppInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#permissions ⇒ Array<Permission>
The set of permissions that your ConnectApp requests.
-
#sid ⇒ String
The unique string that that we created to identify the ConnectApp resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#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.
-
#uri ⇒ String
The URI of the resource, relative to ‘api.twilio.com`.
Constructor Details
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ ConnectAppInstance
Initialize the ConnectAppInstance
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 |
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 262 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' => 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.
298 299 300 |
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 298 def account_sid @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.
304 305 306 |
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 304 def @properties['authorize_redirect_url'] end |
#company_name ⇒ String
Returns The company name set for the Connect App.
310 311 312 |
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 310 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
289 290 291 292 293 294 |
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 289 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`.
316 317 318 |
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 316 def @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.
322 323 324 |
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 322 def @properties['deauthorize_callback_url'] end |
#delete ⇒ Boolean
Delete the ConnectAppInstance
365 366 367 368 |
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 365 def delete context.delete end |
#description ⇒ String
Returns The description of the Connect App.
328 329 330 |
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 328 def description @properties['description'] end |
#fetch ⇒ ConnectAppInstance
Fetch the ConnectAppInstance
373 374 375 376 |
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 373 def fetch context.fetch end |
#friendly_name ⇒ String
Returns The string that you assigned to describe the resource.
334 335 336 |
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 334 def friendly_name @properties['friendly_name'] end |
#homepage_url ⇒ String
Returns The public URL where users can obtain more information about this Connect App.
340 341 342 |
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 340 def homepage_url @properties['homepage_url'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
421 422 423 424 |
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 421 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.
346 347 348 |
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 346 def @properties['permissions'] end |
#sid ⇒ String
Returns The unique string that that we created to identify the ConnectApp resource.
352 353 354 |
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 352 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
414 415 416 417 |
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 414 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
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 |
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 389 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: , company_name: company_name, deauthorize_callback_method: , deauthorize_callback_url: , description: description, friendly_name: friendly_name, homepage_url: homepage_url, permissions: , ) end |
#uri ⇒ String
Returns The URI of the resource, relative to ‘api.twilio.com`.
358 359 360 |
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 358 def uri @properties['uri'] end |