Class: DocuSign_eSign::DocumentUpdateInfo

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentUpdateInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash


65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'lib/docusign_esign/models/document_update_info.rb', line 65

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

  if attributes.has_key?(:'documentId')
    self.document_id = attributes[:'documentId']
  end

  if attributes.has_key?(:'documentSecurityStore')
    self.document_security_store = attributes[:'documentSecurityStore']
  end

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

  if attributes.has_key?(:'returnFormat')
    self.return_format = attributes[:'returnFormat']
  end

  if attributes.has_key?(:'signatureDataInfos')
    if (value = attributes[:'signatureDataInfos']).is_a?(Array)
      self.signature_data_infos = value
    end
  end

  if attributes.has_key?(:'timeStampField')
    self.time_stamp_field = attributes[:'timeStampField']
  end

end

Instance Attribute Details

#dataObject

Returns the value of attribute data


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

def data
  @data
end

#document_idObject

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.


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

def document_id
  @document_id
end

#document_security_storeObject

Returns the value of attribute document_security_store


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

def document_security_store
  @document_security_store
end

#nameObject

Returns the value of attribute name


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

def name
  @name
end

#return_formatObject

Returns the value of attribute return_format


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

def return_format
  @return_format
end

#signature_data_infosObject

Returns the value of attribute signature_data_infos


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

def signature_data_infos
  @signature_data_infos
end

#time_stamp_fieldObject

Returns the value of attribute time_stamp_field


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

def time_stamp_field
  @time_stamp_field
end

Class Method Details

.attribute_mapObject

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


38
39
40
41
42
43
44
45
46
47
48
# File 'lib/docusign_esign/models/document_update_info.rb', line 38

def self.attribute_map
  {
    :'data' => :'data',
    :'document_id' => :'documentId',
    :'document_security_store' => :'documentSecurityStore',
    :'name' => :'name',
    :'return_format' => :'returnFormat',
    :'signature_data_infos' => :'signatureDataInfos',
    :'time_stamp_field' => :'timeStampField'
  }
end

.swagger_typesObject

Attribute type mapping.


51
52
53
54
55
56
57
58
59
60
61
# File 'lib/docusign_esign/models/document_update_info.rb', line 51

def self.swagger_types
  {
    :'data' => :'String',
    :'document_id' => :'String',
    :'document_security_store' => :'DocumentSecurityStore',
    :'name' => :'String',
    :'return_format' => :'String',
    :'signature_data_infos' => :'Array<SignatureDataInfo>',
    :'time_stamp_field' => :'TimeStampField'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


118
119
120
121
122
123
124
125
126
127
128
# File 'lib/docusign_esign/models/document_update_info.rb', line 118

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      data == o.data &&
      document_id == o.document_id &&
      document_security_store == o.document_security_store &&
      name == o.name &&
      return_format == o.return_format &&
      signature_data_infos == o.signature_data_infos &&
      time_stamp_field == o.time_stamp_field
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


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

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


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

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


145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
# File 'lib/docusign_esign/models/document_update_info.rb', line 145

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

132
133
134
# File 'lib/docusign_esign/models/document_update_info.rb', line 132

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


138
139
140
# File 'lib/docusign_esign/models/document_update_info.rb', line 138

def hash
  [data, document_id, document_security_store, name, return_format, signature_data_infos, time_stamp_field].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properies with the reasons


105
106
107
108
# File 'lib/docusign_esign/models/document_update_info.rb', line 105

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


212
213
214
# File 'lib/docusign_esign/models/document_update_info.rb', line 212

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


218
219
220
221
222
223
224
225
226
# File 'lib/docusign_esign/models/document_update_info.rb', line 218

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


206
207
208
# File 'lib/docusign_esign/models/document_update_info.rb', line 206

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


112
113
114
# File 'lib/docusign_esign/models/document_update_info.rb', line 112

def valid?
  return true
end