Class: GroupDocsSignatureCloud::DeleteOptions

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

Overview

Base container class for delete signature options

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DeleteOptions

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

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

end

Instance Attribute Details

#signature_idObject

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/delete_options.rb', line 38

def signature_id
  @signature_id
end

#signature_typeObject

Specifies the type of signature



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

def signature_type
  @signature_type
end

Class Method Details

.attribute_mapObject

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



62
63
64
65
66
67
# File 'lib/groupdocs_signature_cloud/models/delete_options.rb', line 62

def self.attribute_map
  {
    :'signature_type' => :'SignatureType',
    :'signature_id' => :'SignatureId'
  }
end

.swagger_typesObject

Attribute type mapping.



70
71
72
73
74
75
# File 'lib/groupdocs_signature_cloud/models/delete_options.rb', line 70

def self.swagger_types
  {
    :'signature_type' => :'String',
    :'signature_id' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



131
132
133
134
135
136
# File 'lib/groupdocs_signature_cloud/models/delete_options.rb', line 131

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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'lib/groupdocs_signature_cloud/models/delete_options.rb', line 183

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



273
274
275
276
277
278
279
280
281
282
283
284
285
# File 'lib/groupdocs_signature_cloud/models/delete_options.rb', line 273

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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# File 'lib/groupdocs_signature_cloud/models/delete_options.rb', line 159

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


140
141
142
# File 'lib/groupdocs_signature_cloud/models/delete_options.rb', line 140

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



146
147
148
# File 'lib/groupdocs_signature_cloud/models/delete_options.rb', line 146

def hash
  [signature_type, signature_id].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properies with the reasons



97
98
99
100
101
102
103
104
# File 'lib/groupdocs_signature_cloud/models/delete_options.rb', line 97

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

  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



253
254
255
# File 'lib/groupdocs_signature_cloud/models/delete_options.rb', line 253

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



259
260
261
262
263
264
265
266
267
# File 'lib/groupdocs_signature_cloud/models/delete_options.rb', line 259

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



247
248
249
# File 'lib/groupdocs_signature_cloud/models/delete_options.rb', line 247

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



152
153
154
# File 'lib/groupdocs_signature_cloud/models/delete_options.rb', line 152

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



108
109
110
111
112
113
# File 'lib/groupdocs_signature_cloud/models/delete_options.rb', line 108

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 true
end