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 SID of the [Account](www.twilio.com/docs/iam/api/account) that created the ConnectApp resources to update.

  • sid (String) —

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



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 170

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

#delete ⇒ Boolean

Delete the ConnectAppInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



183
184
185
186
187
188
189
190
191
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 183

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the ConnectAppInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 196

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      connectApp_instance = ConnectAppInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      ConnectAppInstanceMetadata.new(@version, connectApp_instance, response.headers, response.status_code)
end

#fetch ⇒ ConnectAppInstance

Fetch the ConnectAppInstance

Returns:



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 215

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    ConnectAppInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ ConnectAppInstance

Fetch the ConnectAppInstanceMetadata

Returns:



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

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    connect_app_instance = ConnectAppInstance.new(
        @version,
        response.body,
        account_sid: @solution[:account_sid],
        sid: @solution[:sid],
    )
    ConnectAppInstanceMetadata.new(
        @version,
        connect_app_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Api.V2010.ConnectAppContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



363
364
365
366
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 363

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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 269

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' => Twilio.serialize_list(permissions) { |e| e },
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    ConnectAppInstance.new(
        @version,
        payload,
        account_sid: @solution[:account_sid],
        sid: @solution[:sid],
    )
end

#update_with_metadata(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 ConnectAppInstanceMetadata

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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/twilio-ruby/rest/api/v2010/account/connect_app.rb', line 317

def update_with_metadata(
  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' => Twilio.serialize_list(permissions) { |e| e },
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    connect_app_instance = ConnectAppInstance.new(
        @version,
        response.body,
        account_sid: @solution[:account_sid],
        sid: @solution[:sid],
    )
    ConnectAppInstanceMetadata.new(
        @version,
        connect_app_instance,
        response.headers,
        response.status_code
    )
end