Class: Intrinio::FilingNote

Inherits:
Object
  • Object
show all
Defined in:
lib/intrinio-sdk/models/filing_note.rb

Overview

A filing submitted to the SEC by a company

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FilingNote

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/intrinio-sdk/models/filing_note.rb', line 52

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'xbrl_tag')
    self.xbrl_tag = attributes[:'xbrl_tag']
  end

  if attributes.has_key?(:'content')
    self.content = attributes[:'content']
  end

  if attributes.has_key?(:'filing')
    self.filing = attributes[:'filing']
  end

end

Instance Attribute Details

#content ⇒ Object

The plain text (after html has been removed) of the note, or text including html if the content_format parameter has been set to html



25
26
27
 
# File 'lib/intrinio-sdk/models/filing_note.rb', line 25

def content
  @content
end

#filing ⇒ Object

Returns the value of attribute filing.



27
28
29
 
# File 'lib/intrinio-sdk/models/filing_note.rb', line 27

def filing
  @filing
end

#id ⇒ Object

The Intrinio ID of the note



19
20
21
 
# File 'lib/intrinio-sdk/models/filing_note.rb', line 19

def id
  @id
end

#xbrl_tag ⇒ Object

The XBRL Tag used for the note



22
23
24
 
# File 'lib/intrinio-sdk/models/filing_note.rb', line 22

def xbrl_tag
  @xbrl_tag
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



31
32
33
34
35
36
37
38
 
# File 'lib/intrinio-sdk/models/filing_note.rb', line 31

def self.attribute_map
  {
    :'id' => :'id',
    :'xbrl_tag' => :'xbrl_tag',
    :'content' => :'content',
    :'filing' => :'filing'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
 
# File 'lib/intrinio-sdk/models/filing_note.rb', line 41

def self.swagger_types
  {
    :'id' => :'String',
    :'xbrl_tag' => :'String',
    :'content' => :'String',
    :'filing' => :'FilingNoteFiling'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



91
92
93
94
95
96
97
98
 
# File 'lib/intrinio-sdk/models/filing_note.rb', line 91

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      xbrl_tag == o.xbrl_tag &&
      content == o.content &&
      filing == o.filing
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/intrinio-sdk/models/filing_note.rb', line 136

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = Intrinio.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/intrinio-sdk/models/filing_note.rb', line 202

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/intrinio-sdk/models/filing_note.rb', line 115

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


102
103
104
 
# File 'lib/intrinio-sdk/models/filing_note.rb', line 102

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



108
109
110
 
# File 'lib/intrinio-sdk/models/filing_note.rb', line 108

def hash
  [id, xbrl_tag, content, filing].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



78
79
80
81
 
# File 'lib/intrinio-sdk/models/filing_note.rb', line 78

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



182
183
184
 
# File 'lib/intrinio-sdk/models/filing_note.rb', line 182

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



188
189
190
191
192
193
194
195
196
 
# File 'lib/intrinio-sdk/models/filing_note.rb', line 188

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



176
177
178
 
# File 'lib/intrinio-sdk/models/filing_note.rb', line 176

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



85
86
87
 
# File 'lib/intrinio-sdk/models/filing_note.rb', line 85

def valid?
  return true
end