Class: DocuSign_eSign::UserSignatureDefinition

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserSignatureDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
155
156
157
158
159
160
161
# File 'lib/docusign_esign/models/user_signature_definition.rb', line 100

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

  if attributes.has_key?(:'imageType')
    self.image_type = attributes[:'imageType']
  end

  if attributes.has_key?(:'isDefault')
    self.is_default = attributes[:'isDefault']
  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?(:'phoneticName')
    self.phonetic_name = attributes[:'phoneticName']
  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?(:'signatureInitials')
    self.signature_initials = attributes[:'signatureInitials']
  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?(:'stampSizeMM')
    self.stamp_size_mm = attributes[:'stampSizeMM']
  end
end

Instance Attribute Details

#date_stamp_propertiesObject

Returns the value of attribute date_stamp_properties


17
18
19
# File 'lib/docusign_esign/models/user_signature_definition.rb', line 17

def date_stamp_properties
  @date_stamp_properties
end

#disallow_user_resize_stampObject

Returns the value of attribute disallow_user_resize_stamp


20
21
22
# File 'lib/docusign_esign/models/user_signature_definition.rb', line 20

def disallow_user_resize_stamp
  @disallow_user_resize_stamp
end

#external_idObject

Returns the value of attribute external_id


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

def external_id
  @external_id
end

#image_typeObject

Returns the value of attribute image_type


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

def image_type
  @image_type
end

#is_defaultObject

Returns the value of attribute is_default


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

def is_default
  @is_default
end

#nrds_idObject

Returns the value of attribute nrds_id


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

def nrds_id
  @nrds_id
end

#nrds_last_nameObject

Returns the value of attribute nrds_last_name


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

def nrds_last_name
  @nrds_last_name
end

#phonetic_nameObject

Returns the value of attribute phonetic_name


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

def phonetic_name
  @phonetic_name
end

#signature_fontObject

Returns the value of attribute signature_font


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

def signature_font
  @signature_font
end

#signature_idObject

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.


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

def signature_id
  @signature_id
end

#signature_initialsObject

Returns the value of attribute signature_initials


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

def signature_initials
  @signature_initials
end

#signature_nameObject

Specifies the user signature name.


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

def signature_name
  @signature_name
end

#stamp_formatObject

Returns the value of attribute stamp_format


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

def stamp_format
  @stamp_format
end

#stamp_size_mmObject

Returns the value of attribute stamp_size_mm


56
57
58
# File 'lib/docusign_esign/models/user_signature_definition.rb', line 56

def stamp_size_mm
  @stamp_size_mm
end

Class Method Details

.attribute_mapObject

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


59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/docusign_esign/models/user_signature_definition.rb', line 59

def self.attribute_map
  {
    :'date_stamp_properties' => :'dateStampProperties',
    :'disallow_user_resize_stamp' => :'disallowUserResizeStamp',
    :'external_id' => :'externalID',
    :'image_type' => :'imageType',
    :'is_default' => :'isDefault',
    :'nrds_id' => :'nrdsId',
    :'nrds_last_name' => :'nrdsLastName',
    :'phonetic_name' => :'phoneticName',
    :'signature_font' => :'signatureFont',
    :'signature_id' => :'signatureId',
    :'signature_initials' => :'signatureInitials',
    :'signature_name' => :'signatureName',
    :'stamp_format' => :'stampFormat',
    :'stamp_size_mm' => :'stampSizeMM'
  }
end

.swagger_typesObject

Attribute type mapping.


79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/docusign_esign/models/user_signature_definition.rb', line 79

def self.swagger_types
  {
    :'date_stamp_properties' => :'DateStampProperties',
    :'disallow_user_resize_stamp' => :'String',
    :'external_id' => :'String',
    :'image_type' => :'String',
    :'is_default' => :'String',
    :'nrds_id' => :'String',
    :'nrds_last_name' => :'String',
    :'phonetic_name' => :'String',
    :'signature_font' => :'String',
    :'signature_id' => :'String',
    :'signature_initials' => :'String',
    :'signature_name' => :'String',
    :'stamp_format' => :'String',
    :'stamp_size_mm' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# File 'lib/docusign_esign/models/user_signature_definition.rb', line 178

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date_stamp_properties == o.date_stamp_properties &&
      disallow_user_resize_stamp == o.disallow_user_resize_stamp &&
      external_id == o.external_id &&
      image_type == o.image_type &&
      is_default == o.is_default &&
      nrds_id == o.nrds_id &&
      nrds_last_name == o.nrds_last_name &&
      phonetic_name == o.phonetic_name &&
      signature_font == o.signature_font &&
      signature_id == o.signature_id &&
      signature_initials == o.signature_initials &&
      signature_name == o.signature_name &&
      stamp_format == o.stamp_format &&
      stamp_size_mm == o.stamp_size_mm
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


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

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


299
300
301
302
303
304
305
306
307
308
309
310
311
# File 'lib/docusign_esign/models/user_signature_definition.rb', line 299

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


212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'lib/docusign_esign/models/user_signature_definition.rb', line 212

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

199
200
201
# File 'lib/docusign_esign/models/user_signature_definition.rb', line 199

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


205
206
207
# File 'lib/docusign_esign/models/user_signature_definition.rb', line 205

def hash
  [date_stamp_properties, disallow_user_resize_stamp, external_id, image_type, is_default, nrds_id, nrds_last_name, phonetic_name, signature_font, signature_id, signature_initials, signature_name, stamp_format, stamp_size_mm].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


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

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


279
280
281
# File 'lib/docusign_esign/models/user_signature_definition.rb', line 279

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


285
286
287
288
289
290
291
292
293
# File 'lib/docusign_esign/models/user_signature_definition.rb', line 285

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


273
274
275
# File 'lib/docusign_esign/models/user_signature_definition.rb', line 273

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


172
173
174
# File 'lib/docusign_esign/models/user_signature_definition.rb', line 172

def valid?
  true
end