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



96
97
98
99
100
101
102
103
104
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/docusign_esign/models/user_signature.rb', line 96

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?(:'errorDetails')
    self.error_details = attributes[:'errorDetails']
  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?(:'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

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

#error_details ⇒ Object

Returns the value of attribute error_details.



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

def error_details
  @error_details
end

#initials150_image_id ⇒ Object

Returns the value of attribute initials150_image_id.



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

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.



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

def initials_image_uri
  @initials_image_uri
end

#is_default ⇒ Object

Returns the value of attribute is_default.



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

def is_default
  @is_default
end

#signature150_image_id ⇒ Object

Returns the value of attribute signature150_image_id.



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

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"



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

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.



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

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.



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

def signature_image_uri
  @signature_image_uri
end

#signature_initials ⇒ Object

The initials associated with the signature.



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

def signature_initials
  @signature_initials
end

#signature_name ⇒ Object

Specifies the user signature name.



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

def signature_name
  @signature_name
end

#signature_type ⇒ Object

Returns the value of attribute signature_type.



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

def signature_type
  @signature_type
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/docusign_esign/models/user_signature.rb', line 57

def self.attribute_map
  {
    :'adopted_date_time' => :'adoptedDateTime',
    :'created_date_time' => :'createdDateTime',
    :'error_details' => :'errorDetails',
    :'initials150_image_id' => :'initials150ImageId',
    :'initials_image_uri' => :'initialsImageUri',
    :'is_default' => :'isDefault',
    :'signature150_image_id' => :'signature150ImageId',
    :'signature_font' => :'signatureFont',
    :'signature_id' => :'signatureId',
    :'signature_image_uri' => :'signatureImageUri',
    :'signature_initials' => :'signatureInitials',
    :'signature_name' => :'signatureName',
    :'signature_type' => :'signatureType'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/docusign_esign/models/user_signature.rb', line 76

def self.swagger_types
  {
    :'adopted_date_time' => :'String',
    :'created_date_time' => :'String',
    :'error_details' => :'ErrorDetails',
    :'initials150_image_id' => :'String',
    :'initials_image_uri' => :'String',
    :'is_default' => :'String',
    :'signature150_image_id' => :'String',
    :'signature_font' => :'String',
    :'signature_id' => :'String',
    :'signature_image_uri' => :'String',
    :'signature_initials' => :'String',
    :'signature_name' => :'String',
    :'signature_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/docusign_esign/models/user_signature.rb', line 171

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



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

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



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/docusign_esign/models/user_signature.rb', line 291

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/docusign_esign/models/user_signature.rb', line 204

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


191
192
193
 
# File 'lib/docusign_esign/models/user_signature.rb', line 191

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



197
198
199
 
# File 'lib/docusign_esign/models/user_signature.rb', line 197

def hash
  [adopted_date_time, created_date_time, error_details, initials150_image_id, initials_image_uri, is_default, signature150_image_id, signature_font, signature_id, signature_image_uri, signature_initials, signature_name, signature_type].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



158
159
160
161
 
# File 'lib/docusign_esign/models/user_signature.rb', line 158

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



271
272
273
 
# File 'lib/docusign_esign/models/user_signature.rb', line 271

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



277
278
279
280
281
282
283
284
285
 
# File 'lib/docusign_esign/models/user_signature.rb', line 277

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



265
266
267
 
# File 'lib/docusign_esign/models/user_signature.rb', line 265

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



165
166
167
 
# File 'lib/docusign_esign/models/user_signature.rb', line 165

def valid?
  return true
end