pnap_billing_api 2.0.0 → 2.1.1

data/lib/pnap_billing_api/models/operating_system_record.rb

@@ -18,7 +18,6 @@ module BillingApi
     # The unique identifier of the rated usage record.
     attr_accessor :id
 
-    # The category of the product associated with this usage record.
     attr_accessor :product_category
 
     # The code identifying the product associated to this usage record.
@@ -70,6 +69,8 @@ module BillingApi
 
     attr_accessor :discount_details
 
+    attr_accessor :credit_details
+
     attr_accessor :metadata
 
     class EnumAttributeValidator
@@ -116,6 +117,7 @@ module BillingApi
         :'correlation_id' => :'correlationId',
         :'reservation_id' => :'reservationId',
         :'discount_details' => :'discountDetails',
+        :'credit_details' => :'creditDetails',
         :'metadata' => :'metadata'
       }
     end
@@ -129,7 +131,7 @@ module BillingApi
     def self.openapi_types
       {
         :'id' => :'String',
-        :'product_category' => :'String',
+        :'product_category' => :'RatedUsageProductCategoryEnum',
         :'product_code' => :'String',
         :'location' => :'LocationEnum',
         :'year_month' => :'String',
@@ -146,7 +148,8 @@ module BillingApi
         :'usage_session_id' => :'String',
         :'correlation_id' => :'String',
         :'reservation_id' => :'String',
-        :'discount_details' => :'DiscountDetails',
+        :'discount_details' => :'ApplicableDiscountDetails',
+        :'credit_details' => :'Array<CreditDetails>',
         :'metadata' => :'OperatingSystemDetails'
       }
     end
@@ -283,6 +286,12 @@ module BillingApi
         self.discount_details = attributes[:'discount_details']
       end
 
+      if attributes.key?(:'credit_details')
+        if (value = attributes[:'credit_details']).is_a?(Array)
+          self.credit_details = value
+        end
+      end
+
       if attributes.key?(:'metadata')
         self.metadata = attributes[:'metadata']
       else
@@ -364,8 +373,6 @@ module BillingApi
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @id.nil?
       return false if @product_category.nil?
-      product_category_validator = EnumAttributeValidator.new('String', ["bmc-server", "bandwidth", "operating-system", "public-ip", "storage"])
-      return false unless product_category_validator.valid?(@product_category)
       return false if @product_code.nil?
       return false if @location.nil?
       return false if @start_date_time.nil?
@@ -382,16 +389,6 @@ module BillingApi
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] product_category Object to be assigned
-    def product_category=(product_category)
-      validator = EnumAttributeValidator.new('String', ["bmc-server", "bandwidth", "operating-system", "public-ip", "storage"])
-      unless validator.valid?(product_category)
-        fail ArgumentError, "invalid value for \"product_category\", must be one of #{validator.allowable_values}."
-      end
-      @product_category = product_category
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -416,6 +413,7 @@ module BillingApi
           correlation_id == o.correlation_id &&
           reservation_id == o.reservation_id &&
           discount_details == o.discount_details &&
+          credit_details == o.credit_details &&
           metadata == o.metadata
     end
 
@@ -428,7 +426,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, metadata].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, metadata].hash
     end
 
     # Builds the object from hash

data/lib/pnap_billing_api/models/promo_credit_details.rb

