Class: Twilio::REST::Numbers::V2::RegulatoryComplianceList::SupportingDocumentInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the SupportingDocumentInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The unique string that we created to identify the Supporting Document resource.



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 245

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'friendly_name' => payload['friendly_name'],
      'mime_type' => payload['mime_type'],
      'status' => payload['status'],
      '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



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

def 
  @properties['account_sid']
end

#attributes ⇒ Hash

Returns The set of parameters that compose the Supporting Documents resource.

Returns:

  • (Hash) —

    The set of parameters that compose the Supporting Documents resource



316
317
318
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 316

def attributes
  @properties['attributes']
end

#context ⇒ SupportingDocumentContext

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

Returns:



271
272
273
274
275
276
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 271

def context
  unless @instance_context
    @instance_context = SupportingDocumentContext.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



322
323
324
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 322

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



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

def date_updated
  @properties['date_updated']
end

#fetch ⇒ SupportingDocumentInstance

Fetch a SupportingDocumentInstance

Returns:



341
342
343
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 341

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



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



365
366
367
368
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 365

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

#mime_type ⇒ String

Returns The image type of the file.

Returns:

  • (String) —

    The image type of the file



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

def mime_type
  @properties['mime_type']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#status ⇒ supporting_document.Status

Returns The verification status of the Supporting Document resource.

Returns:

  • (supporting_document.Status) —

    The verification status of the Supporting Document resource



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



358
359
360
361
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 358

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

#type ⇒ String

Returns The type of the Supporting Document.

Returns:

  • (String) —

    The type of the Supporting Document



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

def type
  @properties['type']
end

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

Update the SupportingDocumentInstance

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 Supporting Document resource which are derived Supporting Document Types.

Returns:



352
353
354
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 352

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

#url ⇒ String

Returns The absolute URL of the Supporting Document resource.

Returns:

  • (String) —

    The absolute URL of the Supporting Document resource



334
335
336
 
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 334

def url
  @properties['url']
end