togai_client 1.0.0 → 1.0.2

data/lib/togai_client/models/price_plan_v2_paginated_response.rb

@@ -0,0 +1,233 @@
+=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
+  # Paginated response for price plan
+  class PricePlanV2PaginatedResponse
+    attr_accessor :data
+
+    attr_accessor :next_token
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'next_token' => :'nextToken'
+      }
+    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
+      {
+        :'data' => :'Array<PricePlanV2>',
+        :'next_token' => :'String'
+      }
+    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::PricePlanV2PaginatedResponse` 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::PricePlanV2PaginatedResponse`. 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?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      else
+        self.data = nil
+      end
+
+      if attributes.key?(:'next_token')
+        self.next_token = attributes[:'next_token']
+      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 @data.nil?
+        invalid_properties.push('invalid value for "data", data 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 @data.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 &&
+          data == o.data &&
+          next_token == o.next_token
+    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
+      [data, next_token].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/price_type.rb

@@ -0,0 +1,41 @@
+=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 PriceType
+    FLAT = "FLAT".freeze
+    PER_UNIT = "PER_UNIT".freeze
+    PACKAGE = "PACKAGE".freeze
+
+    def self.all_vars
+      @all_vars ||= [FLAT, PER_UNIT, PACKAGE].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 PriceType.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #PriceType"
+    end
+  end
+end

data/lib/togai_client/models/{pricing_cycle.rb → pricing_cycle_config.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
 
@@ -15,15 +15,17 @@ require 'time'
 
 module TogaiClient
   # Represents configurations related to pricing cycle
-  class PricingCycle
+  class PricingCycleConfig
     attr_accessor :interval
 
-    attr_accessor :start_type
-
     attr_accessor :start_offset
 
+    # Togai allows you to ingest past dated events that will be processed by a pricing cycle till the end grace period.  For example: Pricing cycle is Monthly from 1st to 30th and gracePeriod is 5 days which next month 1 to 5th date, you can ingest past dated events during this grace period. 
     attr_accessor :grace_period
 
+    # Togai calculates the startOffsets based on the date of association instead of requiring from the user and  these offsets will be applied as an override if this flag is enabled. Examples: WEEKLY -   - 23/10/2023 (Monday) - {dayOffset: 1, monthOffset: NIL}    - 25/10/2023 (Wednesday) - {dayOffset: 3, monthOffset: NIL}    - 29/10/2023 (Sunday) - {dayOffset: 7, monthOffset: NIL} MONTHLY -   - 1st Oct - {dayOffset: 1, monthOffset: NIL}   - 12th Oct - {dayOffset: 12, monthOffset: NIL}   - 28th Oct - {dayOffset: 28, monthOffset: NIL}   - 30th Oct - {dayOffset: 30, monthOffset: NIL}   - 31th Oct - {dayOffset: LAST, monthOffset: NIL} QUARTERLY   - 15th Jan, 15th Apr, 15th Jul and 15th Oct - {dayOffset: 15, monthOffset: 1}   - 15th Feb, 15th May, 15th Aug and 15th Nov - {dayOffset: 15, monthOffset: 2}    - 15th Mar, 15th Jun, 15th Sep and 15th Dec - {dayOffset: 15, monthOffset: 3} HALF_YEARLY   - 15th Jan and 15th Jul - {dayOffset: 15, monthOffset: 1}    - 15th Apr and 15th Oct - {dayOffset: 15, monthOffset: 4}    - 15th Jun and 15th Dec - {dayOffset: 15, monthOffset: 6} ANNUALLY   - 15th Jan - {dayOffset: 15, monthOffset: 1}   - 29th Feb on Leap year  - {dayOffset: LAST, monthOffset: 2}   - 28th Feb  - {dayOffset: LAST, monthOffset: 2}   - 15th Aug - {dayOffset: 15, monthOffset: 8}   - 15th Dec - {dayOffset: 15, monthOffset: 12} 
+    attr_accessor :anniversary_cycle
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -50,9 +52,9 @@ module TogaiClient
     def self.attribute_map
       {
         :'interval' => :'interval',
-        :'start_type' => :'startType',
         :'start_offset' => :'startOffset',
-        :'grace_period' => :'gracePeriod'
+        :'grace_period' => :'gracePeriod',
+        :'anniversary_cycle' => :'anniversaryCycle'
       }
     end
 
@@ -64,10 +66,10 @@ module TogaiClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'interval' => :'String',
-        :'start_type' => :'String',
-        :'start_offset' => :'PricingCycleStartOffset',
-        :'grace_period' => :'Integer'
+        :'interval' => :'PricingCycleInterval',
+        :'start_offset' => :'PricingCycleConfigStartOffset',
+        :'grace_period' => :'Integer',
+        :'anniversary_cycle' => :'Boolean'
       }
     end
 
@@ -81,23 +83,21 @@ 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::PricingCycle` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TogaiClient::PricingCycleConfig` 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::PricingCycle`. 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::PricingCycleConfig`. 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?(:'interval')
         self.interval = attributes[:'interval']
-      end
-
-      if attributes.key?(:'start_type')
-        self.start_type = attributes[:'start_type']
+      else
+        self.interval = nil
       end
 
       if attributes.key?(:'start_offset')
@@ -106,25 +106,24 @@ module TogaiClient
 
       if attributes.key?(:'grace_period')
         self.grace_period = attributes[:'grace_period']
+      else
+        self.grace_period = nil
+      end
+
+      if attributes.key?(:'anniversary_cycle')
+        self.anniversary_cycle = attributes[:'anniversary_cycle']
       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 @interval.nil?
         invalid_properties.push('invalid value for "interval", interval cannot be nil.')
       end
 
-      if @start_type.nil?
-        invalid_properties.push('invalid value for "start_type", start_type cannot be nil.')
-      end
-
-      if @start_offset.nil?
-        invalid_properties.push('invalid value for "start_offset", start_offset cannot be nil.')
-      end
-
       if @grace_period.nil?
         invalid_properties.push('invalid value for "grace_period", grace_period cannot be nil.')
       end
@@ -135,46 +134,21 @@ 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 @interval.nil?
-      interval_validator = EnumAttributeValidator.new('String', ["MONTHLY", "QUARTERLY", "HALF_YEARLY", "ANNUALLY"])
-      return false unless interval_validator.valid?(@interval)
-      return false if @start_type.nil?
-      start_type_validator = EnumAttributeValidator.new('String', ["STATIC"])
-      return false unless start_type_validator.valid?(@start_type)
-      return false if @start_offset.nil?
       return false if @grace_period.nil?
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] interval Object to be assigned
-    def interval=(interval)
-      validator = EnumAttributeValidator.new('String', ["MONTHLY", "QUARTERLY", "HALF_YEARLY", "ANNUALLY"])
-      unless validator.valid?(interval)
-        fail ArgumentError, "invalid value for \"interval\", must be one of #{validator.allowable_values}."
-      end
-      @interval = interval
-    end
-
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] start_type Object to be assigned
-    def start_type=(start_type)
-      validator = EnumAttributeValidator.new('String', ["STATIC"])
-      unless validator.valid?(start_type)
-        fail ArgumentError, "invalid value for \"start_type\", must be one of #{validator.allowable_values}."
-      end
-      @start_type = start_type
-    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 &&
           interval == o.interval &&
-          start_type == o.start_type &&
           start_offset == o.start_offset &&
-          grace_period == o.grace_period
+          grace_period == o.grace_period &&
+          anniversary_cycle == o.anniversary_cycle
     end
 
     # @see the `==` method
@@ -186,44 +160,37 @@ module TogaiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [interval, start_type, start_offset, grace_period].hash
+      [interval, start_offset, grace_period, anniversary_cycle].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)
@@ -258,7 +225,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