Class: GroupDocsSignatureCloud::UpdateOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_signature_cloud/models/update_options.rb

Overview

Base container class for update signature options

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 109

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.key?(:'SignatureType')
    self.signature_type = attributes[:'SignatureType']
  end

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

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

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

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

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

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

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

end

Instance Attribute Details

#height ⇒ Object

Specifies height of signature



50
51
52
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 50

def height
  @height
end

#is_signature ⇒ Object

Get or set flag to indicate if this component is Signature or document content. This property is being used with Update method to set element as signature (true) or document element (false).



53
54
55
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 53

def is_signature
  @is_signature
end

#left ⇒ Object

Specifies left position of signature



41
42
43
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 41

def left
  @left
end

#signature_id ⇒ Object

Unique signature identifier to modify signature in the document over Update or Delete methods. This property will be set automatically after Sign or Search method being called. If this property was saved before it can be set manually to manipulate the signature.



38
39
40
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 38

def signature_id
  @signature_id
end

#signature_type ⇒ Object

Specifies the type of signature



35
36
37
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 35

def signature_type
  @signature_type
end

#text ⇒ Object

The text to update text signature



56
57
58
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 56

def text
  @text
end

#top ⇒ Object

Specifies top position of signature



44
45
46
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 44

def top
  @top
end

#width ⇒ Object

Specifies width of signature



47
48
49
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 47

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 80

def self.attribute_map
  {
    :'signature_type' => :'SignatureType',
    :'signature_id' => :'SignatureId',
    :'left' => :'Left',
    :'top' => :'Top',
    :'width' => :'Width',
    :'height' => :'Height',
    :'is_signature' => :'IsSignature',
    :'text' => :'Text'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 94

def self.swagger_types
  {
    :'signature_type' => :'String',
    :'signature_id' => :'String',
    :'left' => :'Integer',
    :'top' => :'Integer',
    :'width' => :'Integer',
    :'height' => :'Integer',
    :'is_signature' => :'BOOLEAN',
    :'text' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 210

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      signature_type == other.signature_type &&
      signature_id == other.signature_id &&
      left == other.left &&
      top == other.top &&
      width == other.width &&
      height == other.height &&
      is_signature == other.is_signature &&
      text == other.text
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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 268

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Date.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
    # Signature type fix
    ttype = type
    if value.is_a?(Hash) and !value[:signatureType].nil?
      ttype = value[:signatureType] + 'Signature'
      if value[:signatureType] == 'FormField' and !value[:type].nil?
        type = value[:type]
        if type == 'Checkbox'
          ttype = 'CheckboxFormFieldSignature'
        end
        if type == 'Text'
          ttype = 'TextFormFieldSignature'
        end
        if type == 'Combobox'
          ttype = 'ComboboxFormFieldSignature'
        end
        if type == 'DigitalSignature'
          ttype = 'DigitalFormFieldSignature'
        end
        if type == 'Radio'
          ttype = 'RadioButtonFormFieldSignature'
        end
      end
    end      
    temp_model = GroupDocsSignatureCloud.const_get(ttype).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



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 358

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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 244

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    pname = uncap(self.class.attribute_map[key]).intern
    value = attributes[pname]
    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 value.is_a?(Array)
        self.send("#{key}=", value.map { |v| _deserialize($1, v) })
      end
    elsif !value.nil?                  
      self.send("#{key}=", _deserialize(type, value))
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


225
226
227
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 225

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



231
232
233
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 231

def hash
  [signature_type, signature_id, left, top, width, height, is_signature, text].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 151

def list_invalid_properties
  invalid_properties = []
  if @signature_type.nil?
    invalid_properties.push("invalid value for 'signature_type', signature_type cannot be nil.")
  end

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

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

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

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

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

  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



338
339
340
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 338

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



344
345
346
347
348
349
350
351
352
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 344

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



332
333
334
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 332

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



237
238
239
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 237

def uncap(str)
  str[0, 1].downcase + str[1..-1]
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/groupdocs_signature_cloud/models/update_options.rb', line 182

def valid?
  return false if @signature_type.nil?
  signature_type_validator = EnumAttributeValidator.new('String', ["None", "Text", "Image", "Digital", "Barcode", "QRCode", "Stamp", "FormField", "Metadata"])
  return false unless signature_type_validator.valid?(@signature_type)
  return false if @left.nil?
  return false if @top.nil?
  return false if @width.nil?
  return false if @height.nil?
  return false if @is_signature.nil?
  return true
end