Class: Twilio::REST::PreviewIam::Versionless::OrganizationContext::UserContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, organization_sid, id) ⇒ UserContext

Initialize the UserContext

Parameters:

  • Version that contains the resource



277
278
279
280
281
282
283
284
285
286
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 277

def initialize(version, organization_sid, id)
    super(version)
    

    # Path Solution
    @solution = { organization_sid: organization_sid, id: id,  }
    @uri = "/#{@solution[:organization_sid]}/scim/Users/#{@solution[:id]}"

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the UserInstance

Returns:

  • True if delete succeeds, false otherwise



290
291
292
293
294
295
296
297
298
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 290

def delete

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

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

#delete_with_metadata ⇒ Boolean

Delete the UserInstanceMetadata

Returns:

  • True if delete succeeds, false otherwise



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 303

def delete_with_metadata

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

#fetch ⇒ UserInstance

Fetch the UserInstance

Returns:

  • Fetched UserInstance



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 322

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    headers['Accept'] = 'application/scim+json'
    
    payload = @version.fetch('GET', @uri, headers: headers)
    UserInstance.new(
        @version,
        payload,
        organization_sid: @solution[:organization_sid],
        id: @solution[:id],
    )
end

#fetch_with_metadata ⇒ UserInstance

Fetch the UserInstanceMetadata

Returns:

  • Fetched UserInstance



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 342

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    headers['Accept'] = 'application/scim+json'
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    user_instance = UserInstance.new(
        @version,
        response.body,
        organization_sid: @solution[:organization_sid],
        id: @solution[:id],
    )
    UserInstanceMetadata.new(
        @version,
        user_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



429
430
431
432
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 429

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

#to_s ⇒ Object

Provide a user friendly representation



422
423
424
425
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 422

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

#update(if_match: :unset, scim_user: nil) ⇒ UserInstance

Update the UserInstance

Parameters:

  • (defaults to: :unset)
  • (defaults to: nil)

Returns:

  • Updated UserInstance



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 370

def update(
    if_match: :unset,scim_user: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
    
    headers['Content-Type'] = 'application/scim+json'
    
    headers['Accept'] = 'application/scim+json'
    
    payload = @version.update('PUT', @uri, headers: headers, data: scim_user.to_json)
    UserInstance.new(
        @version,
        payload,
        organization_sid: @solution[:organization_sid],
        id: @solution[:id],
    )
end

#update_with_metadata(if_match: :unset, scim_user: nil) ⇒ UserInstance

Update the UserInstanceMetadata

Parameters:

  • (defaults to: :unset)
  • (defaults to: nil)

Returns:

  • Updated UserInstance



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/twilio-ruby/rest/preview_iam/versionless/organization/user.rb', line 394

def update_with_metadata(
  if_match: :unset,scim_user: nil
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'If-Match' => if_match, })
    
    headers['Content-Type'] = 'application/scim+json'
    
    headers['Accept'] = 'application/scim+json'
    
    response = @version.update_with_metadata('PUT', @uri, headers: headers, data: scim_user.to_json)
    user_instance = UserInstance.new(
        @version,
        response.body,
        organization_sid: @solution[:organization_sid],
        id: @solution[:id],
    )
    UserInstanceMetadata.new(
        @version,
        user_instance,
        response.headers,
        response.status_code
    )
end