Class: DocuSign_eSign::Stamp
- Inherits:
-
Object
- Object
- DocuSign_eSign::Stamp
- Defined in:
- lib/docusign_esign/models/stamp.rb
Instance Attribute Summary collapse
-
#adopted_date_time ⇒ Object
Returns the value of attribute adopted_date_time.
-
#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.
-
#last_modified_date_time ⇒ Object
The date and time the item was last modified.
-
#phonetic_name ⇒ Object
Returns the value of attribute phonetic_name.
-
#signature_name ⇒ Object
Specifies the user signature name.
-
#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.
-
#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 = {}) ⇒ Stamp
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 = {}) ⇒ Stamp
Initializes the object
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 166 167 168 169 170 171 172 173 174 175 176 177 |
# File 'lib/docusign_esign/models/stamp.rb', line 108 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?(:'lastModifiedDateTime') self.last_modified_date_time = attributes[:'lastModifiedDateTime'] end if attributes.has_key?(:'phoneticName') self.phonetic_name = attributes[:'phoneticName'] end if attributes.has_key?(:'signatureName') self.signature_name = attributes[:'signatureName'] 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?(:'status') self.status = attributes[:'status'] end end |
Instance Attribute Details
#adopted_date_time ⇒ Object
Returns the value of attribute adopted_date_time.
17 18 19 |
# File 'lib/docusign_esign/models/stamp.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/stamp.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/stamp.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/stamp.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/stamp.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/stamp.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/stamp.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/stamp.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/stamp.rb', line 39 def image_type @image_type end |
#last_modified_date_time ⇒ Object
The date and time the item was last modified.
42 43 44 |
# File 'lib/docusign_esign/models/stamp.rb', line 42 def last_modified_date_time @last_modified_date_time end |
#phonetic_name ⇒ Object
Returns the value of attribute phonetic_name.
45 46 47 |
# File 'lib/docusign_esign/models/stamp.rb', line 45 def phonetic_name @phonetic_name end |
#signature_name ⇒ Object
Specifies the user signature name.
48 49 50 |
# File 'lib/docusign_esign/models/stamp.rb', line 48 def signature_name @signature_name end |
#stamp_format ⇒ Object
Returns the value of attribute stamp_format.
51 52 53 |
# File 'lib/docusign_esign/models/stamp.rb', line 51 def stamp_format @stamp_format end |
#stamp_image_uri ⇒ Object
Returns the value of attribute stamp_image_uri.
54 55 56 |
# File 'lib/docusign_esign/models/stamp.rb', line 54 def stamp_image_uri @stamp_image_uri end |
#stamp_size_mm ⇒ Object
Returns the value of attribute stamp_size_mm.
57 58 59 |
# File 'lib/docusign_esign/models/stamp.rb', line 57 def stamp_size_mm @stamp_size_mm 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.
60 61 62 |
# File 'lib/docusign_esign/models/stamp.rb', line 60 def status @status end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/docusign_esign/models/stamp.rb', line 63 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', :'last_modified_date_time' => :'lastModifiedDateTime', :'phonetic_name' => :'phoneticName', :'signature_name' => :'signatureName', :'stamp_format' => :'stampFormat', :'stamp_image_uri' => :'stampImageUri', :'stamp_size_mm' => :'stampSizeMM', :'status' => :'status' } end |
.swagger_types ⇒ Object
Attribute type mapping.
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
# File 'lib/docusign_esign/models/stamp.rb', line 85 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', :'last_modified_date_time' => :'String', :'phonetic_name' => :'String', :'signature_name' => :'String', :'stamp_format' => :'String', :'stamp_image_uri' => :'String', :'stamp_size_mm' => :'String', :'status' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 |
# File 'lib/docusign_esign/models/stamp.rb', line 194 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 && last_modified_date_time == o.last_modified_date_time && phonetic_name == o.phonetic_name && signature_name == o.signature_name && stamp_format == o.stamp_format && stamp_image_uri == o.stamp_image_uri && stamp_size_mm == o.stamp_size_mm && status == o.status 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/docusign_esign/models/stamp.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 = 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
317 318 319 320 321 322 323 324 325 326 327 328 329 |
# File 'lib/docusign_esign/models/stamp.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/docusign_esign/models/stamp.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 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/docusign_esign/models/stamp.rb', line 217 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
223 224 225 |
# File 'lib/docusign_esign/models/stamp.rb', line 223 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, last_modified_date_time, phonetic_name, signature_name, stamp_format, stamp_image_uri, stamp_size_mm, status].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
181 182 183 184 |
# File 'lib/docusign_esign/models/stamp.rb', line 181 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
297 298 299 |
# File 'lib/docusign_esign/models/stamp.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/docusign_esign/models/stamp.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/docusign_esign/models/stamp.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 |
# File 'lib/docusign_esign/models/stamp.rb', line 188 def valid? true end |