Class: Twilio::REST::Api::V2010::AccountContext::ConnectAppContext

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

Instance Method Summary collapse

Constructor Details

#initialize(version, account_sid, sid) ⇒ ConnectAppContext

Initialize the ConnectAppContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • account_sid (String) —

    The account_sid

  • sid (String) —

    The connect-app Sid that uniquely identifies this resource



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 165

def initialize(version, , sid)
  super(version)

  # Path Solution
  @solution = {
      account_sid: ,
      sid: sid,
  }
  @uri = "/Accounts/#{@solution[:account_sid]}/ConnectApps/#{@solution[:sid]}.json"
end

Instance Method Details

#fetch ⇒ ConnectAppInstance

Fetch a ConnectAppInstance

Returns:



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 179

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  ConnectAppInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      sid: @solution[:sid],
  )
end

#to_s ⇒ Object

Provide a user friendly representation



242
243
244
245
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 242

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Api.V2010.ConnectAppContext #{context}>"
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:



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 214

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)
  data = Twilio::Values.of({
      'AuthorizeRedirectUrl' => authorize_redirect_url,
      'CompanyName' => company_name,
      'DeauthorizeCallbackMethod' => deauthorize_callback_method,
      'DeauthorizeCallbackUrl' => deauthorize_callback_url,
      'Description' => description,
      'FriendlyName' => friendly_name,
      'HomepageUrl' => homepage_url,
      'Permissions' => permissions,
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  ConnectAppInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      sid: @solution[:sid],
  )
end