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



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
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 116

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

  if attributes.has_key?(:'templateRequired')
    self.template_required = attributes[:'templateRequired']
  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.



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

def attachment_tab_id
  @attachment_tab_id
end

#available_document_types ⇒ Object

Returns the value of attribute available_document_types.



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

def available_document_types
  @available_document_types
end

#contains_pdf_form_fields ⇒ Object

Returns the value of attribute contains_pdf_form_fields.



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

def contains_pdf_form_fields
  @contains_pdf_form_fields
end

#display ⇒ Object

Returns the value of attribute display.



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

def display
  @display
end

#document_fields ⇒ Object

Returns the value of attribute document_fields.



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

def document_fields
  @document_fields
end

#document_group ⇒ Object

Returns the value of attribute document_group.



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

def document_group
  @document_group
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.



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

def document_id
  @document_id
end

#error_details ⇒ Object

Returns the value of attribute error_details.



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

def error_details
  @error_details
end

#include_in_download ⇒ Object

Returns the value of attribute include_in_download.



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

def include_in_download
  @include_in_download
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#order ⇒ Object

Returns the value of attribute order.



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

def order
  @order
end

#pages ⇒ Object

Returns the value of attribute pages.



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

def pages
  @pages
end

#signer_must_acknowledge ⇒ Object

Returns the value of attribute signer_must_acknowledge.



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

def signer_must_acknowledge
  @signer_must_acknowledge
end

#template_locked ⇒ Object

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.



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

def template_locked
  @template_locked
end

#template_required ⇒ Object

When set to true, the sender may not remove the recipient. Used only when working with template recipients.



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

def template_required
  @template_required
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#uri ⇒ Object

Returns the value of attribute uri.



65
66
67
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 65

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 69

def self.attribute_map
  {
    :'attachment_tab_id' => :'attachmentTabId',
    :'available_document_types' => :'availableDocumentTypes',
    :'contains_pdf_form_fields' => :'containsPdfFormFields',
    :'display' => :'display',
    :'document_fields' => :'documentFields',
    :'document_group' => :'documentGroup',
    :'document_id' => :'documentId',
    :'error_details' => :'errorDetails',
    :'include_in_download' => :'includeInDownload',
    :'name' => :'name',
    :'order' => :'order',
    :'pages' => :'pages',
    :'signer_must_acknowledge' => :'signerMustAcknowledge',
    :'template_locked' => :'templateLocked',
    :'template_required' => :'templateRequired',
    :'type' => :'type',
    :'uri' => :'uri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 92

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 211

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      attachment_tab_id == o.attachment_tab_id &&
      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_group == o.document_group &&
      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 &&
      template_locked == o.template_locked &&
      template_required == o.template_required &&
      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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 269

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 335

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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 248

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


235
236
237
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



241
242
243
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 241

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

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



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

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



315
316
317
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 315

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



321
322
323
324
325
326
327
328
329
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 321

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



309
310
311
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 309

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



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

def valid?
  return true
end