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

  • account_sid (String)

    The SID of the Account that created this SupportingDocument resource.

  • sid (String) (defaults to: nil)

    The SID of the Call resource to fetch.



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 266

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'],
        'failure_reason' => payload['failure_reason'],
        '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](www.twilio.com/docs/iam/api/account) that created the Document resource.

Returns:



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

def 
    @properties['account_sid']
end

#attributesHash

Returns The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types.

Returns:

  • (Hash)

    The set of parameters that are the attributes of the Supporting Documents resource which are listed in the Supporting Document Types.



344
345
346
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 344

def attributes
    @properties['attributes']
end

#contextSupportingDocumentContext

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

Returns:



293
294
295
296
297
298
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 293

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

#date_createdTime

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updatedTime

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



356
357
358
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 356

def date_updated
    @properties['date_updated']
end

#deleteBoolean

Delete the SupportingDocumentInstance

Returns:

  • (Boolean)

    True if delete succeeds, false otherwise



369
370
371
372
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 369

def delete

    context.delete
end

#failure_reasonString

Returns The failure reason of the Supporting Document Resource.

Returns:

  • (String)

    The failure reason of the Supporting Document Resource.



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

def failure_reason
    @properties['failure_reason']
end

#fetchSupportingDocumentInstance

Fetch the SupportingDocumentInstance

Returns:



377
378
379
380
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 377

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.



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

def friendly_name
    @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation



407
408
409
410
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 407

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

#mime_typeString

Returns The image type uploaded in the Supporting Document container.

Returns:

  • (String)

    The image type uploaded in the Supporting Document container.



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

def mime_type
    @properties['mime_type']
end

#sidString

Returns The unique string created by Twilio to identify the Supporting Document resource.

Returns:

  • (String)

    The unique string created by Twilio to identify the Supporting Document resource.



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

def sid
    @properties['sid']
end

#statusStatus

Returns:

  • (Status)


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

def status
    @properties['status']
end

#to_sObject

Provide a user friendly representation



400
401
402
403
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 400

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

#typeString

Returns The type of the Supporting Document.

Returns:

  • (String)

    The type of the Supporting Document.



338
339
340
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 338

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 (Object) (defaults to: :unset)

    The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.

Returns:



387
388
389
390
391
392
393
394
395
396
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 387

def update(
    friendly_name: :unset, 
    attributes: :unset
)

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

#urlString

Returns The absolute URL of the Supporting Document resource.

Returns:

  • (String)

    The absolute URL of the Supporting Document resource.



362
363
364
# File 'lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb', line 362

def url
    @properties['url']
end