Class: Twilio::REST::Numbers::V2::RegulatoryComplianceList::EndUserInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/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.


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

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_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


275
276
277
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user.rb', line 275

def 
  @properties['account_sid']
end

#attributesHash

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

Returns:

  • (Hash)

    The set of parameters that compose the End Users resource


293
294
295
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user.rb', line 293

def attributes
  @properties['attributes']
end

#contextEndUserContext

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

Returns:


260
261
262
263
264
265
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user.rb', line 260

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

#date_createdTime

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


299
300
301
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user.rb', line 299

def date_created
  @properties['date_created']
end

#date_updatedTime

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


305
306
307
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user.rb', line 305

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the EndUserInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


336
337
338
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user.rb', line 336

def delete
  context.delete
end

#fetchEndUserInstance

Fetch the EndUserInstance

Returns:


318
319
320
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user.rb', line 318

def fetch
  context.fetch
end

#friendly_nameString

Returns The string that you assigned to describe the resource.

Returns:

  • (String)

    The string that you assigned to describe the resource


281
282
283
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user.rb', line 281

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


349
350
351
352
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user.rb', line 349

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

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


269
270
271
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user.rb', line 269

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


342
343
344
345
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user.rb', line 342

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

#typeend_user.Type

Returns The type of end user of the Bundle resource.

Returns:

  • (end_user.Type)

    The type of end user of the Bundle resource


287
288
289
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user.rb', line 287

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:


329
330
331
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user.rb', line 329

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

#urlString

Returns The absolute URL of the End User resource.

Returns:

  • (String)

    The absolute URL of the End User resource


311
312
313
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/end_user.rb', line 311

def url
  @properties['url']
end