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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Trusthub::V1::SupportingDocumentInstance

Defined in:

lib/twilio-ruby/rest/trusthub/v1/supporting_document.rb

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the resource.

• #attributes ⇒ Hash

  The set of parameters that compose the Supporting Documents resource.

• #context ⇒ SupportingDocumentContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #date_created ⇒ Time

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

• #date_updated ⇒ Time

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

• #delete ⇒ Boolean

  Delete the SupportingDocumentInstance.

• #fetch ⇒ SupportingDocumentInstance

  Fetch the SupportingDocumentInstance.

• #friendly_name ⇒ String

  The string that you assigned to describe the resource.

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

  Initialize the SupportingDocumentInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #mime_type ⇒ String

  The image type of the file.

• #sid ⇒ String

  The unique string that identifies the resource.

• #status ⇒ supporting_document.Status

  The verification status of the Supporting Document resource.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #type ⇒ String

  The type of the Supporting Document.

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

  Update the SupportingDocumentInstance.

• #url ⇒ String

  The absolute URL of the Supporting Document resource.

Constructor Details

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

Initialize the SupportingDocumentInstance

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

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

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

def account_sid
  @properties['account_sid']
end

#attributes ⇒ Hash

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

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

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

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

#date_created ⇒ Time

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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SupportingDocumentInstance

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

def delete
  context.delete
end

#fetch ⇒ SupportingDocumentInstance

Fetch the SupportingDocumentInstance

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

def fetch
  context.fetch
end

#friendly_name ⇒ String

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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#mime_type ⇒ String

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

def mime_type
  @properties['mime_type']
end

#sid ⇒ String

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

def sid
  @properties['sid']
end

#status ⇒ supporting_document.Status

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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#type ⇒ String

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

def type
  @properties['type']
end

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

Update the SupportingDocumentInstance

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

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

#url ⇒ String

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

def url
  @properties['url']
end