Class: FactPulse::SignatureInfoAPI

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

Overview

Information about an electronic signature in a PDF.

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 = {}) ⇒ SignatureInfoAPI

Initializes the object

Parameters:

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

    Model attributes in the form of hash



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/factpulse/models/signature_info_api.rb', line 79

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::SignatureInfoAPI` 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::SignatureInfoAPI`. 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?(:'field_name')
    self.field_name = attributes[:'field_name']
  else
    self.field_name = nil
  end

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

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

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

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

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

Instance Attribute Details

#field_name ⇒ Object

Signature field name in the PDF



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

def field_name
  @field_name
end

#is_valid ⇒ Object

Returns the value of attribute is_valid.



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

def is_valid
  @is_valid
end

#location ⇒ Object

Returns the value of attribute location.



28
29
30
 
# File 'lib/factpulse/models/signature_info_api.rb', line 28

def location
  @location
end

#reason ⇒ Object

Returns the value of attribute reason.



26
27
28
 
# File 'lib/factpulse/models/signature_info_api.rb', line 26

def reason
  @reason
end

#signer ⇒ Object

Returns the value of attribute signer.



22
23
24
 
# File 'lib/factpulse/models/signature_info_api.rb', line 22

def signer
  @signer
end

#signing_date ⇒ Object

Returns the value of attribute signing_date.



24
25
26
 
# File 'lib/factpulse/models/signature_info_api.rb', line 24

def signing_date
  @signing_date
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



45
46
47
 
# File 'lib/factpulse/models/signature_info_api.rb', line 45

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



50
51
52
 
# File 'lib/factpulse/models/signature_info_api.rb', line 50

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/factpulse/models/signature_info_api.rb', line 33

def self.attribute_map
  {
    :'field_name' => :'fieldName',
    :'signer' => :'signer',
    :'signing_date' => :'signingDate',
    :'reason' => :'reason',
    :'location' => :'location',
    :'is_valid' => :'isValid'
  }
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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/factpulse/models/signature_info_api.rb', line 178

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



67
68
69
70
71
72
73
74
75
 
# File 'lib/factpulse/models/signature_info_api.rb', line 67

def self.openapi_nullable
  Set.new([
    :'signer',
    :'signing_date',
    :'reason',
    :'location',
    :'is_valid'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/factpulse/models/signature_info_api.rb', line 55

def self.openapi_types
  {
    :'field_name' => :'String',
    :'signer' => :'String',
    :'signing_date' => :'String',
    :'reason' => :'String',
    :'location' => :'String',
    :'is_valid' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



152
153
154
155
156
157
158
159
160
161
 
# File 'lib/factpulse/models/signature_info_api.rb', line 152

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      field_name == o.field_name &&
      signer == o.signer &&
      signing_date == o.signing_date &&
      reason == o.reason &&
      location == o.location &&
      is_valid == o.is_valid
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


165
166
167
 
# File 'lib/factpulse/models/signature_info_api.rb', line 165

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



171
172
173
 
# File 'lib/factpulse/models/signature_info_api.rb', line 171

def hash
  [field_name, signer, signing_date, reason, location, is_valid].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



122
123
124
125
126
127
128
129
130
 
# File 'lib/factpulse/models/signature_info_api.rb', line 122

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @field_name.nil?
    invalid_properties.push('invalid value for "field_name", field_name 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



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

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



134
135
136
137
138
 
# File 'lib/factpulse/models/signature_info_api.rb', line 134

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