Class: VeniceClient::BillingUsageResponseData

Inherits:
Object
  • Object
show all
Defined in:
lib/venice_client/models/billing_usage_response_data.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BillingUsageResponseData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 97

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

The total amount charged for the billing usage entry



17
18
19
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 17

def amount
  @amount
end

#currency ⇒ Object

The currency charged for the billing usage entry



20
21
22
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 20

def currency
  @currency
end

#inference_details ⇒ Object

Returns the value of attribute inference_details.



22
23
24
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 22

def inference_details
  @inference_details
end

#notes ⇒ Object

Notes about the billing usage entry



25
26
27
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 25

def notes
  @notes
end

#price_per_unit_usd ⇒ Object

The price per unit in USD



28
29
30
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 28

def price_per_unit_usd
  @price_per_unit_usd
end

#sku ⇒ Object

The product associated with the billing usage entry



31
32
33
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 31

def sku
  @sku
end

#timestamp ⇒ Object

The timestamp the billing usage entry was created



34
35
36
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 34

def timestamp
  @timestamp
end

#units ⇒ Object

The number of units consumed



37
38
39
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 37

def units
  @units
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 62

def self.attribute_map
  {
    :'amount' => :'amount',
    :'currency' => :'currency',
    :'inference_details' => :'inferenceDetails',
    :'notes' => :'notes',
    :'price_per_unit_usd' => :'pricePerUnitUsd',
    :'sku' => :'sku',
    :'timestamp' => :'timestamp',
    :'units' => :'units'
  }
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



238
239
240
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 238

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



90
91
92
93
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 90

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

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 76

def self.openapi_types
  {
    :'amount' => :'Object',
    :'currency' => :'Object',
    :'inference_details' => :'Object',
    :'notes' => :'Object',
    :'price_per_unit_usd' => :'Object',
    :'sku' => :'Object',
    :'timestamp' => :'Object',
    :'units' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 210

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      currency == o.currency &&
      inference_details == o.inference_details &&
      notes == o.notes &&
      price_per_unit_usd == o.price_per_unit_usd &&
      sku == o.sku &&
      timestamp == o.timestamp &&
      units == o.units
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



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
296
297
298
299
300
301
302
303
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 268

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
    VeniceClient.const_get(type).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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 337

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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 245

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


225
226
227
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 225

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



231
232
233
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 231

def hash
  [amount, currency, inference_details, notes, price_per_unit_usd, sku, timestamp, units].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



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
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 145

def list_invalid_properties
  invalid_properties = Array.new
  if @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

  if @currency.nil?
    invalid_properties.push('invalid value for "currency", currency cannot be nil.')
  end

  if @inference_details.nil?
    invalid_properties.push('invalid value for "inference_details", inference_details cannot be nil.')
  end

  if @notes.nil?
    invalid_properties.push('invalid value for "notes", notes cannot be nil.')
  end

  if @price_per_unit_usd.nil?
    invalid_properties.push('invalid value for "price_per_unit_usd", price_per_unit_usd cannot be nil.')
  end

  if @sku.nil?
    invalid_properties.push('invalid value for "sku", sku cannot be nil.')
  end

  if @timestamp.nil?
    invalid_properties.push('invalid value for "timestamp", timestamp cannot be nil.')
  end

  if @units.nil?
    invalid_properties.push('invalid value for "units", units cannot be nil.')
  end

  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



313
314
315
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 313

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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 319

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



307
308
309
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 307

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



184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/venice_client/models/billing_usage_response_data.rb', line 184

def valid?
  return false if @amount.nil?
  return false if @currency.nil?
  currency_validator = EnumAttributeValidator.new('Object', ['USD', 'VCU'])
  return false unless currency_validator.valid?(@currency)
  return false if @inference_details.nil?
  return false if @notes.nil?
  return false if @price_per_unit_usd.nil?
  return false if @sku.nil?
  return false if @timestamp.nil?
  return false if @units.nil?
  true
end