togai_client 1.0.1 → 1.0.2

data/lib/togai_client/models/entitlement_overage_revenue_summary.rb

@@ -0,0 +1,221 @@
+=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
+  class EntitlementOverageRevenueSummary
+    attr_accessor :revenue
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'revenue' => :'revenue'
+      }
+    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
+      {
+        :'revenue' => :'Float'
+      }
+    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::EntitlementOverageRevenueSummary` 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::EntitlementOverageRevenueSummary`. 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?(:'revenue')
+        self.revenue = attributes[:'revenue']
+      else
+        self.revenue = 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 @revenue.nil?
+        invalid_properties.push('invalid value for "revenue", revenue 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 @revenue.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 &&
+          revenue == o.revenue
+    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
+      [revenue].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

data/lib/togai_client/models/error_response.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
 
@@ -60,12 +60,15 @@ module TogaiClient
 
       if attributes.key?(:'message')
         self.message = attributes[:'message']
+      else
+        self.message = 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 @message.nil?
         invalid_properties.push('invalid value for "message", message cannot be nil.')
@@ -81,6 +84,7 @@ 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 @message.nil?
       return false if @message.to_s.length > 500
       true
@@ -124,37 +128,30 @@ module TogaiClient
     # @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)
@@ -189,7 +186,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
 

data/lib/togai_client/models/event.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,30 +16,32 @@ require 'time'
 module TogaiClient
   # Contents of the event
   class Event
-    # Name of the event to be recorded.
-    attr_accessor :event_name
+    # Name of the Event Schema.  Know more about [event schema](https://docs.togai.com/docs/event-schemas) 
+    attr_accessor :schema_name
 
-    # A unique value to identify the event instance. This unique value should be generated by the client and it acts as the **idempotency key**. Togai server will use this key to recognize subsequent retries of the same request and avoid metering multiple times for that same request. This id can be created in any format but we recommend using UUIDv4 to reduce collision occurance.    NOTE1: Expiry time for idempotency validation will be until the end of the billing cycle. Any request which comes after the billing cycle with the same id will be treated as new request and ingested for metering.   NOTE2: If the billing cycle is not configured for the idempotency validation will be until **10 days** of the event ingestion.
+    # Togai restricts users to ingest events with same id within a period of *45 days*. This restriction is common for [/entitled API](/api-reference/entitlements/ingest-event-if-a-user-is-entitled-to-a-feature), [/ingest API](/api-reference/event-ingestion/ingest-events-to-togai) and [/ingestBatch API](/api-reference/event-ingestion/ingest-events-to-togai-in-batch). i.e, an id used on /ingest API will not be allowed on /ingestBatch or /entitled APIs
     attr_accessor :id
 
     # Source time stamp of the event. This timestamp must be in ISO 8601 format.
-    attr_accessor :event_timestamp
+    attr_accessor :timestamp
 
+    # The event will be associated with the provided account
     attr_accessor :account_id
 
-    attr_accessor :event_attributes
+    # Attributes are numeric values. It can be usage metric which you push to Togai
+    attr_accessor :attributes
 
-    # Dimensions are tags/labels associated with the events. This dimensions can be used to configure billing, for queries, analytics and reports.
+    # Dimensions are tags/labels associated with the events.
     attr_accessor :dimensions
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'event_name' => :'eventName',
+        :'schema_name' => :'schemaName',
         :'id' => :'id',
-        :'event_timestamp' => :'eventTimestamp',
+        :'timestamp' => :'timestamp',
         :'account_id' => :'accountId',
-        :'event_attributes' => :'eventAttributes',
+        :'attributes' => :'attributes',
         :'dimensions' => :'dimensions'
       }
     end
@@ -52,11 +54,11 @@ module TogaiClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'event_name' => :'String',
+        :'schema_name' => :'String',
         :'id' => :'String',
-        :'event_timestamp' => :'Time',
+        :'timestamp' => :'Time',
         :'account_id' => :'String',
