togai_client 1.0.0 → 1.0.2

data/lib/togai_client/models/{pricing_cycle_start_offset.rb → bundle.rb}

@@ -14,19 +14,20 @@ require 'date'
 require 'time'
 
 module TogaiClient
-  # Represents the start of pricing cycle in terms of  - dayOffset - number of days from beginning of month and  - monthOffset - number of months from beginning of interval (quarter, half-year or year) Note: If a day with offset doesn't exist for a month, closest previous day is considered Examples: MONTHLY -   - {dayOffset: 1, monthOffset: NIL} - First day of every month   - {dayOffset: 12, monthOffset: NIL} - 12th of every month   - {dayOffset: 28, monthOffset: NIL} - 28th of every month. i.e, 28th of Jan, 28th of Feb, ...   - {dayOffset: 30, monthOffset: NIL} - 30th of every month. i.e, 28th of Jan, 28th of Feb, ...   - {dayOffset: LAST, monthOffset: NIL} - Last day of every month. i.e, 31st of Jan, 28th of Feb, ... QUARTERLY   - {dayOffset: 15, monthOffset: FIRST} - 15th Jan, 15th Apr, 15th Jul and 15th Oct   - {dayOffset: 15, monthOffset: 2} - 15th Feb, 15th May, 15th Aug and 15th Nov   - {dayOffset: 15, monthOffset: LAST} - 15th Mar, 15th Jun, 15th Sep and 15th Dec   - {dayOffset: LAST, monthOffset: FIRST} - 31st Jan, 30th Apr, 30th Jul and 31th Oct HALF_YEARLY   - {dayOffset: 15, monthOffset: FIRST} - 15th Jan and 15th Jul   - {dayOffset: 15, monthOffset: 4} - 15th Apr and 15th Oct   - {dayOffset: 15, monthOffset: LAST} - 15th Jun and 15th Dec ANNUALLY   - {dayOffset: 15, monthOffset: FIRST} - 15th Jan   - {dayOffset: 15, monthOffset: 1} - 15th Jan   - {dayOffset: LAST, monthOffset: 2} - 29th Feb on Leap year, 28th otherwise    - {dayOffset: 15, monthOffset: 8} - 15th Aug   - {dayOffset: 15, monthOffset: LAST} - 15th Dec 
-  class PricingCycleStartOffset
-    # min: \"1\" and max: \"31\" as strings. Spl. string allowed: LAST 
-    attr_accessor :day_offset
+  # TODO
+  class Bundle
+    attr_accessor :display_name
 
-    # min: \"1\" and max: \"12\". Spl. string allowed: FIRST / LAST. For QUARTERLY only 1 - 3 is allowed and for HALF_YEARLY 1 - 6. This being an optional field, shouldn't be passed for MONTHLY. 
-    attr_accessor :month_offset
+    attr_accessor :order
+
+    attr_accessor :rate_configs
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'day_offset' => :'dayOffset',
-        :'month_offset' => :'monthOffset'
+        :'display_name' => :'displayName',
+        :'order' => :'order',
+        :'rate_configs' => :'rateConfigs'
       }
     end
 
@@ -38,8 +39,9 @@ module TogaiClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'day_offset' => :'String',
-        :'month_offset' => :'String'
+        :'display_name' => :'String',
+        :'order' => :'Integer',
+        :'rate_configs' => :'Array<RateConfigBundle>'
       }
     end
 
@@ -53,23 +55,29 @@ module TogaiClient
     # @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 `TogaiClient::PricingCycleStartOffset` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TogaiClient::Bundle` 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 `TogaiClient::PricingCycleStartOffset`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TogaiClient::Bundle`. 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?(:'day_offset')
-        self.day_offset = attributes[:'day_offset']
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      end
+
+      if attributes.key?(:'order')
+        self.order = attributes[:'order']
       end
 
-      if attributes.key?(:'month_offset')
-        self.month_offset = attributes[:'month_offset']
+      if attributes.key?(:'rate_configs')
+        if (value = attributes[:'rate_configs']).is_a?(Array)
+          self.rate_configs = value
+        end
       end
     end
 
@@ -77,12 +85,20 @@ module TogaiClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @day_offset.nil?
-        invalid_properties.push('invalid value for "day_offset", day_offset cannot be nil.')
+      if @display_name.nil?
+        invalid_properties.push('invalid value for "display_name", display_name cannot be nil.')
+      end
+
+      if @order.nil?
+        invalid_properties.push('invalid value for "order", order cannot be nil.')
+      end
+
+      if @rate_configs.nil?
+        invalid_properties.push('invalid value for "rate_configs", rate_configs cannot be nil.')
       end
 
-      if @month_offset.nil?
-        invalid_properties.push('invalid value for "month_offset", month_offset cannot be nil.')
+      if @rate_configs.length < 1
+        invalid_properties.push('invalid value for "rate_configs", number of items must be greater than or equal to 1.')
       end
 
       invalid_properties
