Class: DocuSign_eSign::UserSignature
- Inherits:
-
Object
- Object
- DocuSign_eSign::UserSignature
- Defined in:
- lib/docusign_esign/models/user_signature.rb
Instance Attribute Summary collapse
-
#adopted_date_time ⇒ Object
The date and time the user adopted their signature.
-
#created_date_time ⇒ Object
Indicates the date and time the item was created.
-
#custom_field ⇒ Object
Returns the value of attribute custom_field.
-
#date_stamp_properties ⇒ Object
Returns the value of attribute date_stamp_properties.
-
#disallow_user_resize_stamp ⇒ Object
Returns the value of attribute disallow_user_resize_stamp.
-
#error_details ⇒ Object
Returns the value of attribute error_details.
-
#external_id ⇒ Object
Returns the value of attribute external_id.
-
#image_base64 ⇒ Object
Returns the value of attribute image_base64.
-
#image_type ⇒ Object
Returns the value of attribute image_type.
-
#initials150_image_id ⇒ Object
Returns the value of attribute initials150_image_id.
-
#initials_image_uri ⇒ Object
Contains the URI for an endpoint that you can use to retrieve the initials image.
-
#is_default ⇒ Object
Returns the value of attribute is_default.
-
#last_modified_date_time ⇒ Object
The date and time the item was last modified.
-
#nrds_id ⇒ Object
Returns the value of attribute nrds_id.
-
#nrds_last_name ⇒ Object
Returns the value of attribute nrds_last_name.
-
#nrds_status ⇒ Object
Returns the value of attribute nrds_status.
-
#phonetic_name ⇒ Object
Returns the value of attribute phonetic_name.
-
#signature150_image_id ⇒ Object
Returns the value of attribute signature150_image_id.
-
#signature_font ⇒ Object
The font type for the signature, if the signature is not drawn.
-
#signature_id ⇒ Object
Specifies the signature ID associated with the signature name.
-
#signature_image_uri ⇒ Object
Contains the URI for an endpoint that you can use to retrieve the signature image.
-
#signature_initials ⇒ Object
The initials associated with the signature.
-
#signature_name ⇒ Object
Specifies the user signature name.
-
#signature_rights ⇒ Object
Returns the value of attribute signature_rights.
-
#signature_type ⇒ Object
Returns the value of attribute signature_type.
-
#stamp_format ⇒ Object
Returns the value of attribute stamp_format.
-
#stamp_image_uri ⇒ Object
Returns the value of attribute stamp_image_uri.
-
#stamp_size_mm ⇒ Object
Returns the value of attribute stamp_size_mm.
-
#stamp_type ⇒ Object
Returns the value of attribute stamp_type.
-
#status ⇒ Object
Indicates the envelope status.
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 = {}) ⇒ UserSignature
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 = {}) ⇒ UserSignature
Initializes the object
178 179 180 181 182 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 244 245 246 247 248 249 250 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 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 |
# File 'lib/docusign_esign/models/user_signature.rb', line 178 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?(:'adoptedDateTime') self.adopted_date_time = attributes[:'adoptedDateTime'] end if attributes.has_key?(:'createdDateTime') self.created_date_time = attributes[:'createdDateTime'] end if attributes.has_key?(:'customField') self.custom_field = attributes[:'customField'] end if attributes.has_key?(:'dateStampProperties') self.date_stamp_properties = attributes[:'dateStampProperties'] end if attributes.has_key?(:'disallowUserResizeStamp') self.disallow_user_resize_stamp = attributes[:'disallowUserResizeStamp'] end if attributes.has_key?(:'errorDetails') self.error_details = attributes[:'errorDetails'] end if attributes.has_key?(:'externalID') self.external_id = attributes[:'externalID'] end if attributes.has_key?(:'imageBase64') self.image_base64 = attributes[:'imageBase64'] end if attributes.has_key?(:'imageType') self.image_type = attributes[:'imageType'] end if attributes.has_key?(:'initials150ImageId') self.initials150_image_id = attributes[:'initials150ImageId'] end if attributes.has_key?(:'initialsImageUri') self.initials_image_uri = attributes[:'initialsImageUri'] end if attributes.has_key?(:'isDefault') self.is_default = attributes[:'isDefault'] end if attributes.has_key?(:'lastModifiedDateTime') self.last_modified_date_time = attributes[:'lastModifiedDateTime'] end if attributes.has_key?(:'nrdsId') self.nrds_id = attributes[:'nrdsId'] end if attributes.has_key?(:'nrdsLastName') self.nrds_last_name = attributes[:'nrdsLastName'] end if attributes.has_key?(:'nrdsStatus') self.nrds_status = attributes[:'nrdsStatus'] end if attributes.has_key?(:'phoneticName') self.phonetic_name = attributes[:'phoneticName'] end if attributes.has_key?(:'signature150ImageId') self.signature150_image_id = attributes[:'signature150ImageId'] end if attributes.has_key?(:'signatureFont') self.signature_font = attributes[:'signatureFont'] end if attributes.has_key?(:'signatureId') self.signature_id = attributes[:'signatureId'] end if attributes.has_key?(:'signatureImageUri') self.signature_image_uri = attributes[:'signatureImageUri'] end if attributes.has_key?(:'signatureInitials') self.signature_initials = attributes[:'signatureInitials'] end if attributes.has_key?(:'signatureName') self.signature_name = attributes[:'signatureName'] end if attributes.has_key?(:'signatureRights') self.signature_rights = attributes[:'signatureRights'] end if attributes.has_key?(:'signatureType') self.signature_type = attributes[:'signatureType'] end if attributes.has_key?(:'stampFormat') self.stamp_format = attributes[:'stampFormat'] end if attributes.has_key?(:'stampImageUri') self.stamp_image_uri = attributes[:'stampImageUri'] end if attributes.has_key?(:'stampSizeMM') self.stamp_size_mm = attributes[:'stampSizeMM'] end if attributes.has_key?(:'stampType') self.stamp_type = attributes[:'stampType'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end end |
Instance Attribute Details
#adopted_date_time ⇒ Object
The date and time the user adopted their signature.
17 18 19 |
# File 'lib/docusign_esign/models/user_signature.rb', line 17 def adopted_date_time @adopted_date_time end |
#created_date_time ⇒ Object
Indicates the date and time the item was created.
20 21 22 |
# File 'lib/docusign_esign/models/user_signature.rb', line 20 def created_date_time @created_date_time end |
#custom_field ⇒ Object
Returns the value of attribute custom_field.
23 24 25 |
# File 'lib/docusign_esign/models/user_signature.rb', line 23 def custom_field @custom_field end |
#date_stamp_properties ⇒ Object
Returns the value of attribute date_stamp_properties.
25 26 27 |
# File 'lib/docusign_esign/models/user_signature.rb', line 25 def date_stamp_properties @date_stamp_properties end |
#disallow_user_resize_stamp ⇒ Object
Returns the value of attribute disallow_user_resize_stamp.
28 29 30 |
# File 'lib/docusign_esign/models/user_signature.rb', line 28 def disallow_user_resize_stamp @disallow_user_resize_stamp end |
#error_details ⇒ Object
Returns the value of attribute error_details.
30 31 32 |
# File 'lib/docusign_esign/models/user_signature.rb', line 30 def error_details @error_details end |
#external_id ⇒ Object
Returns the value of attribute external_id.
33 34 35 |
# File 'lib/docusign_esign/models/user_signature.rb', line 33 def external_id @external_id end |
#image_base64 ⇒ Object
Returns the value of attribute image_base64.
36 37 38 |
# File 'lib/docusign_esign/models/user_signature.rb', line 36 def image_base64 @image_base64 end |
#image_type ⇒ Object
Returns the value of attribute image_type.
39 40 41 |
# File 'lib/docusign_esign/models/user_signature.rb', line 39 def image_type @image_type end |
#initials150_image_id ⇒ Object
Returns the value of attribute initials150_image_id.
42 43 44 |
# File 'lib/docusign_esign/models/user_signature.rb', line 42 def initials150_image_id @initials150_image_id end |
#initials_image_uri ⇒ Object
Contains the URI for an endpoint that you can use to retrieve the initials image.
45 46 47 |
# File 'lib/docusign_esign/models/user_signature.rb', line 45 def initials_image_uri @initials_image_uri end |
#is_default ⇒ Object
Returns the value of attribute is_default.
48 49 50 |
# File 'lib/docusign_esign/models/user_signature.rb', line 48 def is_default @is_default end |
#last_modified_date_time ⇒ Object
The date and time the item was last modified.
51 52 53 |
# File 'lib/docusign_esign/models/user_signature.rb', line 51 def last_modified_date_time @last_modified_date_time end |
#nrds_id ⇒ Object
Returns the value of attribute nrds_id.
54 55 56 |
# File 'lib/docusign_esign/models/user_signature.rb', line 54 def nrds_id @nrds_id end |
#nrds_last_name ⇒ Object
Returns the value of attribute nrds_last_name.
57 58 59 |
# File 'lib/docusign_esign/models/user_signature.rb', line 57 def nrds_last_name @nrds_last_name end |
#nrds_status ⇒ Object
Returns the value of attribute nrds_status.
60 61 62 |
# File 'lib/docusign_esign/models/user_signature.rb', line 60 def nrds_status @nrds_status end |
#phonetic_name ⇒ Object
Returns the value of attribute phonetic_name.
63 64 65 |
# File 'lib/docusign_esign/models/user_signature.rb', line 63 def phonetic_name @phonetic_name end |
#signature150_image_id ⇒ Object
Returns the value of attribute signature150_image_id.
66 67 68 |
# File 'lib/docusign_esign/models/user_signature.rb', line 66 def signature150_image_id @signature150_image_id end |
#signature_font ⇒ Object
The font type for the signature, if the signature is not drawn. The supported font types are: "7_DocuSign", "1_DocuSign", "6_DocuSign", "8_DocuSign", "3_DocuSign", "Mistral", "4_DocuSign", "2_DocuSign", "5_DocuSign", "Rage Italic"
69 70 71 |
# File 'lib/docusign_esign/models/user_signature.rb', line 69 def signature_font @signature_font end |
#signature_id ⇒ Object
Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the ‘signatureName` property in the body is used. This allows the use of special characters (such as "&", "<", ">") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID.
72 73 74 |
# File 'lib/docusign_esign/models/user_signature.rb', line 72 def signature_id @signature_id end |
#signature_image_uri ⇒ Object
Contains the URI for an endpoint that you can use to retrieve the signature image.
75 76 77 |
# File 'lib/docusign_esign/models/user_signature.rb', line 75 def signature_image_uri @signature_image_uri end |
#signature_initials ⇒ Object
The initials associated with the signature.
78 79 80 |
# File 'lib/docusign_esign/models/user_signature.rb', line 78 def signature_initials @signature_initials end |
#signature_name ⇒ Object
Specifies the user signature name.
81 82 83 |
# File 'lib/docusign_esign/models/user_signature.rb', line 81 def signature_name @signature_name end |
#signature_rights ⇒ Object
Returns the value of attribute signature_rights.
84 85 86 |
# File 'lib/docusign_esign/models/user_signature.rb', line 84 def signature_rights @signature_rights end |
#signature_type ⇒ Object
Returns the value of attribute signature_type.
87 88 89 |
# File 'lib/docusign_esign/models/user_signature.rb', line 87 def signature_type @signature_type end |
#stamp_format ⇒ Object
Returns the value of attribute stamp_format.
90 91 92 |
# File 'lib/docusign_esign/models/user_signature.rb', line 90 def stamp_format @stamp_format end |
#stamp_image_uri ⇒ Object
Returns the value of attribute stamp_image_uri.
93 94 95 |
# File 'lib/docusign_esign/models/user_signature.rb', line 93 def stamp_image_uri @stamp_image_uri end |
#stamp_size_mm ⇒ Object
Returns the value of attribute stamp_size_mm.
96 97 98 |
# File 'lib/docusign_esign/models/user_signature.rb', line 96 def stamp_size_mm @stamp_size_mm end |
#stamp_type ⇒ Object
Returns the value of attribute stamp_type.
99 100 101 |
# File 'lib/docusign_esign/models/user_signature.rb', line 99 def stamp_type @stamp_type end |
#status ⇒ Object
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
102 103 104 |
# File 'lib/docusign_esign/models/user_signature.rb', line 102 def status @status end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
105 106 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 |
# File 'lib/docusign_esign/models/user_signature.rb', line 105 def self.attribute_map { :'adopted_date_time' => :'adoptedDateTime', :'created_date_time' => :'createdDateTime', :'custom_field' => :'customField', :'date_stamp_properties' => :'dateStampProperties', :'disallow_user_resize_stamp' => :'disallowUserResizeStamp', :'error_details' => :'errorDetails', :'external_id' => :'externalID', :'image_base64' => :'imageBase64', :'image_type' => :'imageType', :'initials150_image_id' => :'initials150ImageId', :'initials_image_uri' => :'initialsImageUri', :'is_default' => :'isDefault', :'last_modified_date_time' => :'lastModifiedDateTime', :'nrds_id' => :'nrdsId', :'nrds_last_name' => :'nrdsLastName', :'nrds_status' => :'nrdsStatus', :'phonetic_name' => :'phoneticName', :'signature150_image_id' => :'signature150ImageId', :'signature_font' => :'signatureFont', :'signature_id' => :'signatureId', :'signature_image_uri' => :'signatureImageUri', :'signature_initials' => :'signatureInitials', :'signature_name' => :'signatureName', :'signature_rights' => :'signatureRights', :'signature_type' => :'signatureType', :'stamp_format' => :'stampFormat', :'stamp_image_uri' => :'stampImageUri', :'stamp_size_mm' => :'stampSizeMM', :'stamp_type' => :'stampType', :'status' => :'status' } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 166 167 168 169 170 171 172 173 174 |
# File 'lib/docusign_esign/models/user_signature.rb', line 141 def self.swagger_types { :'adopted_date_time' => :'String', :'created_date_time' => :'String', :'custom_field' => :'String', :'date_stamp_properties' => :'DateStampProperties', :'disallow_user_resize_stamp' => :'String', :'error_details' => :'ErrorDetails', :'external_id' => :'String', :'image_base64' => :'String', :'image_type' => :'String', :'initials150_image_id' => :'String', :'initials_image_uri' => :'String', :'is_default' => :'String', :'last_modified_date_time' => :'String', :'nrds_id' => :'String', :'nrds_last_name' => :'String', :'nrds_status' => :'String', :'phonetic_name' => :'String', :'signature150_image_id' => :'String', :'signature_font' => :'String', :'signature_id' => :'String', :'signature_image_uri' => :'String', :'signature_initials' => :'String', :'signature_name' => :'String', :'signature_rights' => :'String', :'signature_type' => :'String', :'stamp_format' => :'String', :'stamp_image_uri' => :'String', :'stamp_size_mm' => :'String', :'stamp_type' => :'String', :'status' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 |
# File 'lib/docusign_esign/models/user_signature.rb', line 320 def ==(o) return true if self.equal?(o) self.class == o.class && adopted_date_time == o.adopted_date_time && created_date_time == o.created_date_time && custom_field == o.custom_field && date_stamp_properties == o.date_stamp_properties && disallow_user_resize_stamp == o.disallow_user_resize_stamp && error_details == o.error_details && external_id == o.external_id && image_base64 == o.image_base64 && image_type == o.image_type && initials150_image_id == o.initials150_image_id && initials_image_uri == o.initials_image_uri && is_default == o.is_default && last_modified_date_time == o.last_modified_date_time && nrds_id == o.nrds_id && nrds_last_name == o.nrds_last_name && nrds_status == o.nrds_status && phonetic_name == o.phonetic_name && signature150_image_id == o.signature150_image_id && signature_font == o.signature_font && signature_id == o.signature_id && signature_image_uri == o.signature_image_uri && signature_initials == o.signature_initials && signature_name == o.signature_name && signature_rights == o.signature_rights && signature_type == o.signature_type && stamp_format == o.stamp_format && stamp_image_uri == o.stamp_image_uri && stamp_size_mm == o.stamp_size_mm && stamp_type == o.stamp_type && status == o.status end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 |
# File 'lib/docusign_esign/models/user_signature.rb', line 391 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 = DocuSign_eSign.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
457 458 459 460 461 462 463 464 465 466 467 468 469 |
# File 'lib/docusign_esign/models/user_signature.rb', line 457 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
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'lib/docusign_esign/models/user_signature.rb', line 370 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 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
357 358 359 |
# File 'lib/docusign_esign/models/user_signature.rb', line 357 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
363 364 365 |
# File 'lib/docusign_esign/models/user_signature.rb', line 363 def hash [adopted_date_time, created_date_time, custom_field, date_stamp_properties, disallow_user_resize_stamp, error_details, external_id, image_base64, image_type, initials150_image_id, initials_image_uri, is_default, last_modified_date_time, nrds_id, nrds_last_name, nrds_status, phonetic_name, signature150_image_id, signature_font, signature_id, signature_image_uri, signature_initials, signature_name, signature_rights, signature_type, stamp_format, stamp_image_uri, stamp_size_mm, stamp_type, status].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
307 308 309 310 |
# File 'lib/docusign_esign/models/user_signature.rb', line 307 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
437 438 439 |
# File 'lib/docusign_esign/models/user_signature.rb', line 437 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
443 444 445 446 447 448 449 450 451 |
# File 'lib/docusign_esign/models/user_signature.rb', line 443 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
431 432 433 |
# File 'lib/docusign_esign/models/user_signature.rb', line 431 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
314 315 316 |
# File 'lib/docusign_esign/models/user_signature.rb', line 314 def valid? true end |