Class: DocuSign_eSign::BulkSendEnvelopesInfo

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BulkSendEnvelopesInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



95
96
97
98
99
100
101
102
103
104
105
106
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
 
# File 'lib/docusign_esign/models/bulk_send_envelopes_info.rb', line 95

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#authoritative_copy ⇒ Object

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



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

def authoritative_copy
  @authoritative_copy
end

#completed ⇒ Object

Returns the value of attribute completed.



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

def completed
  @completed
end

#correct ⇒ Object

Returns the value of attribute correct.



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

def correct
  @correct
end

#created ⇒ Object

Returns the value of attribute created.



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

def created
  @created
end

#declined ⇒ Object

Returns the value of attribute declined.



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

def declined
  @declined
end

#deleted ⇒ Object

Returns the value of attribute deleted.



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

def deleted
  @deleted
end

#delivered ⇒ Object

Returns the value of attribute delivered.



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

def delivered
  @delivered
end

#digital_signatures_pending ⇒ Object

Returns the value of attribute digital_signatures_pending.



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

def digital_signatures_pending
  @digital_signatures_pending
end

#sent ⇒ Object

Returns the value of attribute sent.



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

def sent
  @sent
end

#signed ⇒ Object

Returns the value of attribute signed.



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

def signed
  @signed
end

#timed_out ⇒ Object

Returns the value of attribute timed_out.



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

def timed_out
  @timed_out
end

#transfer_completed ⇒ Object

Returns the value of attribute transfer_completed.



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

def transfer_completed
  @transfer_completed
end

#voided ⇒ Object

Returns the value of attribute voided.



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

def voided
  @voided
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/docusign_esign/models/bulk_send_envelopes_info.rb', line 56

def self.attribute_map
  {
    :'authoritative_copy' => :'authoritativeCopy',
    :'completed' => :'completed',
    :'correct' => :'correct',
    :'created' => :'created',
    :'declined' => :'declined',
    :'deleted' => :'deleted',
    :'delivered' => :'delivered',
    :'digital_signatures_pending' => :'digitalSignaturesPending',
    :'sent' => :'sent',
    :'signed' => :'signed',
    :'timed_out' => :'timedOut',
    :'transfer_completed' => :'transferCompleted',
    :'voided' => :'voided'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/docusign_esign/models/bulk_send_envelopes_info.rb', line 75

def self.swagger_types
  {
    :'authoritative_copy' => :'String',
    :'completed' => :'String',
    :'correct' => :'String',
    :'created' => :'String',
    :'declined' => :'String',
    :'deleted' => :'String',
    :'delivered' => :'String',
    :'digital_signatures_pending' => :'String',
    :'sent' => :'String',
    :'signed' => :'String',
    :'timed_out' => :'String',
    :'transfer_completed' => :'String',
    :'voided' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/docusign_esign/models/bulk_send_envelopes_info.rb', line 169

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authoritative_copy == o.authoritative_copy &&
      completed == o.completed &&
      correct == o.correct &&
      created == o.created &&
      declined == o.declined &&
      deleted == o.deleted &&
      delivered == o.delivered &&
      digital_signatures_pending == o.digital_signatures_pending &&
      sent == o.sent &&
      signed == o.signed &&
      timed_out == o.timed_out &&
      transfer_completed == o.transfer_completed &&
      voided == o.voided
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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/docusign_esign/models/bulk_send_envelopes_info.rb', line 223

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



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/docusign_esign/models/bulk_send_envelopes_info.rb', line 289

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



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

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


189
190
191
 
# File 'lib/docusign_esign/models/bulk_send_envelopes_info.rb', line 189

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



195
196
197
 
# File 'lib/docusign_esign/models/bulk_send_envelopes_info.rb', line 195

def hash
  [authoritative_copy, completed, correct, created, declined, deleted, delivered, digital_signatures_pending, sent, signed, timed_out, transfer_completed, voided].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



156
157
158
159
 
# File 'lib/docusign_esign/models/bulk_send_envelopes_info.rb', line 156

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



269
270
271
 
# File 'lib/docusign_esign/models/bulk_send_envelopes_info.rb', line 269

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



275
276
277
278
279
280
281
282
283
 
# File 'lib/docusign_esign/models/bulk_send_envelopes_info.rb', line 275

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



263
264
265
 
# File 'lib/docusign_esign/models/bulk_send_envelopes_info.rb', line 263

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



163
164
165
 
# File 'lib/docusign_esign/models/bulk_send_envelopes_info.rb', line 163

def valid?
  true
end