Class: DocuSign_Admin::OrganizationImportResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_admin/models/organization_import_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrganizationImportResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
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
# File 'lib/docusign_admin/models/organization_import_response.rb', line 134

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#added_user_countObject

Returns the value of attribute added_user_count.



32
33
34
# File 'lib/docusign_admin/models/organization_import_response.rb', line 32

def added_user_count
  @added_user_count
end

#closed_user_countObject

Returns the value of attribute closed_user_count.



36
37
38
# File 'lib/docusign_admin/models/organization_import_response.rb', line 36

def closed_user_count
  @closed_user_count
end

#createdObject

Returns the value of attribute created.



22
23
24
# File 'lib/docusign_admin/models/organization_import_response.rb', line 22

def created
  @created
end

#error_countObject

Returns the value of attribute error_count.



40
41
42
# File 'lib/docusign_admin/models/organization_import_response.rb', line 40

def error_count
  @error_count
end

#file_level_error_rollupsObject

Returns the value of attribute file_level_error_rollups.



58
59
60
# File 'lib/docusign_admin/models/organization_import_response.rb', line 58

def file_level_error_rollups
  @file_level_error_rollups
end

#has_csv_resultsObject

Returns the value of attribute has_csv_results.



64
65
66
# File 'lib/docusign_admin/models/organization_import_response.rb', line 64

def has_csv_results
  @has_csv_results
end

#idObject

Returns the value of attribute id.



16
17
18
# File 'lib/docusign_admin/models/organization_import_response.rb', line 16

def id
  @id
end

#imports_failed_for_accountsObject

Returns the value of attribute imports_failed_for_accounts.



48
49
50
# File 'lib/docusign_admin/models/organization_import_response.rb', line 48

def imports_failed_for_accounts
  @imports_failed_for_accounts
end

#imports_failed_for_sitesObject

Returns the value of attribute imports_failed_for_sites.



54
55
56
# File 'lib/docusign_admin/models/organization_import_response.rb', line 54

def imports_failed_for_sites
  @imports_failed_for_sites
end

#imports_not_found_or_not_available_for_accountsObject

Returns the value of attribute imports_not_found_or_not_available_for_accounts.



46
47
48
# File 'lib/docusign_admin/models/organization_import_response.rb', line 46

def imports_not_found_or_not_available_for_accounts
  @imports_not_found_or_not_available_for_accounts
end

#imports_not_found_or_not_available_for_sitesObject

Returns the value of attribute imports_not_found_or_not_available_for_sites.



52
53
54
# File 'lib/docusign_admin/models/organization_import_response.rb', line 52

def imports_not_found_or_not_available_for_sites
  @imports_not_found_or_not_available_for_sites
end

#imports_timed_out_for_accountsObject

Returns the value of attribute imports_timed_out_for_accounts.



50
51
52
# File 'lib/docusign_admin/models/organization_import_response.rb', line 50

def imports_timed_out_for_accounts
  @imports_timed_out_for_accounts
end

#imports_timed_out_for_sitesObject

Returns the value of attribute imports_timed_out_for_sites.



56
57
58
# File 'lib/docusign_admin/models/organization_import_response.rb', line 56

def imports_timed_out_for_sites
  @imports_timed_out_for_sites
end

#invalid_column_headersObject

Returns the value of attribute invalid_column_headers.



44
45
46
# File 'lib/docusign_admin/models/organization_import_response.rb', line 44

def invalid_column_headers
  @invalid_column_headers
end

#last_modifiedObject

Returns the value of attribute last_modified.



24
25
26
# File 'lib/docusign_admin/models/organization_import_response.rb', line 24

def last_modified
  @last_modified
end

#no_action_required_user_countObject

Returns the value of attribute no_action_required_user_count.



38
39
40
# File 'lib/docusign_admin/models/organization_import_response.rb', line 38

def no_action_required_user_count
  @no_action_required_user_count
end

#processed_user_countObject

Returns the value of attribute processed_user_count.



30
31
32
# File 'lib/docusign_admin/models/organization_import_response.rb', line 30