@@ -91,18 +107,35 @@ module TogaiClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @day_offset.nil?
-      return false if @month_offset.nil?
+      return false if @display_name.nil?
+      return false if @order.nil?
+      return false if @rate_configs.nil?
+      return false if @rate_configs.length < 1
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] rate_configs Value to be assigned
+    def rate_configs=(rate_configs)
+      if rate_configs.nil?
+        fail ArgumentError, 'rate_configs cannot be nil'
+      end
+
+      if rate_configs.length < 1
+        fail ArgumentError, 'invalid value for "rate_configs", number of items must be greater than or equal to 1.'
+      end
+
+      @rate_configs = rate_configs
+    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 &&
-          day_offset == o.day_offset &&
-          month_offset == o.month_offset
+          display_name == o.display_name &&
+          order == o.order &&
+          rate_configs == o.rate_configs
     end
 
     # @see the `==` method
@@ -114,7 +147,7 @@ module TogaiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [day_offset, month_offset].hash
+      [display_name, order, rate_configs].hash
     end
 
     # Builds the object from hash

data/lib/togai_client/models/calculate_revenue_request.rb

@@ -0,0 +1,297 @@
+=begin
+#Togai Apis
+
+#APIs for Togai App
+
+The version of the OpenAPI document: 1.0
+Contact: engg@togai.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TogaiClient
+  # Request to get revenue details
+  class CalculateRevenueRequest
+    attr_accessor :currency_config
+
+    attr_accessor :price_plan_details_config
+
+    attr_accessor :usage_config
+
+    attr_accessor :license_entries_config
+
+    attr_accessor :named_license_entries_config
+
+    attr_accessor :proration_config
+
+    attr_accessor :entitlement_overage_config
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'currency_config' => :'currencyConfig',
+        :'price_plan_details_config' => :'pricePlanDetailsConfig',
+        :'usage_config' => :'usageConfig',
+        :'license_entries_config' => :'licenseEntriesConfig',
+        :'named_license_entries_config' => :'namedLicenseEntriesConfig',
+        :'proration_config' => :'prorationConfig',
+        :'entitlement_overage_config' => :'entitlementOverageConfig'
+      }
+    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
+      {
+        :'currency_config' => :'CurrencyConfig',
+        :'price_plan_details_config' => :'PricePlanDetailsConfig',
+        :'usage_config' => :'UsageConfig',
+        :'license_entries_config' => :'LicenseEntriesConfig',
+        :'named_license_entries_config' => :'NamedLicenseEntriesConfig',
+        :'proration_config' => :'ProrationConfig',
+        :'entitlement_overage_config' => :'EntitlementOverageConfig'
+      }
+    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 `TogaiClient::CalculateRevenueRequest` 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 `TogaiClient::CalculateRevenueRequest`. 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?(:'currency_config')
+        self.currency_config = attributes[:'currency_config']
+      else
+        self.currency_config = nil
+      end
+
+      if attributes.key?(:'price_plan_details_config')
+        self.price_plan_details_config = attributes[:'price_plan_details_config']
+      else
+        self.price_plan_details_config = nil
+      end
+
+      if attributes.key?(:'usage_config')
+        self.usage_config = attributes[:'usage_config']
+      else
+        self.usage_config = nil
+      end
+
+      if attributes.key?(:'license_entries_config')
+        self.license_entries_config = attributes[:'license_entries_config']
+      else
+        self.license_entries_config = nil
+      end
+
+      if attributes.key?(:'named_license_entries_config')
+        self.named_license_entries_config = attributes[:'named_license_entries_config']
+      end
+
+      if attributes.key?(:'proration_config')
+        self.proration_config = attributes[:'proration_config']
+      end
+
+      if attributes.key?(:'entitlement_overage_config')
+        self.entitlement_overage_config = attributes[:'entitlement_overage_config']
+      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 @currency_config.nil?
+        invalid_properties.push('invalid value for "currency_config", currency_config cannot be nil.')
+      end
+
+      if @price_plan_details_config.nil?
+        invalid_properties.push('invalid value for "price_plan_details_config", price_plan_details_config cannot be nil.')
+      end
+
+      if @usage_config.nil?
+        invalid_properties.push('invalid value for "usage_config", usage_config cannot be nil.')
+      end
+
+      if @license_entries_config.nil?
+        invalid_properties.push('invalid value for "license_entries_config", license_entries_config 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 @currency_config.nil?
+      return false if @price_plan_details_config.nil?
+      return false if @usage_config.nil?
+      return false if @license_entries_config.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 &&
+          currency_config == o.currency_config &&
+          price_plan_details_config == o.price_plan_details_config &&
+          usage_config == o.usage_config &&
+          license_entries_config == o.license_entries_config &&
+          named_license_entries_config == o.named_license_entries_config &&
+          proration_config == o.proration_config &&
+          entitlement_overage_config == o.entitlement_overage_config
+    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
+      [currency_config, price_plan_details_config, usage_config, license_entries_config, named_license_entries_config, proration_config, entitlement_overage_config].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 = TogaiClient.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