Class: BillingApi::Reservation

Inherits:
Object
  • Object
show all
Defined in:
lib/pnap_billing_api/models/reservation.rb

Overview

Reservation details

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Reservation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 141

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

  if attributes.key?(:'product_code')
    self.product_code = attributes[:'product_code']
  else
    self.product_code = nil
  end

  if attributes.key?(:'product_category')
    self.product_category = attributes[:'product_category']
  else
    self.product_category = nil
  end

  if attributes.key?(:'location')
    self.location = attributes[:'location']
  else
    self.location = nil
  end

  if attributes.key?(:'reservation_model')
    self.reservation_model = attributes[:'reservation_model']
  else
    self.reservation_model = nil
  end

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

  if attributes.key?(:'start_date_time')
    self.start_date_time = attributes[:'start_date_time']
  else
    self.start_date_time = nil
  end

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

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

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

  if attributes.key?(:'auto_renew')
    self.auto_renew = attributes[:'auto_renew']
  else
    self.auto_renew = nil
  end

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

  if attributes.key?(:'price')
    self.price = attributes[:'price']
  else
    self.price = nil
  end

  if attributes.key?(:'price_unit')
    self.price_unit = attributes[:'price_unit']
  else
    self.price_unit = nil
  end

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

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

Instance Attribute Details

#assigned_resource_id ⇒ Object

The resource ID currently being assigned to Reservation.



57
58
59
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 57

def assigned_resource_id
  @assigned_resource_id
end

#auto_renew ⇒ Object

A flag indicating whether the reservation will auto-renew (default is true).



46
47
48
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 46

def auto_renew
  @auto_renew
end

#end_date_time ⇒ Object

The point in time (in UTC) when the reservation end.



37
38
39
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 37

def end_date_time
  @end_date_time
end

#id ⇒ Object

The reservation identifier.



20
21
22
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 20

def id
  @id
end

#initial_invoice_model ⇒ Object

Returns the value of attribute initial_invoice_model.



31
32
33
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 31

def initial_invoice_model
  @initial_invoice_model
end

#last_renewal_date_time ⇒ Object

The point in time (in UTC) when the reservation was renewed last.



40
41
42
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 40

def last_renewal_date_time
  @last_renewal_date_time
end

#location ⇒ Object

Returns the value of attribute location.



27
28
29
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 27

def location
  @location
end

#next_billing_date ⇒ Object

Next billing date for Reservation.



60
61
62
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 60

def next_billing_date
  @next_billing_date
end

#next_renewal_date_time ⇒ Object

The point in time (in UTC) when the reservation will be renewed if auto renew is set to true.



43
44
45
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 43

def next_renewal_date_time
  @next_renewal_date_time
end

#price ⇒ Object

Reservation price.



52
53
54
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 52

def price
  @price
end

#price_unit ⇒ Object

Returns the value of attribute price_unit.



54
55
56
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 54

def price_unit
  @price_unit
end

#product_category ⇒ Object

Returns the value of attribute product_category.



25
26
27
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 25

def product_category
  @product_category
end

#product_code ⇒ Object

The code identifying the product. This code has significant across all locations.



23
24
25
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 23

def product_code
  @product_code
end

#reservation_model ⇒ Object

Returns the value of attribute reservation_model.



29
30
31
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 29

def reservation_model
  @reservation_model
end

#sku ⇒ Object

The sku that will be applied to this reservation. It is useful to find out the price by querying the /product endpoint.



49
50
51
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 49

def sku
  @sku
end

#start_date_time ⇒ Object

The point in time (in UTC) when the reservation starts.



34
35
36
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 34

def start_date_time
  @start_date_time
end

Class Method Details

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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 366

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = BillingApi.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



107
108
109
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 107

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 85

def self.attribute_map
  {
    :'id' => :'id',
    :'product_code' => :'productCode',
    :'product_category' => :'productCategory',
    :'location' => :'location',
    :'reservation_model' => :'reservationModel',
    :'initial_invoice_model' => :'initialInvoiceModel',
    :'start_date_time' => :'startDateTime',
    :'end_date_time' => :'endDateTime',
    :'last_renewal_date_time' => :'lastRenewalDateTime',
    :'next_renewal_date_time' => :'nextRenewalDateTime',
    :'auto_renew' => :'autoRenew',
    :'sku' => :'sku',
    :'price' => :'price',
    :'price_unit' => :'priceUnit',
    :'assigned_resource_id' => :'assignedResourceId',
    :'next_billing_date' => :'nextBillingDate'
  }
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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 342

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



134
135
136
137
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 134

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

.openapi_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 112

def self.openapi_types
  {
    :'id' => :'String',
    :'product_code' => :'String',
    :'product_category' => :'ReservationProductCategoryEnum',
    :'location' => :'LocationEnum',
    :'reservation_model' => :'ReservationModelEnum',
    :'initial_invoice_model' => :'ReservationInvoicingModelEnum',
    :'start_date_time' => :'Time',
    :'end_date_time' => :'Time',
    :'last_renewal_date_time' => :'Time',
    :'next_renewal_date_time' => :'Time',
    :'auto_renew' => :'Boolean',
    :'sku' => :'String',
    :'price' => :'Float',
    :'price_unit' => :'PriceUnitEnum',
    :'assigned_resource_id' => :'String',
    :'next_billing_date' => :'Date'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 306

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      product_code == o.product_code &&
      product_category == o.product_category &&
      location == o.location &&
      reservation_model == o.reservation_model &&
      initial_invoice_model == o.initial_invoice_model &&
      start_date_time == o.start_date_time &&
      end_date_time == o.end_date_time &&
      last_renewal_date_time == o.last_renewal_date_time &&
      next_renewal_date_time == o.next_renewal_date_time &&
      auto_renew == o.auto_renew &&
      sku == o.sku &&
      price == o.price &&
      price_unit == o.price_unit &&
      assigned_resource_id == o.assigned_resource_id &&
      next_billing_date == o.next_billing_date
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



437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 437

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


329
330
331
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 329

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



335
336
337
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 335

def hash
  [id, product_code, product_category, location, reservation_model, initial_invoice_model, start_date_time, end_date_time, last_renewal_date_time, next_renewal_date_time, auto_renew, sku, price, price_unit, assigned_resource_id, next_billing_date].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



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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 241

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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

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

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

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

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

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

  if @price_unit.nil?
    invalid_properties.push('invalid value for "price_unit", price_unit 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



413
414
415
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 413

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



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 419

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



407
408
409
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 407

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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/pnap_billing_api/models/reservation.rb', line 289

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @product_code.nil?
  return false if @product_category.nil?
  return false if @location.nil?
  return false if @reservation_model.nil?
  return false if @start_date_time.nil?
  return false if @auto_renew.nil?
  return false if @sku.nil?
  return false if @price.nil?
  return false if @price_unit.nil?
  true
end