Class: DocuSign_eSign::EnvelopeDocument

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EnvelopeDocument

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
179
180
181
182
 
# File 'lib/docusign_esign/models/envelope_document.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?(:'attachmentTabId')
    self.attachment_tab_id = attributes[:'attachmentTabId']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attachment_tab_id ⇒ Object

Returns the value of attribute attachment_tab_id.



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

def attachment_tab_id
  @attachment_tab_id
end

#authoritative_copy ⇒ Object

Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.



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

def authoritative_copy
  @authoritative_copy
end

#available_document_types ⇒ Object

Returns the value of attribute available_document_types.



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

def available_document_types
  @available_document_types
end

#contains_pdf_form_fields ⇒ Object

Returns the value of attribute contains_pdf_form_fields.



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

def contains_pdf_form_fields
  @contains_pdf_form_fields
end

#display ⇒ Object

Returns the value of attribute display.



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

def display
  @display
end

#document_fields ⇒ Object

Returns the value of attribute document_fields.



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

def document_fields
  @document_fields
end

#document_id ⇒ Object

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



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

def document_id
  @document_id
end

#error_details ⇒ Object

Returns the value of attribute error_details.



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

def error_details
  @error_details
end

#include_in_download ⇒ Object

Returns the value of attribute include_in_download.



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

def include_in_download
  @include_in_download
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#order ⇒ Object

Returns the value of attribute order.



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

def order
  @order
end

#pages ⇒ Object

Returns the value of attribute pages.



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

def pages
  @pages
end

#signer_must_acknowledge ⇒ Object

Returns the value of attribute signer_must_acknowledge.



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

def signer_must_acknowledge
  @signer_must_acknowledge
end

#size_bytes ⇒ Object

Returns the value of attribute size_bytes.



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

def size_bytes
  @size_bytes
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#uri ⇒ Object

Returns the value of attribute uri.



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

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

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/envelope_document.rb', line 64

def self.attribute_map
  {
    :'attachment_tab_id' => :'attachmentTabId',
    :'authoritative_copy' => :'authoritativeCopy',
    :'available_document_types' => :'availableDocumentTypes',
    :'contains_pdf_form_fields' => :'containsPdfFormFields',
    :'display' => :'display',
    :'document_fields' => :'documentFields',
    :'document_id' => :'documentId',
    :'error_details' => :'errorDetails',
    :'include_in_download' => :'includeInDownload',
    :'name' => :'name',
    :'order' => :'order',
    :'pages' => :'pages',
    :'signer_must_acknowledge' => :'signerMustAcknowledge',
    :'size_bytes' => :'sizeBytes',
    :'type' => :'type',
    :'uri' => :'uri'
  }
end

.swagger_types ⇒ Object

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/envelope_document.rb', line 86

def self.swagger_types
  {
    :'attachment_tab_id' => :'String',
    :'authoritative_copy' => :'String',
    :'available_document_types' => :'Array<SignatureType>',
    :'contains_pdf_form_fields' => :'String',
    :'display' => :'String',
    :'document_fields' => :'Array<NameValue>',
    :'document_id' => :'String',
    :'error_details' => :'ErrorDetails',
    :'include_in_download' => :'String',
    :'name' => :'String',
    :'order' => :'String',
    :'pages' => :'String',
    :'signer_must_acknowledge' => :'String',
    :'size_bytes' => :'String',
    :'type' => :'String',
    :'uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 199

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      attachment_tab_id == o.attachment_tab_id &&
      authoritative_copy == o.authoritative_copy &&
      available_document_types == o.available_document_types &&
      contains_pdf_form_fields == o.contains_pdf_form_fields &&
      display == o.display &&
      document_fields == o.document_fields &&
      document_id == o.document_id &&
      error_details == o.error_details &&
      include_in_download == o.include_in_download &&
      name == o.name &&
      order == o.order &&
      pages == o.pages &&
      signer_must_acknowledge == o.signer_must_acknowledge &&
      size_bytes == o.size_bytes &&
      type == o.type &&
      uri == o.uri
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



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
289
290
291
292
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 256

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



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 322

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 235

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


222
223
224
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 222

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



228
229
230
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 228

def hash
  [attachment_tab_id, authoritative_copy, available_document_types, contains_pdf_form_fields, display, document_fields, document_id, error_details, include_in_download, name, order, pages, signer_must_acknowledge, size_bytes, type, uri].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



186
187
188
189
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 186

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



302
303
304
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 302

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



308
309
310
311
312
313
314
315
316
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 308

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



296
297
298
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 296

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



193
194
195
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 193

def valid?
  true
end