Class: Twilio::REST::Trusthub::V1::EndUserInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/trusthub/v1/end_user.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ EndUserInstance

Initialize the EndUserInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The unique string created by Twilio to identify the End User resource.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 235

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'friendly_name' => payload['friendly_name'],
      'type' => payload['type'],
      'attributes' => payload['attributes'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



274
275
276
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 274

def 
  @properties['account_sid']
end

#attributes ⇒ Hash

Returns The set of parameters that compose the End Users resource.

Returns:

  • (Hash) —

    The set of parameters that compose the End Users resource



292
293
294
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 292

def attributes
  @properties['attributes']
end

#context ⇒ EndUserContext

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

Returns:



259
260
261
262
263
264
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 259

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

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



298
299
300
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 298

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



304
305
306
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 304

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the EndUserInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



335
336
337
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 335

def delete
  context.delete
end

#fetch ⇒ EndUserInstance

Fetch the EndUserInstance

Returns:



317
318
319
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 317

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource



280
281
282
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 280

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



348
349
350
351
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 348

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

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



268
269
270
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 268

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



341
342
343
344
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 341

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

#type ⇒ String

Returns The type of end user of the Bundle resource.

Returns:

  • (String) —

    The type of end user of the Bundle resource



286
287
288
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 286

def type
  @properties['type']
end

#update(friendly_name: :unset, attributes: :unset) ⇒ EndUserInstance

Update the EndUserInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    The string that you assigned to describe the resource.

  • attributes (Hash) (defaults to: :unset) —

    The set of parameters that are the attributes of the End User resource which are derived End User Types.

Returns:



328
329
330
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 328

def update(friendly_name: :unset, attributes: :unset)
  context.update(friendly_name: friendly_name, attributes: attributes, )
end

#url ⇒ String

Returns The absolute URL of the End User resource.

Returns:

  • (String) —

    The absolute URL of the End User resource



310
311
312
 
# File 'lib/twilio-ruby/rest/trusthub/v1/end_user.rb', line 310

def url
  @properties['url']
end