Class: Zernio::BulkUploadResult

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/bulk_upload_result.rb

Overview

Result of a CSV bulk upload. The same shape is returned for 200 (all rows succeeded or all failed) and 207 (mixed). Per-row outcomes live in results; the row's success is ok, and failures carry machine-readable codes in errors.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ BulkUploadResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
120
121
122
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 79

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::BulkUploadResult` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::BulkUploadResult`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'total')
    self.total = attributes[:'total']
  end

  if attributes.key?(:'valid')
    self.valid = attributes[:'valid']
  end

  if attributes.key?(:'invalid')
    self.invalid = attributes[:'invalid']
  end

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

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

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

Instance Attribute Details

#invalid ⇒ Object

Count of rows that failed (total - valid)



26
27
28
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 26

def invalid
  @invalid
end

#rate_limited_accounts ⇒ Object

Present only when one or more rows targeted an account currently in cooldown. Lets callers map rate_limited:* row errors back to structured metadata without parsing the error strings.



35
36
37
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 35

def rate_limited_accounts
  @rate_limited_accounts
end

#results ⇒ Object

One entry per CSV data row, in row order.



29
30
31
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 29

def results
  @results
end

#total ⇒ Object

Number of data rows processed from the CSV



20
21
22
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 20

def total
  @total
end

#valid ⇒ Object

Count of rows that succeeded (results.ok === true)



23
24
25
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 23

def valid
  @valid
end

#warnings ⇒ Object

Top-level advisory warnings (e.g. rows_exceed_advisory_limit:500). Empty when none.



32
33
34
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 32

def warnings
  @warnings
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



50
51
52
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 50

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



55
56
57
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 55

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 38

def self.attribute_map
  {
    :'total' => :'total',
    :'valid' => :'valid',
    :'invalid' => :'invalid',
    :'results' => :'results',
    :'warnings' => :'warnings',
    :'rate_limited_accounts' => :'rateLimitedAccounts'
  }
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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 167

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



72
73
74
75
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 72

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 60

def self.openapi_types
  {
    :'total' => :'Integer',
    :'valid' => :'Integer',
    :'invalid' => :'Integer',
    :'results' => :'Array<BulkUploadResultResultsInner>',
    :'warnings' => :'Array<String>',
    :'rate_limited_accounts' => :'Array<BulkUploadResultRateLimitedAccountsInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



141
142
143
144
145
146
147
148
149
150
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 141

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total == o.total &&
      valid == o.valid &&
      invalid == o.invalid &&
      results == o.results &&
      warnings == o.warnings &&
      rate_limited_accounts == o.rate_limited_accounts
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


154
155
156
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 154

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



160
161
162
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 160

def hash
  [total, valid, invalid, results, warnings, rate_limited_accounts].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



126
127
128
129
130
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 126

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 189

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



134
135
136
137
 
# File 'lib/zernio-sdk/models/bulk_upload_result.rb', line 134

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end