-        :'event_attributes' => :'Array<EventAttribute>',
+        :'attributes' => :'Array<Attribute>',
         :'dimensions' => :'Hash<String, String>'
       }
     end
@@ -82,73 +84,88 @@ module TogaiClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'event_name')
-        self.event_name = attributes[:'event_name']
+      if attributes.key?(:'schema_name')
+        self.schema_name = attributes[:'schema_name']
+      else
+        self.schema_name = nil
       end
 
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'event_timestamp')
-        self.event_timestamp = attributes[:'event_timestamp']
+      if attributes.key?(:'timestamp')
+        self.timestamp = attributes[:'timestamp']
+      else
+        self.timestamp = nil
       end
 
       if attributes.key?(:'account_id')
         self.account_id = attributes[:'account_id']
+      else
+        self.account_id = nil
       end
 
-      if attributes.key?(:'event_attributes')
-        if (value = attributes[:'event_attributes']).is_a?(Array)
-          self.event_attributes = value
+      if attributes.key?(:'attributes')
+        if (value = attributes[:'attributes']).is_a?(Array)
+          self.attributes = value
         end
+      else
+        self.attributes = nil
       end
 
       if attributes.key?(:'dimensions')
         if (value = attributes[:'dimensions']).is_a?(Hash)
           self.dimensions = value
         end
+      else
+        self.dimensions = 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 @event_name.nil?
-        invalid_properties.push('invalid value for "event_name", event_name cannot be nil.')
+      if @schema_name.nil?
+        invalid_properties.push('invalid value for "schema_name", schema_name cannot be nil.')
       end
 
-      if @event_name.to_s.length > 255
-        invalid_properties.push('invalid value for "event_name", the character length must be smaller than or equal to 255.')
+      if @schema_name.to_s.length > 50
+        invalid_properties.push('invalid value for "schema_name", the character length must be smaller than or equal to 50.')
       end
 
-      if @id.nil?
-        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      if @schema_name.to_s.length < 1
+        invalid_properties.push('invalid value for "schema_name", the character length must be great than or equal to 1.')
       end
 
-      if @id.to_s.length > 255
-        invalid_properties.push('invalid value for "id", the character length must be smaller than or equal to 255.')
+      if !@id.nil? && @id.to_s.length > 512
+        invalid_properties.push('invalid value for "id", the character length must be smaller than or equal to 512.')
       end
 
-      if @event_timestamp.nil?
-        invalid_properties.push('invalid value for "event_timestamp", event_timestamp cannot be nil.')
+      if @timestamp.nil?
+        invalid_properties.push('invalid value for "timestamp", timestamp cannot be nil.')
       end
 
       if @account_id.nil?
         invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
       end
 
-      if @account_id.to_s.length > 255
-        invalid_properties.push('invalid value for "account_id", the character length must be smaller than or equal to 255.')
+      if @account_id.to_s.length > 512
+        invalid_properties.push('invalid value for "account_id", the character length must be smaller than or equal to 512.')
       end
 
-      if @event_attributes.nil?
-        invalid_properties.push('invalid value for "event_attributes", event_attributes cannot be nil.')
+      if @attributes.nil?
+        invalid_properties.push('invalid value for "attributes", attributes cannot be nil.')
       end
 
-      if @event_attributes.length > 50
-        invalid_properties.push('invalid value for "event_attributes", number of items must be less than or equal to 50.')
+      if @attributes.length > 10
+        invalid_properties.push('invalid value for "attributes", number of items must be less than or equal to 10.')
+      end
+
+      if @attributes.length < 0
+        invalid_properties.push('invalid value for "attributes", number of items must be greater than or equal to 0.')
       end
 
       if @dimensions.nil?