def processed_user_count
  @processed_user_count
end

#requestorObject

Returns the value of attribute requestor.



20
21
22
# File 'lib/docusign_admin/models/organization_import_response.rb', line 20

def requestor
  @requestor
end

#results_uriObject

Returns the value of attribute results_uri.



66
67
68
# File 'lib/docusign_admin/models/organization_import_response.rb', line 66

def results_uri
  @results_uri
end

#statusObject

Returns the value of attribute status.



26
27
28
# File 'lib/docusign_admin/models/organization_import_response.rb', line 26

def status
  @status
end

#typeObject

Returns the value of attribute type.



18
19
20
# File 'lib/docusign_admin/models/organization_import_response.rb', line 18

def type
  @type
end

#updated_user_countObject

Returns the value of attribute updated_user_count.



34
35
36
# File 'lib/docusign_admin/models/organization_import_response.rb', line 34

def updated_user_count
  @updated_user_count
end

#user_countObject

Returns the value of attribute user_count.



28
29
30
# File 'lib/docusign_admin/models/organization_import_response.rb', line 28

def user_count
  @user_count
end

#user_level_error_rollupsObject

Returns the value of attribute user_level_error_rollups.



60
61
62
# File 'lib/docusign_admin/models/organization_import_response.rb', line 60

def user_level_error_rollups
  @user_level_error_rollups
end

#user_level_warning_rollupsObject

Returns the value of attribute user_level_warning_rollups.



62
63
64
# File 'lib/docusign_admin/models/organization_import_response.rb', line 62

def user_level_warning_rollups
  @user_level_warning_rollups
end

#warning_countObject

Returns the value of attribute warning_count.



42
43
44
# File 'lib/docusign_admin/models/organization_import_response.rb', line 42

def warning_count
  @warning_count
end

Class Method Details

.attribute_mapObject

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
90
91
92
93
94
95
96
97
98
# File 'lib/docusign_admin/models/organization_import_response.rb', line 69

def self.attribute_map
  {
    :'id' => :'id',
    :'type' => :'type',
    :'requestor' => :'requestor',
    :'created' => :'created',
    :'last_modified' => :'last_modified',
    :'status' => :'status',
    :'user_count' => :'user_count',
    :'processed_user_count' => :'processed_user_count',
    :'added_user_count' => :'added_user_count',
    :'updated_user_count' => :'updated_user_count',
    :'closed_user_count' => :'closed_user_count',
    :'no_action_required_user_count' => :'no_action_required_user_count',
    :'error_count' => :'error_count',
    :'warning_count' => :'warning_count',
    :'invalid_column_headers' => :'invalid_column_headers',
    :'imports_not_found_or_not_available_for_accounts' => :'imports_not_found_or_not_available_for_accounts',
    :'imports_failed_for_accounts' => :'imports_failed_for_accounts',
    :'imports_timed_out_for_accounts' => :'imports_timed_out_for_accounts',
    :'imports_not_found_or_not_available_for_sites' => :'imports_not_found_or_not_available_for_sites',
    :'imports_failed_for_sites' => :'imports_failed_for_sites',
    :'imports_timed_out_for_sites' => :'imports_timed_out_for_sites',
    :'file_level_error_rollups' => :'file_level_error_rollups',
    :'user_level_error_rollups' => :'user_level_error_rollups',
    :'user_level_warning_rollups' => :'user_level_warning_rollups',
    :'has_csv_results' => :'has_csv_results',
    :'results_uri' => :'results_uri'
  }
end

.swagger_typesObject

Attribute type mapping.



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
# File 'lib/docusign_admin/models/organization_import_response.rb', line 101

