pnap_billing_api 2.1.2 → 3.0.1

data/lib/pnap_billing_api/models/reservation.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1
 Contact: support@phoenixnap.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.2.0
+Generator version: 7.20.0
 
 =end
 
@@ -15,11 +15,11 @@ require 'time'
 
 module BillingApi
   # Reservation details
-  class Reservation
+  class Reservation < ApiModelBase
     # The reservation identifier.
     attr_accessor :id
 
-    # The code identifying the product. This code has significant across all locations.
+    # The code identifying the product. The same code is used for this product across all locations.
     attr_accessor :product_code
 
     attr_accessor :product_category
@@ -28,8 +28,14 @@ module BillingApi
 
     attr_accessor :reservation_model
 
+    attr_accessor :term
+
+    attr_accessor :reservation_state
+
     attr_accessor :initial_invoice_model
 
+    attr_accessor :quantity
+
     # The point in time (in UTC) when the reservation starts.
     attr_accessor :start_date_time
 
@@ -59,6 +65,8 @@ module BillingApi
     # Next billing date for Reservation.
     attr_accessor :next_billing_date
 
+    attr_accessor :utilization
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -89,7 +97,10 @@ module BillingApi
         :'product_category' => :'productCategory',
         :'location' => :'location',
         :'reservation_model' => :'reservationModel',
+        :'term' => :'term',
+        :'reservation_state' => :'reservationState',
         :'initial_invoice_model' => :'initialInvoiceModel',
+        :'quantity' => :'quantity',
         :'start_date_time' => :'startDateTime',
         :'end_date_time' => :'endDateTime',
         :'last_renewal_date_time' => :'lastRenewalDateTime',
@@ -99,13 +110,19 @@ module BillingApi
         :'price' => :'price',
         :'price_unit' => :'priceUnit',
         :'assigned_resource_id' => :'assignedResourceId',
-        :'next_billing_date' => :'nextBillingDate'
+        :'next_billing_date' => :'nextBillingDate',
+        :'utilization' => :'utilization'
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      attribute_map.values
+      acceptable_attribute_map.values
     end
 
     # Attribute type mapping.
@@ -116,7 +133,10 @@ module BillingApi
         :'product_category' => :'ReservationProductCategoryEnum',
         :'location' => :'LocationEnum',
         :'reservation_model' => :'ReservationModelEnum',
+        :'term' => :'ReservationTerm',
+        :'reservation_state' => :'ReservationStateEnum',
         :'initial_invoice_model' => :'ReservationInvoicingModelEnum',
+        :'quantity' => :'Quantity',
         :'start_date_time' => :'Time',
         :'end_date_time' => :'Time',
         :'last_renewal_date_time' => :'Time',
@@ -126,7 +146,8 @@ module BillingApi
         :'price' => :'Float',
         :'price_unit' => :'PriceUnitEnum',
         :'assigned_resource_id' => :'String',
-        :'next_billing_date' => :'Date'
+        :'next_billing_date' => :'Date',
+        :'utilization' => :'Utilization'
       }
     end
 
@@ -144,9 +165,10 @@ module BillingApi
       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 (!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
+        if (!acceptable_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: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -181,10 +203,26 @@ module BillingApi
         self.reservation_model = nil
       end
 
+      if attributes.key?(:'term')
+        self.term = attributes[:'term']
+      end
+
+      if attributes.key?(:'reservation_state')
+        self.reservation_state = attributes[:'reservation_state']
+      else
+        self.reservation_state = nil
+      end
+
       if attributes.key?(:'initial_invoice_model')
         self.initial_invoice_model = attributes[:'initial_invoice_model']
       end
 
+      if attributes.key?(:'quantity')
+        self.quantity = attributes[:'quantity']
+      else
+        self.quantity = nil
+      end
+
       if attributes.key?(:'start_date_time')
         self.start_date_time = attributes[:'start_date_time']
       else
@@ -234,6 +272,10 @@ module BillingApi
       if attributes.key?(:'next_billing_date')
         self.next_billing_date = attributes[:'next_billing_date']
       end
+
+      if attributes.key?(:'utilization')
+        self.utilization = attributes[:'utilization']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -261,6 +303,14 @@ module BillingApi
         invalid_properties.push('invalid value for "reservation_model", reservation_model cannot be nil.')
       end
 
+      if @reservation_state.nil?
+        invalid_properties.push('invalid value for "reservation_state", reservation_state cannot be nil.')
+      end
+
+      if @quantity.nil?
+        invalid_properties.push('invalid value for "quantity", quantity 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
@@ -293,6 +343,8 @@ module BillingApi
       return false if @product_category.nil?
       return false if @location.nil?
       return false if @reservation_model.nil?
+      return false if @reservation_state.nil?
+      return false if @quantity.nil?
       return false if @start_date_time.nil?
       return false if @auto_renew.nil?
       return false if @sku.nil?
@@ -301,6 +353,126 @@ module BillingApi
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] product_code Value to be assigned
+    def product_code=(product_code)
+      if product_code.nil?
+        fail ArgumentError, 'product_code cannot be nil'
+      end
+
+      @product_code = product_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] product_category Value to be assigned
+    def product_category=(product_category)
+      if product_category.nil?
+        fail ArgumentError, 'product_category cannot be nil'
+      end
+
+      @product_category = product_category
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] location Value to be assigned
+    def location=(location)
+      if location.nil?
+        fail ArgumentError, 'location cannot be nil'
+      end
+
+      @location = location
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reservation_model Value to be assigned
+    def reservation_model=(reservation_model)
+      if reservation_model.nil?
+        fail ArgumentError, 'reservation_model cannot be nil'
+      end
+
+      @reservation_model = reservation_model
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reservation_state Value to be assigned
+    def reservation_state=(reservation_state)
+      if reservation_state.nil?
+        fail ArgumentError, 'reservation_state cannot be nil'
+      end
+
+      @reservation_state = reservation_state
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] quantity Value to be assigned
+    def quantity=(quantity)
+      if quantity.nil?
+        fail ArgumentError, 'quantity cannot be nil'
+      end
+
+      @quantity = quantity
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] start_date_time Value to be assigned
+    def start_date_time=(start_date_time)
+      if start_date_time.nil?
+        fail ArgumentError, 'start_date_time cannot be nil'
+      end
+
+      @start_date_time = start_date_time
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] auto_renew Value to be assigned
+    def auto_renew=(auto_renew)
+      if auto_renew.nil?
+        fail ArgumentError, 'auto_renew cannot be nil'
+      end
+
+      @auto_renew = auto_renew
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sku Value to be assigned
+    def sku=(sku)
+      if sku.nil?
+        fail ArgumentError, 'sku cannot be nil'
+      end
+
+      @sku = sku
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] price Value to be assigned
+    def price=(price)
+      if price.nil?
+        fail ArgumentError, 'price cannot be nil'
+      end
+
+      @price = price
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] price_unit Value to be assigned
+    def price_unit=(price_unit)
+      if price_unit.nil?
+        fail ArgumentError, 'price_unit cannot be nil'
+      end
+
+      @price_unit = price_unit
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -311,7 +483,10 @@ module BillingApi
           product_category == o.product_category &&
           location == o.location &&
           reservation_model == o.reservation_model &&
