Class: Mailtrap::ContactExport

Inherits:

Struct

• Object
• Struct
• Mailtrap::ContactExport

Defined in:

lib/mailtrap/contact_export.rb

Overview

Data Transfer Object for Contact Export

Instance Attribute Summary

• #created_at ⇒ String readonly

  When the export was created.

• #id ⇒ Integer readonly

  The contact export ID.

• #status ⇒ String readonly

  The export status (created, started, finished).

• #updated_at ⇒ String readonly

  When the export was last updated.

• #url ⇒ String^? readonly

  URL of the exported file (only when status is “finished”).

Instance Attribute Details

#created_at ⇒ String (readonly)

When the export was created

Returns:

• (String) —

  the current value of created_at

# File 'lib/mailtrap/contact_export.rb', line 10

def created_at
  @created_at
end

#id ⇒ Integer (readonly)

The contact export ID

Returns:

• (Integer) —

  the current value of id

# File 'lib/mailtrap/contact_export.rb', line 10

def id
  @id
end

#status ⇒ String (readonly)

The export status (created, started, finished)

Returns:

• (String) —

  the current value of status

# File 'lib/mailtrap/contact_export.rb', line 10

def status
  @status
end

#updated_at ⇒ String (readonly)

When the export was last updated

Returns:

• (String) —

  the current value of updated_at

# File 'lib/mailtrap/contact_export.rb', line 10

def updated_at
  @updated_at
end

#url ⇒ String^? (readonly)

URL of the exported file (only when status is “finished”)

Returns:

• (String, nil) —

  the current value of url

# File 'lib/mailtrap/contact_export.rb', line 10

def url
  @url
end