Class: XeroRuby::AppStore::UsageRecord

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/app_store/usage_record.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UsageRecord

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 73

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::AppStore::UsageRecord` 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 `XeroRuby::AppStore::UsageRecord`. 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?(:'quantity')
    self.quantity = attributes[:'quantity']
  end

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

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

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

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

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

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

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

Instance Attribute Details

#price_per_unit ⇒ Object

The price per unit



38
39
40
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 38

def price_per_unit
  @price_per_unit
end

#product_id ⇒ Object

The unique identifier of the linked Product



41
42
43
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 41

def product_id
  @product_id
end

#quantity ⇒ Object

The quantity recorded



20
21
22
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 20

def quantity
  @quantity
end

#recorded_at ⇒ Object

The time when this usage was recorded in UTC



32
33
34
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 32

def recorded_at
  @recorded_at
end

#subscription_id ⇒ Object

The unique identifier of the Subscription.



23
24
25
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 23

def subscription_id
  @subscription_id
end

#subscription_item_id ⇒ Object

The unique identifier of the SubscriptionItem.



26
27
28
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 26

def subscription_item_id
  @subscription_item_id
end

#test_mode ⇒ Object

If the subscription is a test subscription



29
30
31
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 29

def test_mode
  @test_mode
end

#usage_record_id ⇒ Object

The unique identifier of the usageRecord.



35
36
37
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 35

def usage_record_id
  @usage_record_id
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 44

def self.attribute_map
  {
    :'quantity' => :'quantity',
    :'subscription_id' => :'subscriptionId',
    :'subscription_item_id' => :'subscriptionItemId',
    :'test_mode' => :'testMode',
    :'recorded_at' => :'recordedAt',
    :'usage_record_id' => :'usageRecordId',
    :'price_per_unit' => :'pricePerUnit',
    :'product_id' => :'productId'
  }
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



202
203
204
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 202

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

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 58

def self.openapi_types
  {
    :'quantity' => :'Integer',
    :'subscription_id' => :'String',
    :'subscription_item_id' => :'String',
    :'test_mode' => :'Boolean',
    :'recorded_at' => :'DateTime',
    :'usage_record_id' => :'String',
    :'price_per_unit' => :'Float',
    :'product_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 174

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      quantity == o.quantity &&
      subscription_id == o.subscription_id &&
      subscription_item_id == o.subscription_item_id &&
      test_mode == o.test_mode &&
      recorded_at == o.recorded_at &&
      usage_record_id == o.usage_record_id &&
      price_per_unit == o.price_per_unit &&
      product_id == o.product_id
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



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
264
265
266
267
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 230

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(parse_date(value))
  when :Date
    Date.parse(parse_date(value))
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BigDecimal
    BigDecimal(value.to_s)
  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
    XeroRuby::AppStore.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value, downcase: false) ⇒ 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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 303

def _to_hash(value, downcase: false)
  if value.is_a?(Array)
    value.map do |v|
      v.to_hash(downcase: downcase)
    end
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(downcase: downcase)
  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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 209

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]]))
    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


189
190
191
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 189

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



195
196
197
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 195

def hash
  [quantity, subscription_id, subscription_item_id, test_mode, recorded_at, usage_record_id, price_per_unit, product_id].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



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/xero-ruby/models/app_store/usage_record.rb', line 121

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

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

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

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

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

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

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

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

  invalid_properties
end

#parse_date(datestring) ⇒ Object 



319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 319

def parse_date(datestring)
  if datestring.include?('Date')
    date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
    original, date, timezone = *date_pattern.match(datestring)
    date = (date.to_i / 1000)
    Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
  elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
    Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
  else # handle date 'types' for small subset of payroll API's
    Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
  end
end

#to_attributes ⇒ Object

Returns the object in the form of hash with snake_case



295
296
297
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 295

def to_attributes
  to_hash(downcase: true)
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



277
278
279
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 277

def to_body
  to_hash
end

#to_hash(downcase: false) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



283
284
285
286
287
288
289
290
291
292
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 283

def to_hash(downcase: false)
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    key = downcase ? attr : param
    hash[key] = _to_hash(value, downcase: downcase)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



271
272
273
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 271

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



160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/xero-ruby/models/app_store/usage_record.rb', line 160

def valid?
  return false if @quantity.nil?
  return false if @subscription_id.nil?
  return false if @subscription_item_id.nil?
  return false if @test_mode.nil?
  return false if @recorded_at.nil?
  return false if @usage_record_id.nil?
  return false if @price_per_unit.nil?
  return false if @product_id.nil?
  true
end