def self.swagger_types
  {
    :'id' => :'String',
    :'type' => :'String',
    :'requestor' => :'OrganizationImportResponseRequestor',
    :'created' => :'DateTime',
    :'last_modified' => :'DateTime',
    :'status' => :'String',
    :'user_count' => :'Integer',
    :'processed_user_count' => :'Integer',
    :'added_user_count' => :'Integer',
    :'updated_user_count' => :'Integer',
    :'closed_user_count' => :'Integer',
    :'no_action_required_user_count' => :'Integer',
    :'error_count' => :'Integer',
    :'warning_count' => :'Integer',
    :'invalid_column_headers' => :'String',
    :'imports_not_found_or_not_available_for_accounts' => :'String',
    :'imports_failed_for_accounts' => :'String',
    :'imports_timed_out_for_accounts' => :'String',
    :'imports_not_found_or_not_available_for_sites' => :'String',
    :'imports_failed_for_sites' => :'String',
    :'imports_timed_out_for_sites' => :'String',
    :'file_level_error_rollups' => :'Array<OrganizationImportResponseErrorRollup>',
    :'user_level_error_rollups' => :'Array<OrganizationImportResponseErrorRollup>',
    :'user_level_warning_rollups' => :'Array<OrganizationImportResponseWarningRollup>',
    :'has_csv_results' => :'BOOLEAN',
    :'results_uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



266
267
268
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
# File 'lib/docusign_admin/models/organization_import_response.rb', line 266

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      type == o.type &&
      requestor == o.requestor &&
      created == o.created &&
      last_modified == o.last_modified &&
      status == o.status &&
      user_count == o.user_count &&
      processed_user_count == o.processed_user_count &&
      added_user_count == o.added_user_count &&
      updated_user_count == o.updated_user_count &&
      closed_user_count == o.closed_user_count &&
      no_action_required_user_count == o.no_action_required_user_count &&
      error_count == o.error_count &&
      warning_count == o.warning_count &&
      invalid_column_headers == o.invalid_column_headers &&
      imports_not_found_or_not_available_for_accounts == o.imports_not_found_or_not_available_for_accounts &&
      imports_failed_for_accounts == o.imports_failed_for_accounts &&
      imports_timed_out_for_accounts == o.imports_timed_out_for_accounts &&
      imports_not_found_or_not_available_for_sites == o.imports_not_found_or_not_available_for_sites &&
      imports_failed_for_sites == o.imports_failed_for_sites &&
      imports_timed_out_for_sites == o.imports_timed_out_for_sites &&
      file_level_error_rollups == o.file_level_error_rollups &&
      user_level_error_rollups == o.user_level_error_rollups &&
      user_level_warning_rollups == o.user_level_warning_rollups &&
      has_csv_results == o.has_csv_results &&
      results_uri == o.results_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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
# File 'lib/docusign_admin/models/organization_import_response.rb', line 333

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_Admin.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



399
400
401
402
403
404
405
406
407
408
409
410
411
# File 'lib/docusign_admin/models/organization_import_response.rb', line 399

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



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
# File 'lib/docusign_admin/models/organization_import_response.rb', line 312

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


299
300
301
# File 'lib/docusign_admin/models/organization_import_response.rb', line 299

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



305
306
307
# File 'lib/docusign_admin/models/organization_import_response.rb', line 305

def hash
  [id, type, requestor, created, last_modified, status, user_count, processed_user_count, added_user_count, updated_user_count, closed_user_count, no_action_required_user_count, error_count, warning_count, invalid_column_headers, imports_not_found_or_not_available_for_accounts, imports_failed_for_accounts, imports_timed_out_for_accounts, imports_not_found_or_not_available_for_sites, imports_failed_for_sites, imports_timed_out_for_sites, file_level_error_rollups, user_level_error_rollups, user_level_warning_rollups, has_csv_results, results_uri].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



253
254
255
256
# File 'lib/docusign_admin/models/organization_import_response.rb', line 253

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



379
380
381
# File 'lib/docusign_admin/models/organization_import_response.rb', line 379

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



385
386
387
388
389
390
391
392
393
# File 'lib/docusign_admin/models/organization_import_response.rb', line 385

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



373
374
375
# File 'lib/docusign_admin/models/organization_import_response.rb', line 373

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



260
261
262
# File 'lib/docusign_admin/models/organization_import_response.rb', line 260

def valid?
  true
end