+          term == o.term &&
+          reservation_state == o.reservation_state &&
           initial_invoice_model == o.initial_invoice_model &&
+          quantity == o.quantity &&
           start_date_time == o.start_date_time &&
           end_date_time == o.end_date_time &&
           last_renewal_date_time == o.last_renewal_date_time &&
@@ -321,7 +496,8 @@ module BillingApi
           price == o.price &&
           price_unit == o.price_unit &&
           assigned_resource_id == o.assigned_resource_id &&
-          next_billing_date == o.next_billing_date
+          next_billing_date == o.next_billing_date &&
+          utilization == o.utilization
     end
 
     # @see the `==` method
@@ -333,7 +509,7 @@ module BillingApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     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
+      [id, product_code, product_category, location, reservation_model, term, reservation_state, initial_invoice_model, quantity, 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, utilization].hash
     end
 
     # Builds the object from hash
@@ -359,61 +535,6 @@ module BillingApi
       new(transformed_hash)
     end
 
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    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
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
     def to_hash
@@ -430,24 +551,6 @@ module BillingApi
       hash
     end
 
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    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
-
   end
 
 end

data/lib/pnap_billing_api/models/reservation_auto_renew_disable_request.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1
 Contact: support@phoenixnap.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.2.0
+Generator version: 7.20.0
 
 =end
 
@@ -15,7 +15,7 @@ require 'time'
 
 module BillingApi
   # Disabling auto-renewal for reservation request.
-  class ReservationAutoRenewDisableRequest
+  class ReservationAutoRenewDisableRequest < ApiModelBase
     attr_accessor :auto_renew_disable_reason
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -25,9 +25,14 @@ module BillingApi
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      attribute_map.values
+      acceptable_attribute_map.values
     end
 
     # Attribute type mapping.
@@ -51,9 +56,10 @@ module BillingApi
       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 (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `BillingApi::ReservationAutoRenewDisableRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `BillingApi::ReservationAutoRenewDisableRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -121,61 +127,6 @@ module BillingApi
       new(transformed_hash)
     end
 
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    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
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
     def to_hash
@@ -192,24 +143,6 @@ module BillingApi
       hash
     end
 
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    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
-
   end
 
 end

data/lib/pnap_billing_api/models/reservation_details.rb

@@ -0,0 +1,158 @@
+=begin
+#Billing API
+
+#Automate your infrastructure billing with the Bare Metal Cloud Billing API. Reserve your server instances to ensure guaranteed resource availability for 12, 24, and 36 months. Retrieve your server’s rated usage for a given period and enable or disable auto-renewals.<br> <br> <span class='pnap-api-knowledge-base-link'> Knowledge base articles to help you can be found <a href='https://phoenixnap.com/kb/phoenixnap-bare-metal-cloud-billing-models' target='_blank'>here</a> </span><br> <br> <b>All URLs are relative to (https://api.phoenixnap.com/billing/v1/)</b> 
+
+The version of the OpenAPI document: 0.1
+Contact: support@phoenixnap.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.20.0
+
+=end
+
+require 'date'
+require 'time'
+
+module BillingApi
+  # Details of a Reservation entry inside Rated Usage.
+  class ReservationDetails < ApiModelBase
+    # The Reservation identifier.
+    attr_accessor :id
+
+    attr_accessor :quantity
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'quantity' => :'quantity'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'quantity' => :'Quantity'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `BillingApi::ReservationDetails` 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 `BillingApi::ReservationDetails`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'quantity')
+        self.quantity = attributes[:'quantity']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          quantity == o.quantity
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, quantity].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+  end
+
+end