Class: Twilio::REST::IpMessaging::V2::ServiceContext::UserInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ UserInstance

Initialize the UserInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this User resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



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
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 323

def initialize(version, payload , service_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'attributes' => payload['attributes'],
        'friendly_name' => payload['friendly_name'],
        'role_sid' => payload['role_sid'],
        'identity' => payload['identity'],
        'is_online' => payload['is_online'],
        'is_notifiable' => payload['is_notifiable'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'joined_channels_count' => payload['joined_channels_count'] == nil ? payload['joined_channels_count'] : payload['joined_channels_count'].to_i,
        'links' => payload['links'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'service_sid' => service_sid  || @properties['service_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns:

  • (String) 


368
369
370
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 368

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns:

  • (String) 


380
381
382
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 380

def attributes
    @properties['attributes']
end

#context ⇒ UserContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



353
354
355
356
357
358
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 353

def context
    unless @instance_context
        @instance_context = UserContext.new(@version , @params['service_sid'], @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time

Returns:

  • (Time) 


416
417
418
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 416

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


422
423
424
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 422

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the UserInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



447
448
449
450
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 447

def delete

    context.delete
end

#fetch ⇒ UserInstance

Fetch the UserInstance

Returns:



455
456
457
458
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 455

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


386
387
388
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 386

def friendly_name
    @properties['friendly_name']
end

#identity ⇒ String

Returns:

  • (String) 


398
399
400
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 398

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



505
506
507
508
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 505

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.IpMessaging.V2.UserInstance #{values}>"
end

#is_notifiable ⇒ Boolean

Returns:

  • (Boolean) 


410
411
412
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 410

def is_notifiable
    @properties['is_notifiable']
end

#is_online ⇒ Boolean

Returns:

  • (Boolean) 


404
405
406
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 404

def is_online
    @properties['is_online']
end

#joined_channels_count ⇒ String

Returns:

  • (String) 


428
429
430
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 428

def joined_channels_count
    @properties['joined_channels_count']
end

#links ⇒ Hash

Returns:

  • (Hash) 


434
435
436
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 434

def links
    @properties['links']
end

#role_sid ⇒ String

Returns:

  • (String) 


392
393
394
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 392

def role_sid
    @properties['role_sid']
end

#service_sid ⇒ String

Returns:

  • (String) 


374
375
376
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 374

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns:

  • (String) 


362
363
364
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 362

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



498
499
500
501
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 498

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.IpMessaging.V2.UserInstance #{values}>"
end

#update(role_sid: :unset, attributes: :unset, friendly_name: :unset, x_twilio_webhook_enabled: :unset) ⇒ UserInstance

Update the UserInstance

Parameters:

  • role_sid (String) (defaults to: :unset)
  • attributes (String) (defaults to: :unset)
  • friendly_name (String) (defaults to: :unset)
  • x_twilio_webhook_enabled (UserEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 467

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

    context.update(
        role_sid: role_sid, 
        attributes: attributes, 
        friendly_name: friendly_name, 
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#url ⇒ String

Returns:

  • (String) 


440
441
442
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 440

def url
    @properties['url']
end

#user_bindings ⇒ user_bindings

Access the user_bindings

Returns:



492
493
494
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 492

def user_bindings
    context.user_bindings
end

#user_channels ⇒ user_channels

Access the user_channels

Returns:



485
486
487
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 485

def user_channels
    context.user_channels
end