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.



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

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) 


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

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns:

  • (String) 


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

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:



357
358
359
360
361
362
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 357

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

#date_created ⇒ Time

Returns:

  • (Time) 


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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the UserInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



451
452
453
454
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 451

def delete

    context.delete
end

#fetch ⇒ UserInstance

Fetch the UserInstance

Returns:



459
460
461
462
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 459

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


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

def friendly_name
    @properties['friendly_name']
end

#identity ⇒ String

Returns:

  • (String) 


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

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



509
510
511
512
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 509

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

#is_notifiable ⇒ Boolean

Returns:

  • (Boolean) 


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

def is_notifiable
    @properties['is_notifiable']
end

#is_online ⇒ Boolean

Returns:

  • (Boolean) 


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

def is_online
    @properties['is_online']
end

#joined_channels_count ⇒ String

Returns:

  • (String) 


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

def joined_channels_count
    @properties['joined_channels_count']
end

#links ⇒ Hash

Returns:

  • (Hash) 


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

def links
    @properties['links']
end

#role_sid ⇒ String

Returns:

  • (String) 


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

def role_sid
    @properties['role_sid']
end

#service_sid ⇒ String

Returns:

  • (String) 


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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns:

  • (String) 


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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



502
503
504
505
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 502

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:



471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 471

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) 


444
445
446
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 444

def url
    @properties['url']
end

#user_bindings ⇒ user_bindings

Access the user_bindings

Returns:



496
497
498
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 496

def user_bindings
    context.user_bindings
end

#user_channels ⇒ user_channels

Access the user_channels

Returns:



489
490
491
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 489

def user_channels
    context.user_channels
end