Class: Twilio::REST::Trusthub::V1::EndUserContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/trusthub/v1/end_user.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ EndUserContext

Initialize the EndUserContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The unique string created by Twilio to identify the End User resource.



235
236
237
238
239
240
241
242
243
244
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 235

def initialize(version, sid)
    super(version)
    

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

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the EndUserInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

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 EndUserInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 261

def delete_with_metadata

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

#fetch ⇒ EndUserInstance

Fetch the EndUserInstance

Returns:



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 280

def fetch

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

#fetch_with_metadata ⇒ EndUserInstance

Fetch the EndUserInstanceMetadata

Returns:



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 299

def fetch_with_metadata

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



395
396
397
398
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 395

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

#to_s ⇒ Object

Provide a user friendly representation



388
389
390
391
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 388

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

#update(friendly_name: :unset, attributes: :unset) ⇒ EndUserInstance

Update the EndUserInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    The string that you assigned to describe the resource.

  • attributes (Object) (defaults to: :unset) —

    The set of parameters that are the attributes of the End User resource which are derived End User Types.

Returns:



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 326

def update(
  friendly_name: :unset, 
  attributes: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'Attributes' => Twilio.serialize_object(attributes),
    })

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

#update_with_metadata(friendly_name: :unset, attributes: :unset) ⇒ EndUserInstance

Update the EndUserInstanceMetadata

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    The string that you assigned to describe the resource.

  • attributes (Object) (defaults to: :unset) —

    The set of parameters that are the attributes of the End User resource which are derived End User Types.

Returns:



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 355

def update_with_metadata(
  friendly_name: :unset, 
  attributes: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'Attributes' => Twilio.serialize_object(attributes),
    })

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