Class: LogaltyCertificateIssuanceApiCerty::ValidationRule

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/logalty_certificate_issuance_api_certy/models/validation_rule.rb

Overview

ValidationRule Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(condition:, field_name:, value:, additional_properties: nil) ⇒ ValidationRule

Returns a new instance of ValidationRule.



43
44
45
46
47
48
49
50
51
 
# File 'lib/logalty_certificate_issuance_api_certy/models/validation_rule.rb', line 43

def initialize(condition:, field_name:, value:, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @condition = condition
  @field_name = field_name
  @value = value
  @additional_properties = additional_properties
end

Instance Attribute Details

#condition ⇒ ValidationCondition

Condition to apply when validating an OCR attribute.

Returns:



14
15
16
 
# File 'lib/logalty_certificate_issuance_api_certy/models/validation_rule.rb', line 14

def condition
  @condition
end

#field_name ⇒ ValidatableAttribute

OCR attribute name that can be used as a validation target.

Returns:



18
19
20
 
# File 'lib/logalty_certificate_issuance_api_certy/models/validation_rule.rb', line 18

def field_name
  @field_name
end

#value ⇒ String

Expected value. For lists, separate values with a comma (e.g. ‘BRA,PTR`).

Returns:

  • (String) 


22
23
24
 
# File 'lib/logalty_certificate_issuance_api_certy/models/validation_rule.rb', line 22

def value
  @value
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/logalty_certificate_issuance_api_certy/models/validation_rule.rb', line 54

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  condition = hash.key?('condition') ? hash['condition'] : nil
  field_name = hash.key?('fieldName') ? hash['fieldName'] : nil
  value = hash.key?('value') ? hash['value'] : nil

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  ValidationRule.new(condition: condition,
                     field_name: field_name,
                     value: value,
                     additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/logalty_certificate_issuance_api_certy/models/validation_rule.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['condition'] = 'condition'
  @_hash['field_name'] = 'fieldName'
  @_hash['value'] = 'value'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



39
40
41
 
# File 'lib/logalty_certificate_issuance_api_certy/models/validation_rule.rb', line 39

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
 
# File 'lib/logalty_certificate_issuance_api_certy/models/validation_rule.rb', line 34

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



84
85
86
87
88
 
# File 'lib/logalty_certificate_issuance_api_certy/models/validation_rule.rb', line 84

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} condition: #{@condition.inspect}, field_name: #{@field_name.inspect},"\
  " value: #{@value.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



77
78
79
80
81
 
# File 'lib/logalty_certificate_issuance_api_certy/models/validation_rule.rb', line 77

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} condition: #{@condition}, field_name: #{@field_name}, value: #{@value},"\
  " additional_properties: #{@additional_properties}>"
end