Class: DocuSign_eSign::UserSignature

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/user_signature.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserSignature

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/docusign_esign/models/user_signature.rb', line 134

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

Instance Attribute Details

#adopted_date_time ⇒ Object

The date and time the user adopted their signature.



18
19
20
 
# File 'lib/docusign_esign/models/user_signature.rb', line 18

def adopted_date_time
  @adopted_date_time
end

#created_date_time ⇒ Object

Indicates the date and time the item was created.



21
22
23
 
# File 'lib/docusign_esign/models/user_signature.rb', line 21

def created_date_time
  @created_date_time
end

#date_stamp_properties ⇒ Object

Returns the value of attribute date_stamp_properties.



23
24
25
 
# File 'lib/docusign_esign/models/user_signature.rb', line 23

def date_stamp_properties
  @date_stamp_properties
end

#error_details ⇒ Object

Returns the value of attribute error_details.



25
26
27
 
# File 'lib/docusign_esign/models/user_signature.rb', line 25

def error_details
  @error_details
end

#external_id ⇒ Object

Returns the value of attribute external_id.



28
29
30
 
# File 'lib/docusign_esign/models/user_signature.rb', line 28

def external_id
  @external_id
end

#image_type ⇒ Object

Returns the value of attribute image_type.



31
32
33
 
# File 'lib/docusign_esign/models/user_signature.rb', line 31

def image_type
  @image_type
end

#initials150_image_id ⇒ Object

Returns the value of attribute initials150_image_id.



34
35
36
 
# File 'lib/docusign_esign/models/user_signature.rb', line 34

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.



37
38
39
 
# File 'lib/docusign_esign/models/user_signature.rb', line 37

def initials_image_uri
  @initials_image_uri
end

#is_default ⇒ Object

Returns the value of attribute is_default.



40
41
42
 
# File 'lib/docusign_esign/models/user_signature.rb', line 40

def is_default
  @is_default
end

#phonetic_name ⇒ Object

Returns the value of attribute phonetic_name.



43
44
45
 
# File 'lib/docusign_esign/models/user_signature.rb', line 43

def phonetic_name
  @phonetic_name
end

#signature150_image_id ⇒ Object

Returns the value of attribute signature150_image_id.



46
47
48
 
# File 'lib/docusign_esign/models/user_signature.rb', line 46

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"



49
50
51
 
# File 'lib/docusign_esign/models/user_signature.rb', line 49

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.



52
53
54
 
# File 'lib/docusign_esign/models/user_signature.rb', line 52

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.



55
56
57
 
# File 'lib/docusign_esign/models/user_signature.rb', line 55

def signature_image_uri
  @signature_image_uri
end

#signature_initials ⇒ Object

The initials associated with the signature.



58
59
60
 
# File 'lib/docusign_esign/models/user_signature.rb', line 58

def signature_initials
  @signature_initials
end

#signature_name ⇒ Object

Specifies the user signature name.



61
62
63
 
# File 'lib/docusign_esign/models/user_signature.rb', line 61

def signature_name
  @signature_name
end

#signature_type ⇒ Object

Returns the value of attribute signature_type.



64
65
66
 
# File 'lib/docusign_esign/models/user_signature.rb', line 64

def signature_type
  @signature_type
end

#stamp_format ⇒ Object

Returns the value of attribute stamp_format.



67
68
69
 
# File 'lib/docusign_esign/models/user_signature.rb', line 67

def stamp_format
  @stamp_format
end

#stamp_image_uri ⇒ Object

Returns the value of attribute stamp_image_uri.



70
71
72
 
# File 'lib/docusign_esign/models/user_signature.rb', line 70

def stamp_image_uri
  @stamp_image_uri
end

#stamp_size_mm ⇒ Object

Returns the value of attribute stamp_size_mm.



73
74
75
 
# File 'lib/docusign_esign/models/user_signature.rb', line 73

def stamp_size_mm
  @stamp_size_mm
end

#stamp_type ⇒ Object

Returns the value of attribute stamp_type.



76
77
78
 
# File 'lib/docusign_esign/models/user_signature.rb', line 76

def stamp_type
  @stamp_type
end

Class Method Details

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/docusign_esign/models/user_signature.rb', line 79

def self.attribute_map
  {
    :'adopted_date_time' => :'adoptedDateTime',
    :'created_date_time' => :'createdDateTime',
    :'date_stamp_properties' => :'dateStampProperties',
    :'error_details' => :'errorDetails',
    :'external_id' => :'externalID',
    :'image_type' => :'imageType',
    :'initials150_image_id' => :'initials150ImageId',
    :'initials_image_uri' => :'initialsImageUri',
    :'is_default' => :'isDefault',
    :'phonetic_name' => :'phoneticName',
    :'signature150_image_id' => :'signature150ImageId',
    :'signature_font' => :'signatureFont',
    :'signature_id' => :'signatureId',
    :'signature_image_uri' => :'signatureImageUri',
    :'signature_initials' => :'signatureInitials',
    :'signature_name' => :'signatureName',
    :'signature_type' => :'signatureType',
    :'stamp_format' => :'stampFormat',
    :'stamp_image_uri' => :'stampImageUri',
    :'stamp_size_mm' => :'stampSizeMM',
    :'stamp_type' => :'stampType'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/docusign_esign/models/user_signature.rb', line 106

def self.swagger_types
  {
    :'adopted_date_time' => :'String',
    :'created_date_time' => :'String',
    :'date_stamp_properties' => :'DateStampProperties',
    :'error_details' => :'ErrorDetails',
    :'external_id' => :'String',
    :'image_type' => :'String',
    :'initials150_image_id' => :'String',
    :'initials_image_uri' => :'String',
    :'is_default' => :'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_type' => :'String',
    :'stamp_format' => :'String',
    :'stamp_image_uri' => :'String',
    :'stamp_size_mm' => :'String',
    :'stamp_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/docusign_esign/models/user_signature.rb', line 240

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 &&
      date_stamp_properties == o.date_stamp_properties &&
      error_details == o.error_details &&
      external_id == o.external_id &&
      image_type == o.image_type &&
      initials150_image_id == o.initials150_image_id &&
      initials_image_uri == o.initials_image_uri &&
      is_default == o.is_default &&
      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_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
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



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
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/docusign_esign/models/user_signature.rb', line 302

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/docusign_esign/models/user_signature.rb', line 368

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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/docusign_esign/models/user_signature.rb', line 281

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


268
269
270
 
# File 'lib/docusign_esign/models/user_signature.rb', line 268

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



274
275
276
 
# File 'lib/docusign_esign/models/user_signature.rb', line 274

def hash
  [adopted_date_time, created_date_time, date_stamp_properties, error_details, external_id, image_type, initials150_image_id, initials_image_uri, is_default, phonetic_name, signature150_image_id, signature_font, signature_id, signature_image_uri, signature_initials, signature_name, signature_type, stamp_format, stamp_image_uri, stamp_size_mm, stamp_type].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



227
228
229
230
 
# File 'lib/docusign_esign/models/user_signature.rb', line 227

def list_invalid_properties
  invalid_properties = Array.new
  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



348
349
350
 
# File 'lib/docusign_esign/models/user_signature.rb', line 348

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



354
355
356
357
358
359
360
361
362
 
# File 'lib/docusign_esign/models/user_signature.rb', line 354

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



342
343
344
 
# File 'lib/docusign_esign/models/user_signature.rb', line 342

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



234
235
236
 
# File 'lib/docusign_esign/models/user_signature.rb', line 234

def valid?
  true
end