Class: Twilio::REST::Trusthub::V1::SupportingDocumentInstance

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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 264

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

Returns:



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

def 
    @properties['account_sid']
end

#attributes ⇒ Hash

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.



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

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:



290
291
292
293
294
295
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 290

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

#date_created ⇒ Time

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

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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:



347
348
349
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 347

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SupportingDocumentInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



360
361
362
363
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 360

def delete

    context.delete
end

#fetch ⇒ SupportingDocumentInstance

Fetch the SupportingDocumentInstance

Returns:



368
369
370
371
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 368

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.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



398
399
400
401
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 398

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

#mime_type ⇒ String

Returns The image type uploaded in the Supporting Document container.

Returns:

  • (String) —

    The image type uploaded in the Supporting Document container.



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

def mime_type
    @properties['mime_type']
end

#sid ⇒ String

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.



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

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


323
324
325
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 323

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



391
392
393
394
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 391

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

#type ⇒ String

Returns The type of the Supporting Document.

Returns:

  • (String) —

    The type of the Supporting Document.



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

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:



378
379
380
381
382
383
384
385
386
387
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 378

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.



353
354
355
 
# File 'lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb', line 353

def url
    @properties['url']
end