Class: FactPulse::MandatoryNoteSchema

Inherits:
ApiModelBase show all
Defined in:
lib/factpulse/models/mandatory_note_schema.rb

Overview

Mandatory note detected with location and XML/PDF comparison.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ MandatoryNoteSchema

Initializes the object

Parameters:

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

    Model attributes in the form of hash



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 106

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::MandatoryNoteSchema` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `FactPulse::MandatoryNoteSchema`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'subject_code')
    self.subject_code = attributes[:'subject_code']
  else
    self.subject_code = nil
  end

  if attributes.key?(:'label')
    self.label = attributes[:'label']
  else
    self.label = nil
  end

  if attributes.key?(:'pdf_value')
    self.pdf_value = attributes[:'pdf_value']
  end

  if attributes.key?(:'xml_value')
    self.xml_value = attributes[:'xml_value']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'message')
    self.message = attributes[:'message']
  end

  if attributes.key?(:'bbox')
    self.bbox = attributes[:'bbox']
  end
end

Instance Attribute Details

#bbox ⇒ Object

Returns the value of attribute bbox.



34
35
36
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 34

def bbox
  @bbox
end

#label ⇒ Object

Label (e.g., Recovery indemnity)



23
24
25
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 23

def label
  @label
end

#message ⇒ Object

Returns the value of attribute message.



32
33
34
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 32

def message
  @message
end

#pdf_value ⇒ Object

Returns the value of attribute pdf_value.



25
26
27
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 25

def pdf_value
  @pdf_value
end

#status ⇒ Object

Compliance status (COMPLIANT if XML found in PDF)



30
31
32
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 30

def status
  @status
end

#subject_code ⇒ Object

Subject code (PMT, PMD, AAB)



20
21
22
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 20

def subject_code
  @subject_code
end

#xml_value ⇒ Object

Returns the value of attribute xml_value.



27
28
29
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 27

def xml_value
  @xml_value
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



72
73
74
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 72

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



77
78
79
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 77

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 59

def self.attribute_map
  {
    :'subject_code' => :'subjectCode',
    :'label' => :'label',
    :'pdf_value' => :'pdfValue',
    :'xml_value' => :'xmlValue',
    :'status' => :'status',
    :'message' => :'message',
    :'bbox' => :'bbox'
  }
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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 227

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



95
96
97
98
99
100
101
102
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 95

def self.openapi_nullable
  Set.new([
    :'pdf_value',
    :'xml_value',
    :'message',
    :'bbox'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 82

def self.openapi_types
  {
    :'subject_code' => :'String',
    :'label' => :'String',
    :'pdf_value' => :'String',
    :'xml_value' => :'String',
    :'status' => :'FieldStatus',
    :'message' => :'String',
    :'bbox' => :'BoundingBoxSchema'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      subject_code == o.subject_code &&
      label == o.label &&
      pdf_value == o.pdf_value &&
      xml_value == o.xml_value &&
      status == o.status &&
      message == o.message &&
      bbox == o.bbox
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


214
215
216
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 214

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



220
221
222
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 220

def hash
  [subject_code, label, pdf_value, xml_value, status, message, bbox].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



155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 155

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @subject_code.nil?
    invalid_properties.push('invalid value for "subject_code", subject_code cannot be nil.')
  end

  if @label.nil?
    invalid_properties.push('invalid value for "label", label cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 249

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



171
172
173
174
175
176
 
# File 'lib/factpulse/models/mandatory_note_schema.rb', line 171

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @subject_code.nil?
  return false if @label.nil?
  true
end