Class: Twilio::REST::Notify::V1::ServiceContext::UserInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/notify/v1/service/user.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

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

Initialize the UserInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The service_sid

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

    The identity



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

def initialize(version, payload, service_sid: nil, identity: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'service_sid' => payload['service_sid'],
      'identity' => payload['identity'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'segments' => payload['segments'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



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

def 
  @properties['account_sid']
end

#bindings ⇒ bindings

Access the bindings

Returns:



431
432
433
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 431

def bindings
  context.bindings
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:



349
350
351
352
353
354
355
356
357
358
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 349

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

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the UserInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



417
418
419
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 417

def delete
  context.delete
end

#fetch ⇒ UserInstance

Fetch a UserInstance

Returns:



424
425
426
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 424

def fetch
  context.fetch
end

#identity ⇒ String

Returns The identity.

Returns:

  • (String) —

    The identity



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

def identity
  @properties['identity']
end

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#segment_memberships ⇒ segment_memberships

Access the segment_memberships

Returns:



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

def segment_memberships
  context.segment_memberships
end

#segments ⇒ String

Returns The segments.

Returns:

  • (String) —

    The segments



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

def segments
  @properties['segments']
end

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



444
445
446
447
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 444

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end