Class: Twilio::REST::Iam::V1::OAuthAppContext

Inherits:
Twilio::REST::InstanceContext show all
Defined in:
lib/twilio-ruby/rest/iam/v1/o_auth_app.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ OAuthAppContext

Initialize the OAuthAppContext

Parameters:

  • version (Version)

    Version that contains the resource

  • sid (String)

    Unique ID (sid) of the OAuth app



248
249
250
251
252
253
254
255
256
257
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 248

def initialize(version, sid)
    super(version)
    

    # Path Solution
    @solution = { sid: sid,  }
    @uri = "/Account/OAuthApps/#{@solution[:sid]}"

    
end

Instance Method Details

#deleteBoolean

Delete the OAuthAppInstance

Returns:

  • (Boolean)

    True if delete succeeds, false otherwise



261
262
263
264
265
266
267
268
269
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 261

def delete

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

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

#delete_with_metadataBoolean

Delete the OAuthAppInstanceMetadata

Returns:

  • (Boolean)

    True if delete succeeds, false otherwise



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 274

def 

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

#inspectObject

Provide a detailed, user friendly representation



348
349
350
351
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 348

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

#to_sObject

Provide a user friendly representation



341
342
343
344
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 341

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Iam.V1.OAuthAppContext #{context}>"
end

#update(iam_v1_account_vendor_oauth_app_update_request: nil) ⇒ OAuthAppInstance

Update the OAuthAppInstance

Parameters:

  • iam_v1_account_vendor_oauth_app_update_request (IamV1AccountVendorOauthAppUpdateRequest) (defaults to: nil)

Returns:



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 294

def update(iam_v1_account_vendor_oauth_app_update_request: nil
)

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

#update_with_metadata(iam_v1_account_vendor_oauth_app_update_request: nil) ⇒ OAuthAppInstance

Update the OAuthAppInstanceMetadata

Parameters:

  • iam_v1_account_vendor_oauth_app_update_request (IamV1AccountVendorOauthAppUpdateRequest) (defaults to: nil)

Returns:



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'lib/twilio-ruby/rest/iam/v1/o_auth_app.rb', line 315

def (iam_v1_account_vendor_oauth_app_update_request: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    headers['Content-Type'] = 'application/json'
    
    
    
    
    response = @version.('PUT', @uri, headers: headers, data: .to_json)
    o_auth_app_instance = OAuthAppInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    OAuthAppInstanceMetadata.new(
        @version,
        o_auth_app_instance,
        response.headers,
        response.status_code
    )
end