@@ -0,0 +1,301 @@
+=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
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module BillingApi
+  class PromoCreditDetails
+    # Amount applied.
+    attr_accessor :applied_amount
+
+    attr_accessor :type
+
+    # Coupon id which is the source of the promo credit.
+    attr_accessor :coupon_id
+
+    # Coupon code which is the source of the promo credit.
+    attr_accessor :coupon_code
+
+    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
+      {
+        :'applied_amount' => :'appliedAmount',
+        :'type' => :'type',
+        :'coupon_id' => :'couponId',
+        :'coupon_code' => :'couponCode'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'applied_amount' => :'Float',
+        :'type' => :'CreditTypeEnum',
+        :'coupon_id' => :'String',
+        :'coupon_code' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'CreditDetailsBase'
+      ]
+    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::PromoCreditDetails` 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::PromoCreditDetails`. 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?(:'applied_amount')
+        self.applied_amount = attributes[:'applied_amount']
+      else
+        self.applied_amount = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'coupon_id')
+        self.coupon_id = attributes[:'coupon_id']
+      else
+        self.coupon_id = nil
+      end
+
+      if attributes.key?(:'coupon_code')
+        self.coupon_code = attributes[:'coupon_code']
+      else
+        self.coupon_code = 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 @applied_amount.nil?
+        invalid_properties.push('invalid value for "applied_amount", applied_amount cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @coupon_id.nil?
+        invalid_properties.push('invalid value for "coupon_id", coupon_id cannot be nil.')
+      end
+
+      if @coupon_code.nil?
+        invalid_properties.push('invalid value for "coupon_code", coupon_code 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 @applied_amount.nil?
+      return false if @type.nil?
+      return false if @coupon_id.nil?
+      return false if @coupon_code.nil?
+      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 &&
+          applied_amount == o.applied_amount &&
+          type == o.type &&
+          coupon_id == o.coupon_id &&
+          coupon_code == o.coupon_code
+    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
+      [applied_amount, type, coupon_id, coupon_code].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
+
+    # 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
+      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
+
+    # 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/public_subnet_record.rb

@@ -18,7 +18,6 @@ module BillingApi
     # The unique identifier of the rated usage record.
     attr_accessor :id
 
-    # The category of the product associated with this usage record.
     attr_accessor :product_category
 
     # The code identifying the product associated to this usage record.
@@ -70,6 +69,8 @@ module BillingApi
 
     attr_accessor :discount_details
 
+    attr_accessor :credit_details
+
     attr_accessor :metadata
 
     class EnumAttributeValidator
@@ -116,6 +117,7 @@ module BillingApi
         :'correlation_id' => :'correlationId',
         :'reservation_id' => :'reservationId',
         :'discount_details' => :'discountDetails',
+        :'credit_details' => :'creditDetails',
         :'metadata' => :'metadata'
       }
     end
@@ -129,7 +131,7 @@ module BillingApi
     def self.openapi_types
       {
         :'id' => :'String',
-        :'product_category' => :'String',
+        :'product_category' => :'RatedUsageProductCategoryEnum',
         :'product_code' => :'String',
         :'location' => :'LocationEnum',
         :'year_month' => :'String',
@@ -146,7 +148,8 @@ module BillingApi
         :'usage_session_id' => :'String',
         :'correlation_id' => :'String',
         :'reservation_id' => :'String',
-        :'discount_details' => :'DiscountDetails',
+        :'discount_details' => :'ApplicableDiscountDetails',
+        :'credit_details' => :'Array<CreditDetails>',
         :'metadata' => :'PublicSubnetDetails'
       }
     end
@@ -283,6 +286,12 @@ module BillingApi
         self.discount_details = attributes[:'discount_details']
       end
 
+      if attributes.key?(:'credit_details')
+        if (value = attributes[:'credit_details']).is_a?(Array)
+          self.credit_details = value
+        end
+      end
+
       if attributes.key?(:'metadata')
         self.metadata = attributes[:'metadata']
       else
@@ -364,8 +373,6 @@ module BillingApi
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @id.nil?
       return false if @product_category.nil?
-      product_category_validator = EnumAttributeValidator.new('String', ["bmc-server", "bandwidth", "operating-system", "public-ip", "storage"])
-      return false unless product_category_validator.valid?(@product_category)
       return false if @product_code.nil?
       return false if @location.nil?
       return false if @start_date_time.nil?
@@ -382,16 +389,6 @@ module BillingApi
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] product_category Object to be assigned
-    def product_category=(product_category)
-      validator = EnumAttributeValidator.new('String', ["bmc-server", "bandwidth", "operating-system", "public-ip", "storage"])
-      unless validator.valid?(product_category)
-        fail ArgumentError, "invalid value for \"product_category\", must be one of #{validator.allowable_values}."
-      end
-      @product_category = product_category
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -416,6 +413,7 @@ module BillingApi
           correlation_id == o.correlation_id &&
           reservation_id == o.reservation_id &&
           discount_details == o.discount_details &&
