Class: TestKaferiCloud::Signature
- Inherits:
-
Object
- Object
- TestKaferiCloud::Signature
- Defined in:
- lib/test_kaferi_cloud/models/signature.rb
Instance Attribute Summary collapse
-
#appearance ⇒ Object
Sets or gets a graphic appearance for the signature.
-
#authority ⇒ Object
Gets or sets the name of the person or authority signing the document..
-
#contact ⇒ Object
Gets or sets the contact of the signature.
-
#date ⇒ Object
Gets or sets the time of signing.
-
#form_field_name ⇒ Object
Gets or sets the name of the signature field.
-
#location ⇒ Object
Gets or sets the location of the signature.
-
#password ⇒ Object
Gets or sets the signature password.
-
#reason ⇒ Object
Gets or sets the reason of the signature.
-
#rectangle ⇒ Object
Gets or sets the visible rectangle of the signature.
-
#show_properties ⇒ Object
Gets or sets the showproperties in signature field.
-
#signature_path ⇒ Object
Gets or sets the signature path.
-
#signature_type ⇒ Object
Gets or sets the type of the signature.
-
#visible ⇒ Object
Gets or sets a value indicating whether this is visible.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Signature
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Signature
Initializes the object
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 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 107 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.has_key?(:'SignaturePath') self.signature_path = attributes[:'SignaturePath'] end if attributes.has_key?(:'SignatureType') self.signature_type = attributes[:'SignatureType'] end if attributes.has_key?(:'Password') self.password = attributes[:'Password'] end if attributes.has_key?(:'Appearance') self.appearance = attributes[:'Appearance'] end if attributes.has_key?(:'Reason') self.reason = attributes[:'Reason'] end if attributes.has_key?(:'Contact') self.contact = attributes[:'Contact'] end if attributes.has_key?(:'Location') self.location = attributes[:'Location'] end if attributes.has_key?(:'Visible') self.visible = attributes[:'Visible'] end if attributes.has_key?(:'Rectangle') self.rectangle = attributes[:'Rectangle'] end if attributes.has_key?(:'FormFieldName') self.form_field_name = attributes[:'FormFieldName'] end if attributes.has_key?(:'Authority') self. = attributes[:'Authority'] end if attributes.has_key?(:'Date') self.date = attributes[:'Date'] end if attributes.has_key?(:'ShowProperties') self.show_properties = attributes[:'ShowProperties'] end end |
Instance Attribute Details
#appearance ⇒ Object
Sets or gets a graphic appearance for the signature. Property value represents an image file name.
37 38 39 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 37 def appearance @appearance end |
#authority ⇒ Object
Gets or sets the name of the person or authority signing the document..
58 59 60 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 58 def @authority end |
#contact ⇒ Object
Gets or sets the contact of the signature.
43 44 45 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 43 def contact @contact end |
#date ⇒ Object
Gets or sets the time of signing.
61 62 63 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 61 def date @date end |
#form_field_name ⇒ Object
Gets or sets the name of the signature field. Supports only when signing document with particular form field.
55 56 57 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 55 def form_field_name @form_field_name end |
#location ⇒ Object
Gets or sets the location of the signature.
46 47 48 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 46 def location @location end |
#password ⇒ Object
Gets or sets the signature password.
34 35 36 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 34 def password @password end |
#reason ⇒ Object
Gets or sets the reason of the signature.
40 41 42 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 40 def reason @reason end |
#rectangle ⇒ Object
Gets or sets the visible rectangle of the signature. Supports only when signing particular page.
52 53 54 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 52 def rectangle @rectangle end |
#show_properties ⇒ Object
Gets or sets the showproperties in signature field
64 65 66 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 64 def show_properties @show_properties end |
#signature_path ⇒ Object
Gets or sets the signature path.
28 29 30 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 28 def signature_path @signature_path end |
#signature_type ⇒ Object
Gets or sets the type of the signature.
31 32 33 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 31 def signature_type @signature_type end |
#visible ⇒ Object
Gets or sets a value indicating whether this is visible. Supports only when signing particular page.
49 50 51 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 49 def visible @visible end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 68 def self.attribute_map { :'signature_path' => :'SignaturePath', :'signature_type' => :'SignatureType', :'password' => :'Password', :'appearance' => :'Appearance', :'reason' => :'Reason', :'contact' => :'Contact', :'location' => :'Location', :'visible' => :'Visible', :'rectangle' => :'Rectangle', :'form_field_name' => :'FormFieldName', :'authority' => :'Authority', :'date' => :'Date', :'show_properties' => :'ShowProperties' } end |
.swagger_types ⇒ Object
Attribute type mapping.
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 87 def self.swagger_types { :'signature_path' => :'String', :'signature_type' => :'SignatureType', :'password' => :'String', :'appearance' => :'String', :'reason' => :'String', :'contact' => :'String', :'location' => :'String', :'visible' => :'BOOLEAN', :'rectangle' => :'Rectangle', :'form_field_name' => :'String', :'authority' => :'String', :'date' => :'String', :'show_properties' => :'BOOLEAN' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 197 def ==(o) return true if self.equal?(o) self.class == o.class && signature_path == o.signature_path && signature_type == o.signature_type && password == o.password && appearance == o.appearance && reason == o.reason && contact == o.contact && location == o.location && visible == o.visible && rectangle == o.rectangle && form_field_name == o.form_field_name && == o. && date == o.date && show_properties == o.show_properties end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 251 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 temp_model = TestKaferiCloud.const_get(type).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
317 318 319 320 321 322 323 324 325 326 327 328 329 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 317 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
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 230 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| 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 attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
217 218 219 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 217 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
223 224 225 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 223 def hash [signature_path, signature_type, password, appearance, reason, contact, location, visible, rectangle, form_field_name, , date, show_properties].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 169 def list_invalid_properties invalid_properties = Array.new if @signature_type.nil? invalid_properties.push("invalid value for 'signature_type', signature_type cannot be nil.") end if @visible.nil? invalid_properties.push("invalid value for 'visible', visible cannot be nil.") end if @show_properties.nil? invalid_properties.push("invalid value for 'show_properties', show_properties cannot be nil.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
297 298 299 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 297 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
303 304 305 306 307 308 309 310 311 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 303 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
291 292 293 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 291 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
188 189 190 191 192 193 |
# File 'lib/test_kaferi_cloud/models/signature.rb', line 188 def valid? return false if @signature_type.nil? return false if @visible.nil? return false if @show_properties.nil? return true end |