Class: Twilio::REST::Fax::V1::FaxContext::FaxMediaInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Fax::V1::FaxContext::FaxMediaInstance

Defined in:

lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the resource.

• #content_type ⇒ String

  The content type of the stored fax media.

• #context ⇒ FaxMediaContext

  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

  Deletes the FaxMediaInstance.

• #fax_sid ⇒ String

  The SID of the fax the FaxMedia resource is associated with.

• #fetch ⇒ FaxMediaInstance

  Fetch a FaxMediaInstance.

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

  Initialize the FaxMediaInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #sid ⇒ String

  The unique string that identifies the resource.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #url ⇒ String

  The absolute URL of the FaxMedia resource.

Constructor Details

#initialize(version, payload, fax_sid: nil, sid: nil) ⇒ FaxMediaInstance

Initialize the FaxMediaInstance

# File 'lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb', line 218

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'fax_sid' => payload['fax_sid'],
      'content_type' => payload['content_type'],
      '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 = {'fax_sid' => fax_sid, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb', line 256

def account_sid
  @properties['account_sid']
end

#content_type ⇒ String

# File 'lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb', line 268

def content_type
  @properties['content_type']
end

#context ⇒ FaxMediaContext

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/fax/v1/fax/fax_media.rb', line 241

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

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb', line 274

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# File 'lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb', line 280

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the FaxMediaInstance

# File 'lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb', line 300

def delete
  context.delete
end

#fax_sid ⇒ String

# File 'lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb', line 262

def fax_sid
  @properties['fax_sid']
end

#fetch ⇒ FaxMediaInstance

Fetch a FaxMediaInstance

# File 'lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb', line 293

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb', line 313

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

#sid ⇒ String

# File 'lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb', line 250

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb', line 306

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

#url ⇒ String

# File 'lib/twilio-ruby/rest/fax/v1/fax/fax_media.rb', line 286

def url
  @properties['url']
end