+          credit_details == o.credit_details &&
           metadata == o.metadata
     end
 
@@ -428,7 +426,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, metadata].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, metadata].hash
     end
 
     # Builds the object from hash

data/lib/pnap_billing_api/models/rated_usage_product_category_enum.rb

@@ -0,0 +1,43 @@
+=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
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module BillingApi
+  class RatedUsageProductCategoryEnum
+    BMC_SERVER = "bmc-server".freeze
+    BANDWIDTH = "bandwidth".freeze
+    OPERATING_SYSTEM = "operating-system".freeze
+    PUBLIC_IP = "public-ip".freeze
+    STORAGE = "storage".freeze
+
+    def self.all_vars
+      @all_vars ||= [BMC_SERVER, BANDWIDTH, OPERATING_SYSTEM, PUBLIC_IP, STORAGE].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 RatedUsageProductCategoryEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #RatedUsageProductCategoryEnum"
+    end
+  end
+end

data/lib/pnap_billing_api/models/rated_usage_record.rb

@@ -19,7 +19,6 @@ module BillingApi
     # The unique identifier of the rated usage record.
     attr_accessor :id
 
-    # The category of the product associated with this usage record.
     attr_accessor :product_category
 
     # The code identifying the product associated to this usage record.
@@ -71,6 +70,8 @@ module BillingApi
 
     attr_accessor :discount_details
 
+    attr_accessor :credit_details
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -114,7 +115,8 @@ module BillingApi
         :'usage_session_id' => :'usageSessionId',
         :'correlation_id' => :'correlationId',
         :'reservation_id' => :'reservationId',
-        :'discount_details' => :'discountDetails'
+        :'discount_details' => :'discountDetails',
+        :'credit_details' => :'creditDetails'
       }
     end
 
@@ -127,7 +129,7 @@ module BillingApi
     def self.openapi_types
       {
         :'id' => :'String',
-        :'product_category' => :'String',
+        :'product_category' => :'RatedUsageProductCategoryEnum',
         :'product_code' => :'String',
         :'location' => :'LocationEnum',
         :'year_month' => :'String',
@@ -144,7 +146,8 @@ module BillingApi
         :'usage_session_id' => :'String',
         :'correlation_id' => :'String',
         :'reservation_id' => :'String',
-        :'discount_details' => :'DiscountDetails'
+        :'discount_details' => :'ApplicableDiscountDetails',
+        :'credit_details' => :'Array<CreditDetails>'
       }
     end
 
@@ -272,6 +275,12 @@ module BillingApi
       if attributes.key?(:'discount_details')
         self.discount_details = attributes[:'discount_details']
       end
+
+      if attributes.key?(:'credit_details')
+        if (value = attributes[:'credit_details']).is_a?(Array)
+          self.credit_details = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -344,8 +353,6 @@ module BillingApi
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @id.nil?
       return false if @product_category.nil?
-      product_category_validator = EnumAttributeValidator.new('String', ["bmc-server", "bandwidth", "operating-system", "public-ip", "storage"])
-      return false unless product_category_validator.valid?(@product_category)
       return false if @product_code.nil?
       return false if @location.nil?
       return false if @start_date_time.nil?
@@ -361,16 +368,6 @@ module BillingApi
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] product_category Object to be assigned
-    def product_category=(product_category)
-      validator = EnumAttributeValidator.new('String', ["bmc-server", "bandwidth", "operating-system", "public-ip", "storage"])
-      unless validator.valid?(product_category)
-        fail ArgumentError, "invalid value for \"product_category\", must be one of #{validator.allowable_values}."
-      end
-      @product_category = product_category
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -394,7 +391,8 @@ module BillingApi
           usage_session_id == o.usage_session_id &&
           correlation_id == o.correlation_id &&
           reservation_id == o.reservation_id &&
-          discount_details == o.discount_details
+          discount_details == o.discount_details &&
+          credit_details == o.credit_details
     end
 
     # @see the `==` method
@@ -406,7 +404,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].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
     end
 
     # Builds the object from hash