pnap_billing_api 2.1.2 → 3.0.0

data/lib/pnap_billing_api/models/quantity.rb

@@ -0,0 +1,223 @@
+=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
+  # Represents the quantity.
+  class Quantity < ApiModelBase
+    # Quantity size.
+    attr_accessor :quantity
+
+    attr_accessor :unit
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'quantity' => :'quantity',
+        :'unit' => :'unit'
+      }
+    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
+      {
+        :'quantity' => :'Float',
+        :'unit' => :'QuantityUnitEnum'
+      }
+    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::Quantity` 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::Quantity`. 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?(:'quantity')
+        self.quantity = attributes[:'quantity']
+      else
+        self.quantity = nil
+      end
+
+      if attributes.key?(:'unit')
+        self.unit = attributes[:'unit']
+      else
+        self.unit = nil
+      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
+      if @quantity.nil?
+        invalid_properties.push('invalid value for "quantity", quantity cannot be nil.')
+      end
+
+      if @quantity < 1
+        invalid_properties.push('invalid value for "quantity", must be greater than or equal to 1.')
+      end
+
+      if @unit.nil?
+        invalid_properties.push('invalid value for "unit", unit cannot be nil.')
+      end
+
+      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'
+      return false if @quantity.nil?
+      return false if @quantity < 1
+      return false if @unit.nil?
+      true
+    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
+
+      if quantity < 1
+        fail ArgumentError, 'invalid value for "quantity", must be greater than or equal to 1.'
+      end
+
+      @quantity = quantity
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] unit Value to be assigned
+    def unit=(unit)
+      if unit.nil?
+        fail ArgumentError, 'unit cannot be nil'
+      end
+
+      @unit = unit
+    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 &&
+          quantity == o.quantity &&
+          unit == o.unit
+    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
+      [quantity, unit].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

data/lib/pnap_billing_api/models/quantity_unit_enum.rb

@@ -0,0 +1,40 @@
+=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
+  class QuantityUnitEnum
+    TB = "TB".freeze
+    COUNT = "COUNT".freeze
+
+    def self.all_vars
+      @all_vars ||= [TB, COUNT].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if QuantityUnitEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #QuantityUnitEnum"
+    end
+  end
+end

data/lib/pnap_billing_api/models/rated_usage_get200_response_inner.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
 
@@ -60,5 +60,4 @@ module BillingApi
       end
     end
   end
-
 end

data/lib/pnap_billing_api/models/rated_usage_product_category_enum.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
 

data/lib/pnap_billing_api/models/rated_usage_record.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
   # Rated usage record.
-  class RatedUsageRecord
+  class RatedUsageRecord < ApiModelBase
     # The unique identifier of the rated usage record.
     attr_accessor :id
 
@@ -68,6 +68,8 @@ module BillingApi
     # Reservation id associated with this rated usage record.
     attr_accessor :reservation_id
 
+    attr_accessor :reservation_details
+
     attr_accessor :discount_details
 
     attr_accessor :credit_details
@@ -115,14 +117,20 @@ module BillingApi
         :'usage_session_id' => :'usageSessionId',
         :'correlation_id' => :'correlationId',
         :'reservation_id' => :'reservationId',
+        :'reservation_details' => :'reservationDetails',
         :'discount_details' => :'discountDetails',
         :'credit_details' => :'creditDetails'
       }
     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.
@@ -146,6 +154,7 @@ module BillingApi
         :'usage_session_id' => :'String',
         :'correlation_id' => :'String',
         :'reservation_id' => :'String',
+        :'reservation_details' => :'ReservationDetails',
         :'discount_details' => :'ApplicableDiscountDetails',
         :'credit_details' => :'Array<CreditDetails>'
       }
@@ -165,9 +174,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::RatedUsageRecord`. 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::RatedUsageRecord`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -258,20 +268,20 @@ module BillingApi
 
       if attributes.key?(:'usage_session_id')
         self.usage_session_id = attributes[:'usage_session_id']
-      else
-        self.usage_session_id = nil
       end
 
       if attributes.key?(:'correlation_id')
         self.correlation_id = attributes[:'correlation_id']
-      else
-        self.correlation_id = nil
       end
 
       if attributes.key?(:'reservation_id')
         self.reservation_id = attributes[:'reservation_id']
       end
 
+      if attributes.key?(:'reservation_details')
+        self.reservation_details = attributes[:'reservation_details']
+      end
+
       if attributes.key?(:'discount_details')
         self.discount_details = attributes[:'discount_details']
       end
@@ -336,14 +346,6 @@ module BillingApi
         invalid_properties.push('invalid value for "active", active cannot be nil.')
       end
 
-      if @usage_session_id.nil?
-        invalid_properties.push('invalid value for "usage_session_id", usage_session_id cannot be nil.')
-      end
-
-      if @correlation_id.nil?
-        invalid_properties.push('invalid value for "correlation_id", correlation_id cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -363,11 +365,129 @@ module BillingApi
       return false if @unit_price_description.nil?
       return false if @quantity.nil?
       return false if @active.nil?
-      return false if @usage_session_id.nil?
-      return false if @correlation_id.nil?
       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_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] 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] 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] 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] end_date_time Value to be assigned
+    def end_date_time=(end_date_time)
+      if end_date_time.nil?
+        fail ArgumentError, 'end_date_time cannot be nil'
+      end
+
+      @end_date_time = end_date_time
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cost Value to be assigned
+    def cost=(cost)
+      if cost.nil?
+        fail ArgumentError, 'cost cannot be nil'
+      end
+
+      @cost = cost
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] price_model Value to be assigned
+    def price_model=(price_model)
+      if price_model.nil?
+        fail ArgumentError, 'price_model cannot be nil'
+      end
+
+      @price_model = price_model
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] unit_price Value to be assigned
+    def unit_price=(unit_price)
+      if unit_price.nil?
+        fail ArgumentError, 'unit_price cannot be nil'
+      end
+
+      @unit_price = unit_price
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] unit_price_description Value to be assigned
+    def unit_price_description=(unit_price_description)
+      if unit_price_description.nil?
+        fail ArgumentError, 'unit_price_description cannot be nil'
+      end
+
+      @unit_price_description = unit_price_description
+    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] active Value to be assigned
+    def active=(active)
+      if active.nil?
+        fail ArgumentError, 'active cannot be nil'
+      end
+
+      @active = active
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -391,6 +511,7 @@ module BillingApi
           usage_session_id == o.usage_session_id &&
           correlation_id == o.correlation_id &&
           reservation_id == o.reservation_id &&
+          reservation_details == o.reservation_details &&
           discount_details == o.discount_details &&
           credit_details == o.credit_details
     end
@@ -404,7 +525,7 @@ module BillingApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, product_category, product_code, location, year_month, start_date_time, end_date_time, cost, cost_before_discount, cost_description, price_model, unit_price, unit_price_description, quantity, active, usage_session_id, correlation_id, reservation_id, discount_details, credit_details].hash
+      [id, product_category, product_code, location, year_month, start_date_time, end_date_time, cost, cost_before_discount, cost_description, price_model, unit_price, unit_price_description, quantity, active, usage_session_id, correlation_id, reservation_id, reservation_details, discount_details, credit_details].hash
     end
 
     # Builds the object from hash
@@ -430,61 +551,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
@@ -501,24 +567,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