Class: DocuSign_eSign::SignHashDocument

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignHashDocument

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
102
103
104
105
106
107
108
109
110
111
# File 'lib/docusign_esign/models/sign_hash_document.rb', line 71

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

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

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

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

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

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

end

Instance Attribute Details

#dataObject

Returns the value of attribute data


18
19
20
# File 'lib/docusign_esign/models/sign_hash_document.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/sign_hash_document.rb', line 21

def document_id
  @document_id
end

#formatObject

Returns the value of attribute format


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

def format
  @format
end

#nameObject

Returns the value of attribute name


27
28
29
# File 'lib/docusign_esign/models/sign_hash_document.rb', line 27

def name
  @name
end

#remaining_signaturesObject

Returns the value of attribute remaining_signatures


30
31
32
# File 'lib/docusign_esign/models/sign_hash_document.rb', line 30

def remaining_signatures
  @remaining_signatures
end

#revisionsObject

Returns the value of attribute revisions


33
34
35
# File 'lib/docusign_esign/models/sign_hash_document.rb', line 33

def revisions
  @revisions
end

#signature_propertiesObject

Returns the value of attribute signature_properties


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

def signature_properties
  @signature_properties
end

#signature_typeObject

Returns the value of attribute signature_type


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

def signature_type
  @signature_type
end

Class Method Details

.attribute_mapObject

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


42
43
44
45
46
47
48
49
50
51
52
53
# File 'lib/docusign_esign/models/sign_hash_document.rb', line 42

def self.attribute_map
  {
    :'data' => :'data',
    :'document_id' => :'documentId',
    :'format' => :'format',
    :'name' => :'name',
    :'remaining_signatures' => :'remainingSignatures',
    :'revisions' => :'revisions',
    :'signature_properties' => :'signatureProperties',
    :'signature_type' => :'signatureType'
  }
end

.swagger_typesObject

Attribute type mapping.


56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/docusign_esign/models/sign_hash_document.rb', line 56

def self.swagger_types
  {
    :'data' => :'String',
    :'document_id' => :'String',
    :'format' => :'String',
    :'name' => :'String',
    :'remaining_signatures' => :'Integer',
    :'revisions' => :'Array<Revision>',
    :'signature_properties' => :'SignatureProperties',
    :'signature_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


128
129
130
131
132
133
134
135
136
137
138
139
# File 'lib/docusign_esign/models/sign_hash_document.rb', line 128

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      data == o.data &&
      document_id == o.document_id &&
      format == o.format &&
      name == o.name &&
      remaining_signatures == o.remaining_signatures &&
      revisions == o.revisions &&
      signature_properties == o.signature_properties &&
      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


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

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


243
244
245
246
247
248
249
250
251
252
253
254
255
# File 'lib/docusign_esign/models/sign_hash_document.rb', line 243

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


156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/docusign_esign/models/sign_hash_document.rb', line 156

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

143
144
145
# File 'lib/docusign_esign/models/sign_hash_document.rb', line 143

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


149
150
151
# File 'lib/docusign_esign/models/sign_hash_document.rb', line 149

def hash
  [data, document_id, format, name, remaining_signatures, revisions, signature_properties, signature_type].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properies with the reasons


115
116
117
118
# File 'lib/docusign_esign/models/sign_hash_document.rb', line 115

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


223
224
225
# File 'lib/docusign_esign/models/sign_hash_document.rb', line 223

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


229
230
231
232
233
234
235
236
237
# File 'lib/docusign_esign/models/sign_hash_document.rb', line 229

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


217
218
219
# File 'lib/docusign_esign/models/sign_hash_document.rb', line 217

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


122
123
124
# File 'lib/docusign_esign/models/sign_hash_document.rb', line 122

def valid?
  return true
end