Class: DocuSign_eSign::Stamp

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Stamp

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
178
# File 'lib/docusign_esign/models/stamp.rb', line 109

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_timeObject

Returns the value of attribute adopted_date_time


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

def adopted_date_time
  @adopted_date_time
end

#created_date_timeObject

Indicates the date and time the item was created.


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

def created_date_time
  @created_date_time
end

#custom_fieldObject

Returns the value of attribute custom_field


24
25
26
# File 'lib/docusign_esign/models/stamp.rb', line 24

def custom_field
  @custom_field
end

#date_stamp_propertiesObject

Returns the value of attribute date_stamp_properties


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

def date_stamp_properties
  @date_stamp_properties
end

#disallow_user_resize_stampObject

Returns the value of attribute disallow_user_resize_stamp


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

def disallow_user_resize_stamp
  @disallow_user_resize_stamp
end

#error_detailsObject

Returns the value of attribute error_details


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

def error_details
  @error_details
end

#external_idObject

Returns the value of attribute external_id


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

def external_id
  @external_id
end

#image_base64Object

Returns the value of attribute image_base64


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

def image_base64
  @image_base64
end

#image_typeObject

Returns the value of attribute image_type


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

def image_type
  @image_type
end

#last_modified_date_timeObject

The date and time the item was last modified.


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

def last_modified_date_time
  @last_modified_date_time
end

#phonetic_nameObject

Returns the value of attribute phonetic_name


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

def phonetic_name
  @phonetic_name
end

#signature_nameObject

Specifies the user signature name.


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

def signature_name
  @signature_name
end

#stamp_formatObject

Returns the value of attribute stamp_format


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

def stamp_format
  @stamp_format
end

#stamp_image_uriObject

Returns the value of attribute stamp_image_uri


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

def stamp_image_uri
  @stamp_image_uri
end

#stamp_size_mmObject

Returns the value of attribute stamp_size_mm


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

def stamp_size_mm
  @stamp_size_mm
end

#statusObject

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.


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

def status
  @status
end

Class Method Details

.attribute_mapObject

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


64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/docusign_esign/models/stamp.rb', line 64

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_typesObject

Attribute type mapping.


86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# File 'lib/docusign_esign/models/stamp.rb', line 86

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.

Parameters:

  • Object (Object)

    to be compared


195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'lib/docusign_esign/models/stamp.rb', line 195

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

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


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

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


318
319
320
321
322
323
324
325
326
327
328
329
330
# File 'lib/docusign_esign/models/stamp.rb', line 318

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


231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
# File 'lib/docusign_esign/models/stamp.rb', line 231

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

218
219
220
# File 'lib/docusign_esign/models/stamp.rb', line 218

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


224
225
226
# File 'lib/docusign_esign/models/stamp.rb', line 224

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_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


182
183
184
185
# File 'lib/docusign_esign/models/stamp.rb', line 182

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


298
299
300
# File 'lib/docusign_esign/models/stamp.rb', line 298

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


304
305
306
307
308
309
310
311
312
# File 'lib/docusign_esign/models/stamp.rb', line 304

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


292
293
294
# File 'lib/docusign_esign/models/stamp.rb', line 292

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


189
190
191
# File 'lib/docusign_esign/models/stamp.rb', line 189

def valid?
  true
end