Class: DocuSign_eSign::EnvelopePublishTransaction

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EnvelopePublishTransaction

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
153
154
155
156
 
# File 'lib/docusign_esign/models/envelope_publish_transaction.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?(:'applyConnectSettings')
    self.apply_connect_settings = attributes[:'applyConnectSettings']
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#apply_connect_settings ⇒ Object

Returns the value of attribute apply_connect_settings.



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

def apply_connect_settings
  @apply_connect_settings
end

#envelope_count ⇒ Object

Returns the value of attribute envelope_count.



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

def envelope_count
  @envelope_count
end

#envelope_level_error_rollups ⇒ Object

Returns the value of attribute envelope_level_error_rollups.



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

def envelope_level_error_rollups
  @envelope_level_error_rollups
end

#envelope_publish_transaction_id ⇒ Object

Returns the value of attribute envelope_publish_transaction_id.



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

def envelope_publish_transaction_id
  @envelope_publish_transaction_id
end

#error_count ⇒ Object

Returns the value of attribute error_count.



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

def error_count
  @error_count
end

#file_level_errors ⇒ Object

Returns the value of attribute file_level_errors.



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

def file_level_errors
  @file_level_errors
end

#no_action_required_envelope_count ⇒ Object

Returns the value of attribute no_action_required_envelope_count.



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

def no_action_required_envelope_count
  @no_action_required_envelope_count
end

#processed_envelope_count ⇒ Object

Returns the value of attribute processed_envelope_count.



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

def processed_envelope_count
  @processed_envelope_count
end

#processing_status ⇒ Object

Returns the value of attribute processing_status.



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

def processing_status
  @processing_status
end

#results_uri ⇒ Object

Returns the value of attribute results_uri.



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

def results_uri
  @results_uri
end

#submission_date ⇒ Object

Returns the value of attribute submission_date.



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

def submission_date
  @submission_date
end

#submitted_by_user_info ⇒ Object

Returns the value of attribute submitted_by_user_info.



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

def 
  @submitted_by_user_info
end

#submitted_for_publishing_envelope_count ⇒ Object

Returns the value of attribute submitted_for_publishing_envelope_count.



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

def submitted_for_publishing_envelope_count
  @submitted_for_publishing_envelope_count
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/envelope_publish_transaction.rb', line 56

def self.attribute_map
  {
    :'apply_connect_settings' => :'applyConnectSettings',
    :'envelope_count' => :'envelopeCount',
    :'envelope_level_error_rollups' => :'envelopeLevelErrorRollups',
    :'envelope_publish_transaction_id' => :'envelopePublishTransactionId',
    :'error_count' => :'errorCount',
    :'file_level_errors' => :'fileLevelErrors',
    :'no_action_required_envelope_count' => :'noActionRequiredEnvelopeCount',
    :'processed_envelope_count' => :'processedEnvelopeCount',
    :'processing_status' => :'processingStatus',
    :'results_uri' => :'resultsUri',
    :'submission_date' => :'submissionDate',
    :'submitted_by_user_info' => :'submittedByUserInfo',
    :'submitted_for_publishing_envelope_count' => :'submittedForPublishingEnvelopeCount'
  }
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/envelope_publish_transaction.rb', line 75

def self.swagger_types
  {
    :'apply_connect_settings' => :'String',
    :'envelope_count' => :'String',
    :'envelope_level_error_rollups' => :'Array<EnvelopePublishTransactionErrorRollup>',
    :'envelope_publish_transaction_id' => :'String',
    :'error_count' => :'String',
    :'file_level_errors' => :'Array<String>',
    :'no_action_required_envelope_count' => :'String',
    :'processed_envelope_count' => :'String',
    :'processing_status' => :'String',
    :'results_uri' => :'String',
    :'submission_date' => :'String',
    :'submitted_by_user_info' => :'UserInfo',
    :'submitted_for_publishing_envelope_count' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/docusign_esign/models/envelope_publish_transaction.rb', line 173

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      apply_connect_settings == o.apply_connect_settings &&
      envelope_count == o.envelope_count &&
      envelope_level_error_rollups == o.envelope_level_error_rollups &&
      envelope_publish_transaction_id == o.envelope_publish_transaction_id &&
      error_count == o.error_count &&
      file_level_errors == o.file_level_errors &&
      no_action_required_envelope_count == o.no_action_required_envelope_count &&
      processed_envelope_count == o.processed_envelope_count &&
      processing_status == o.processing_status &&
      results_uri == o.results_uri &&
      submission_date == o.submission_date &&
       == o. &&
      submitted_for_publishing_envelope_count == o.submitted_for_publishing_envelope_count
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



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
260
261
262
263
 
# File 'lib/docusign_esign/models/envelope_publish_transaction.rb', line 227

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



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/docusign_esign/models/envelope_publish_transaction.rb', line 293

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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/docusign_esign/models/envelope_publish_transaction.rb', line 206

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [apply_connect_settings, envelope_count, envelope_level_error_rollups, envelope_publish_transaction_id, error_count, file_level_errors, no_action_required_envelope_count, processed_envelope_count, processing_status, results_uri, submission_date, , submitted_for_publishing_envelope_count].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



160
161
162
163
 
# File 'lib/docusign_esign/models/envelope_publish_transaction.rb', line 160

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



273
274
275
 
# File 'lib/docusign_esign/models/envelope_publish_transaction.rb', line 273

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



279
280
281
282
283
284
285
286
287
 
# File 'lib/docusign_esign/models/envelope_publish_transaction.rb', line 279

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



267
268
269
 
# File 'lib/docusign_esign/models/envelope_publish_transaction.rb', line 267

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



167
168
169
 
# File 'lib/docusign_esign/models/envelope_publish_transaction.rb', line 167

def valid?
  true
end