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.



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/user.rb', line 322

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) 


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

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns:

  • (String) 


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

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:



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

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

#date_created ⇒ Time

Returns:

  • (Time) 


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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the UserInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ UserInstance

Fetch the UserInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


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

def friendly_name
    @properties['friendly_name']
end

#identity ⇒ String

Returns:

  • (String) 


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

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#is_notifiable ⇒ Boolean

Returns:

  • (Boolean) 


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

def is_notifiable
    @properties['is_notifiable']
end

#is_online ⇒ Boolean

Returns:

  • (Boolean) 


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

def is_online
    @properties['is_online']
end

#joined_channels_count ⇒ String

Returns:

  • (String) 


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

def joined_channels_count
    @properties['joined_channels_count']
end

#links ⇒ Hash

Returns:

  • (Hash) 


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

def links
    @properties['links']
end

#role_sid ⇒ String

Returns:

  • (String) 


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

def role_sid
    @properties['role_sid']
end

#service_sid ⇒ String

Returns:

  • (String) 


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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns:

  • (String) 


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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:



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

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) 


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

def url
    @properties['url']
end

#user_bindings ⇒ user_bindings

Access the user_bindings

Returns:



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

def user_bindings
    context.user_bindings
end

#user_channels ⇒ user_channels

Access the user_channels

Returns:



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

def user_channels
    context.user_channels
end