Class: DocuSign_eSign::TemplateUpdateSummary

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TemplateUpdateSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
112
113
114
115
116
117
118
119
# File 'lib/docusign_esign/models/template_update_summary.rb', line 72

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bulk_envelope_statusObject

Returns the value of attribute bulk_envelope_status


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

def bulk_envelope_status
  @bulk_envelope_status
end

#envelope_idObject

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


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

def envelope_id
  @envelope_id
end

#error_detailsObject

Returns the value of attribute error_details


22
23
24
# File 'lib/docusign_esign/models/template_update_summary.rb', line 22

def error_details
  @error_details
end

#list_custom_field_update_resultsObject

Returns the value of attribute list_custom_field_update_results


25
26
27
# File 'lib/docusign_esign/models/template_update_summary.rb', line 25

def list_custom_field_update_results
  @list_custom_field_update_results
end

#lock_informationObject

Returns the value of attribute lock_information


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

def lock_information
  @lock_information
end

#purge_stateObject

Returns the value of attribute purge_state


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

def purge_state
  @purge_state
end

#recipient_update_resultsObject

Returns the value of attribute recipient_update_results


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

def recipient_update_results
  @recipient_update_results
end

#tab_update_resultsObject

Returns the value of attribute tab_update_results


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

def tab_update_results
  @tab_update_results
end

#text_custom_field_update_resultsObject

Returns the value of attribute text_custom_field_update_results


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

def text_custom_field_update_results
  @text_custom_field_update_results
end

Class Method Details

.attribute_mapObject

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


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

def self.attribute_map
  {
    :'bulk_envelope_status' => :'bulkEnvelopeStatus',
    :'envelope_id' => :'envelopeId',
    :'error_details' => :'errorDetails',
    :'list_custom_field_update_results' => :'listCustomFieldUpdateResults',
    :'lock_information' => :'lockInformation',
    :'purge_state' => :'purgeState',
    :'recipient_update_results' => :'recipientUpdateResults',
    :'tab_update_results' => :'tabUpdateResults',
    :'text_custom_field_update_results' => :'textCustomFieldUpdateResults'
  }
end

.swagger_typesObject

Attribute type mapping.


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

def self.swagger_types
  {
    :'bulk_envelope_status' => :'BulkEnvelopeStatus',
    :'envelope_id' => :'String',
    :'error_details' => :'ErrorDetails',
    :'list_custom_field_update_results' => :'Array<ListCustomField>',
    :'lock_information' => :'LockInformation',
    :'purge_state' => :'String',
    :'recipient_update_results' => :'Array<RecipientUpdateResponse>',
    :'tab_update_results' => :'Tabs',
    :'text_custom_field_update_results' => :'Array<TextCustomField>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


136
137
138
139
140
141
142
143
144
145
146
147
148
# File 'lib/docusign_esign/models/template_update_summary.rb', line 136

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      bulk_envelope_status == o.bulk_envelope_status &&
      envelope_id == o.envelope_id &&
      error_details == o.error_details &&
      list_custom_field_update_results == o.list_custom_field_update_results &&
      lock_information == o.lock_information &&
      purge_state == o.purge_state &&
      recipient_update_results == o.recipient_update_results &&
      tab_update_results == o.tab_update_results &&
      text_custom_field_update_results == o.text_custom_field_update_results
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


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
214
215
216
217
218
219
220
221
222
# File 'lib/docusign_esign/models/template_update_summary.rb', line 186

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


252
253
254
255
256
257
258
259
260
261
262
263
264
# File 'lib/docusign_esign/models/template_update_summary.rb', line 252

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


165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/docusign_esign/models/template_update_summary.rb', line 165

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

152
153
154
# File 'lib/docusign_esign/models/template_update_summary.rb', line 152

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


158
159
160
# File 'lib/docusign_esign/models/template_update_summary.rb', line 158

def hash
  [bulk_envelope_status, envelope_id, error_details, list_custom_field_update_results, lock_information, purge_state, recipient_update_results, tab_update_results, text_custom_field_update_results].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


123
124
125
126
# File 'lib/docusign_esign/models/template_update_summary.rb', line 123

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


232
233
234
# File 'lib/docusign_esign/models/template_update_summary.rb', line 232

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


238
239
240
241
242
243
244
245
246
# File 'lib/docusign_esign/models/template_update_summary.rb', line 238

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


226
227
228
# File 'lib/docusign_esign/models/template_update_summary.rb', line 226

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


130
131
132
# File 'lib/docusign_esign/models/template_update_summary.rb', line 130

def valid?
  true
end