@@ -161,31 +178,37 @@ 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 @event_name.nil?
-      return false if @event_name.to_s.length > 255
-      return false if @id.nil?
-      return false if @id.to_s.length > 255
-      return false if @event_timestamp.nil?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @schema_name.nil?
+      return false if @schema_name.to_s.length > 50
+      return false if @schema_name.to_s.length < 1
+      return false if !@id.nil? && @id.to_s.length > 512
+      return false if @timestamp.nil?
       return false if @account_id.nil?
-      return false if @account_id.to_s.length > 255
-      return false if @event_attributes.nil?
-      return false if @event_attributes.length > 50
+      return false if @account_id.to_s.length > 512
+      return false if @attributes.nil?
+      return false if @attributes.length > 10
+      return false if @attributes.length < 0
       return false if @dimensions.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] event_name Value to be assigned
-    def event_name=(event_name)
-      if event_name.nil?
-        fail ArgumentError, 'event_name cannot be nil'
+    # @param [Object] schema_name Value to be assigned
+    def schema_name=(schema_name)
+      if schema_name.nil?
+        fail ArgumentError, 'schema_name cannot be nil'
+      end
+
+      if schema_name.to_s.length > 50
+        fail ArgumentError, 'invalid value for "schema_name", the character length must be smaller than or equal to 50.'
       end
 
-      if event_name.to_s.length > 255
-        fail ArgumentError, 'invalid value for "event_name", the character length must be smaller than or equal to 255.'
+      if schema_name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "schema_name", the character length must be great than or equal to 1.'
       end
 
-      @event_name = event_name
+      @schema_name = schema_name
     end
 
     # Custom attribute writer method with validation
@@ -195,8 +218,8 @@ module TogaiClient
         fail ArgumentError, 'id cannot be nil'
       end
 
-      if id.to_s.length > 255
-        fail ArgumentError, 'invalid value for "id", the character length must be smaller than or equal to 255.'
+      if id.to_s.length > 512
+        fail ArgumentError, 'invalid value for "id", the character length must be smaller than or equal to 512.'
       end
 
       @id = id
@@ -209,25 +232,29 @@ module TogaiClient
         fail ArgumentError, 'account_id cannot be nil'
       end
 
-      if account_id.to_s.length > 255
-        fail ArgumentError, 'invalid value for "account_id", the character length must be smaller than or equal to 255.'
+      if account_id.to_s.length > 512
+        fail ArgumentError, 'invalid value for "account_id", the character length must be smaller than or equal to 512.'
       end
 
       @account_id = account_id
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] event_attributes Value to be assigned
-    def event_attributes=(event_attributes)
-      if event_attributes.nil?
-        fail ArgumentError, 'event_attributes cannot be nil'
+    # @param [Object] attributes Value to be assigned
+    def attributes=(attributes)
+      if attributes.nil?
+        fail ArgumentError, 'attributes cannot be nil'
       end
 
-      if event_attributes.length > 50
-        fail ArgumentError, 'invalid value for "event_attributes", number of items must be less than or equal to 50.'
+      if attributes.length > 10
+        fail ArgumentError, 'invalid value for "attributes", number of items must be less than or equal to 10.'
       end
 
-      @event_attributes = event_attributes
+      if attributes.length < 0
+        fail ArgumentError, 'invalid value for "attributes", number of items must be greater than or equal to 0.'
+      end
+
+      @attributes = attributes
     end
 
     # Checks equality by comparing each attribute.
@@ -235,11 +262,11 @@ module TogaiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          event_name == o.event_name &&
+          schema_name == o.schema_name &&
           id == o.id &&
-          event_timestamp == o.event_timestamp &&
+          timestamp == o.timestamp &&
           account_id == o.account_id &&
-          event_attributes == o.event_attributes &&
+          attributes == o.attributes &&
           dimensions == o.dimensions
     end
 
@@ -252,44 +279,37 @@ module TogaiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [event_name, id, event_timestamp, account_id, event_attributes, dimensions].hash
+      [schema_name, id, timestamp, account_id, attributes, dimensions].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)
@@ -324,7 +344,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