Class: DocuSign_eSign::DisplayApplianceEnvelope

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DisplayApplianceEnvelope

Initializes the object

Parameters:

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

    Model attributes in the form of hash



107
108
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
 
# File 'lib/docusign_esign/models/display_appliance_envelope.rb', line 107

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#add_demo_stamp ⇒ Object

Returns the value of attribute add_demo_stamp.



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

def add_demo_stamp
  @add_demo_stamp
end

#allow_multiple_attachments ⇒ Object

Returns the value of attribute allow_multiple_attachments.



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

def allow_multiple_attachments
  @allow_multiple_attachments
end

#burn_default_tab_data ⇒ Object

Returns the value of attribute burn_default_tab_data.



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

def burn_default_tab_data
  @burn_default_tab_data
end

#convert_pdf_fields ⇒ Object

Returns the value of attribute convert_pdf_fields.



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

def convert_pdf_fields
  @convert_pdf_fields
end

#envelope_id ⇒ Object

The envelope ID of the envelope status that failed to post.



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

def envelope_id
  @envelope_id
end

#envelope_type ⇒ Object

Returns the value of attribute envelope_type.



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

def envelope_type
  @envelope_type
end

#include_sigs_before_complete ⇒ Object

Returns the value of attribute include_sigs_before_complete.



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

def include_sigs_before_complete
  @include_sigs_before_complete
end

#is_concat_mode ⇒ Object

Returns the value of attribute is_concat_mode.



39
40
41
 
# File 'lib/docusign_esign/models/display_appliance_envelope.rb', line 39

def is_concat_mode
  @is_concat_mode
end

#is_envelope_id_stamping_enabled ⇒ Object

Returns the value of attribute is_envelope_id_stamping_enabled.



42
43
44
 
# File 'lib/docusign_esign/models/display_appliance_envelope.rb', line 42

def is_envelope_id_stamping_enabled
  @is_envelope_id_stamping_enabled
end

#pdf_form_conversion_font_scale100 ⇒ Object

Returns the value of attribute pdf_form_conversion_font_scale100.



45
46
47
 
# File 'lib/docusign_esign/models/display_appliance_envelope.rb', line 45

def pdf_form_conversion_font_scale100
  @pdf_form_conversion_font_scale100
end

#should_flatten ⇒ Object

Returns the value of attribute should_flatten.



48
49
50
 
# File 'lib/docusign_esign/models/display_appliance_envelope.rb', line 48

def should_flatten
  @should_flatten
end

#show_envelope_changes ⇒ Object

Returns the value of attribute show_envelope_changes.



51
52
53
 
# File 'lib/docusign_esign/models/display_appliance_envelope.rb', line 51

def show_envelope_changes
  @show_envelope_changes
end

#sign_online ⇒ Object

Returns the value of attribute sign_online.



54
55
56
 
# File 'lib/docusign_esign/models/display_appliance_envelope.rb', line 54

def sign_online
  @sign_online
end

#status ⇒ Object

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.



57
58
59
 
# File 'lib/docusign_esign/models/display_appliance_envelope.rb', line 57

def status
  @status
end

#user_id ⇒ Object

Returns the value of attribute user_id.



60
61
62
 
# File 'lib/docusign_esign/models/display_appliance_envelope.rb', line 60

def user_id
  @user_id
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
 
# File 'lib/docusign_esign/models/display_appliance_envelope.rb', line 64

def self.attribute_map
  {
    :'add_demo_stamp' => :'addDemoStamp',
    :'allow_multiple_attachments' => :'allowMultipleAttachments',
    :'burn_default_tab_data' => :'burnDefaultTabData',
    :'convert_pdf_fields' => :'convertPdfFields',
    :'envelope_id' => :'envelopeId',
    :'envelope_type' => :'envelopeType',
    :'include_sigs_before_complete' => :'includeSigsBeforeComplete',
    :'is_concat_mode' => :'isConcatMode',
    :'is_envelope_id_stamping_enabled' => :'isEnvelopeIDStampingEnabled',
    :'pdf_form_conversion_font_scale100' => :'pdfFormConversionFontScale100',
    :'should_flatten' => :'shouldFlatten',
    :'show_envelope_changes' => :'showEnvelopeChanges',
    :'sign_online' => :'signOnline',
    :'status' => :'status',
    :'user_id' => :'userId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'add_demo_stamp' => :'BOOLEAN',
    :'allow_multiple_attachments' => :'BOOLEAN',
    :'burn_default_tab_data' => :'BOOLEAN',
    :'convert_pdf_fields' => :'BOOLEAN',
    :'envelope_id' => :'String',
    :'envelope_type' => :'String',
    :'include_sigs_before_complete' => :'BOOLEAN',
    :'is_concat_mode' => :'BOOLEAN',
    :'is_envelope_id_stamping_enabled' => :'BOOLEAN',
    :'pdf_form_conversion_font_scale100' => :'BOOLEAN',
    :'should_flatten' => :'BOOLEAN',
    :'show_envelope_changes' => :'BOOLEAN',
    :'sign_online' => :'BOOLEAN',
    :'status' => :'String',
    :'user_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/docusign_esign/models/display_appliance_envelope.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      add_demo_stamp == o.add_demo_stamp &&
      allow_multiple_attachments == o.allow_multiple_attachments &&
      burn_default_tab_data == o.burn_default_tab_data &&
      convert_pdf_fields == o.convert_pdf_fields &&
      envelope_id == o.envelope_id &&
      envelope_type == o.envelope_type &&
      include_sigs_before_complete == o.include_sigs_before_complete &&
      is_concat_mode == o.is_concat_mode &&
      is_envelope_id_stamping_enabled == o.is_envelope_id_stamping_enabled &&
      pdf_form_conversion_font_scale100 == o.pdf_form_conversion_font_scale100 &&
      should_flatten == o.should_flatten &&
      show_envelope_changes == o.show_envelope_changes &&
      sign_online == o.sign_online &&
      status == o.status &&
      user_id == o.user_id
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



246
247
248
249
250
251
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
 
# File 'lib/docusign_esign/models/display_appliance_envelope.rb', line 246

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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/docusign_esign/models/display_appliance_envelope.rb', line 312

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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/docusign_esign/models/display_appliance_envelope.rb', line 225

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [add_demo_stamp, allow_multiple_attachments, burn_default_tab_data, convert_pdf_fields, envelope_id, envelope_type, include_sigs_before_complete, is_concat_mode, is_envelope_id_stamping_enabled, pdf_form_conversion_font_scale100, should_flatten, show_envelope_changes, sign_online, status, user_id].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



177
178
179
180
 
# File 'lib/docusign_esign/models/display_appliance_envelope.rb', line 177

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



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

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



298
299
300
301
302
303
304
305
306
 
# File 'lib/docusign_esign/models/display_appliance_envelope.rb', line 298

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



286
287
288
 
# File 'lib/docusign_esign/models/display_appliance_envelope.rb', line 286

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



184
185
186
 
# File 'lib/docusign_esign/models/display_appliance_envelope.rb', line 184

def valid?
  return true
end