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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 306

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



346
347
348
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 346

def 
  @properties['account_sid']
end

#bindings ⇒ bindings

Access the bindings

Returns:



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

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:



331
332
333
334
335
336
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 331

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



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the UserInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



395
396
397
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 395

def delete
  context.delete
end

#fetch ⇒ UserInstance

Fetch a UserInstance

Returns:



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

def fetch
  context.fetch
end

#identity ⇒ String

Returns The identifier of the User, defined by your application.

Returns:

  • (String) —

    The identifier of the User, defined by your application.



358
359
360
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 358

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#segment_memberships ⇒ segment_memberships

Access the segment_memberships

Returns:



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

def segment_memberships
  context.segment_memberships
end

#segments ⇒ String

Returns The segments.

Returns:

  • (String) —

    The segments



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

def segments
  @properties['segments']
end

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid



352
353
354
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 352

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



340
341
342
 
# File 'lib/twilio-ruby/rest/notify/v1/service/user.rb', line 340

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

def url
  @properties['url']
end