togai_client 1.0.1 → 1.0.2

data/lib/togai_client/models/create_usage_meter_request.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0
 Contact: engg@togai.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.1.0
+Generator version: 7.10.0
 
 =end
 
@@ -16,20 +16,28 @@ require 'time'
 module TogaiClient
   # Request to create usage meter
   class CreateUsageMeterRequest
-    # Name of the event. Must be unique for an organization.
+    # Name of the usage meter. Must be unique for an organization.
     attr_accessor :name
 
-    # Description of the event
+    # Billable name of usage meter. Billable name takes precedence over name to display in invoice.
+    attr_accessor :billable_name
+
+    # Description of the usage meter
     attr_accessor :description
 
+    # The usage meter's applicability will be determined by comparing the filter condition agianst the events.
+    attr_accessor :filters
+
     # Type of usage meter
     attr_accessor :type
 
-    # Aggregation to be applied on usage meter result
     attr_accessor :aggregation
 
     attr_accessor :computations
 
+    # Event Schema Identifier
+    attr_accessor :event_schema_name
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -56,10 +64,13 @@ module TogaiClient
     def self.attribute_map
       {
         :'name' => :'name',
+        :'billable_name' => :'billableName',
         :'description' => :'description',
+        :'filters' => :'filters',
         :'type' => :'type',
         :'aggregation' => :'aggregation',
-        :'computations' => :'computations'
+        :'computations' => :'computations',
+        :'event_schema_name' => :'eventSchemaName'
       }
     end
 
@@ -72,10 +83,13 @@ module TogaiClient
     def self.openapi_types
       {
         :'name' => :'String',
+        :'billable_name' => :'String',
         :'description' => :'String',
+        :'filters' => :'Array<UsageMeterFilterEntry>',
         :'type' => :'String',
-        :'aggregation' => :'String',
-        :'computations' => :'Array<Computation>'
+        :'aggregation' => :'UsageMeterAggregation',
+        :'computations' => :'Array<Computation>',
+        :'event_schema_name' => :'String'
       }
     end
 
@@ -102,18 +116,34 @@ module TogaiClient
 
       if attributes.key?(:'name')
         self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'billable_name')
+        self.billable_name = attributes[:'billable_name']
       end
 
       if attributes.key?(:'description')
         self.description = attributes[:'description']
       end
 
+      if attributes.key?(:'filters')
+        if (value = attributes[:'filters']).is_a?(Array)
+          self.filters = value
+        end
+      end
+
       if attributes.key?(:'type')
         self.type = attributes[:'type']
+      else
+        self.type = nil
       end
 
       if attributes.key?(:'aggregation')
         self.aggregation = attributes[:'aggregation']
+      else
+        self.aggregation = nil
       end
 
       if attributes.key?(:'computations')
@@ -121,11 +151,16 @@ module TogaiClient
           self.computations = value
         end
       end
+
+      if attributes.key?(:'event_schema_name')
+        self.event_schema_name = attributes[:'event_schema_name']
+      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 @name.nil?
         invalid_properties.push('invalid value for "name", name cannot be nil.')
@@ -140,6 +175,10 @@ module TogaiClient
         invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
       end
 
+      if !@billable_name.nil? && @billable_name.to_s.length > 255
+        invalid_properties.push('invalid value for "billable_name", the character length must be smaller than or equal to 255.')
+      end
+
       if !@description.nil? && @description.to_s.length > 255
         invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 255.')
       end
@@ -158,16 +197,16 @@ module TogaiClient
     # 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 @name.nil?
       return false if @name.to_s.length > 50
       return false if @name !~ Regexp.new(/^[\sa-zA-Z0-9_-]*$/)
+      return false if !@billable_name.nil? && @billable_name.to_s.length > 255
       return false if !@description.nil? && @description.to_s.length > 255
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ["COUNTER", "GAUGE", "TIMER"])
+      type_validator = EnumAttributeValidator.new('String', ["COUNTER"])
       return false unless type_validator.valid?(@type)
       return false if @aggregation.nil?
-      aggregation_validator = EnumAttributeValidator.new('String', ["COUNT", "SUM"])
-      return false unless aggregation_validator.valid?(@aggregation)
       true
     end
 
@@ -190,10 +229,28 @@ module TogaiClient
       @name = name
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] billable_name Value to be assigned
+    def billable_name=(billable_name)
+      if billable_name.nil?
+        fail ArgumentError, 'billable_name cannot be nil'
+      end
+
+      if billable_name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "billable_name", the character length must be smaller than or equal to 255.'
+      end
+
+      @billable_name = billable_name
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] description Value to be assigned
     def description=(description)
-      if !description.nil? && description.to_s.length > 255
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      if description.to_s.length > 255
         fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 255.'
       end
 
@@ -203,33 +260,26 @@ module TogaiClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["COUNTER", "GAUGE", "TIMER"])
+      validator = EnumAttributeValidator.new('String', ["COUNTER"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
       @type = type
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] aggregation Object to be assigned
-    def aggregation=(aggregation)
-      validator = EnumAttributeValidator.new('String', ["COUNT", "SUM"])
-      unless validator.valid?(aggregation)
-        fail ArgumentError, "invalid value for \"aggregation\", must be one of #{validator.allowable_values}."
-      end
-      @aggregation = aggregation
-    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 &&
           name == o.name &&
+          billable_name == o.billable_name &&
           description == o.description &&
+          filters == o.filters &&
           type == o.type &&
           aggregation == o.aggregation &&
-          computations == o.computations
+          computations == o.computations &&
+          event_schema_name == o.event_schema_name
     end
 
     # @see the `==` method
@@ -241,44 +291,37 @@ module TogaiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, type, aggregation, computations].hash
+      [name, billable_name, description, filters, type, aggregation, computations, event_schema_name].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)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
       attributes = attributes.transform_keys(&:to_sym)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
+      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[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
           end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      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 _deserialize(type, value)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)
@@ -313,7 +356,7 @@ module TogaiClient
       else # model
         # models (e.g. Pet) or oneOf
         klass = TogaiClient.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end