togai_client 1.0.0 → 1.0.2

data/lib/togai_client/models/credit_transaction.rb

@@ -0,0 +1,357 @@
+=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 CreditTransaction
+    # Identifier of credit transactions
+    attr_accessor :id
+
+    attr_accessor :credit_id
+
+    attr_accessor :transaction_type
+
+    attr_accessor :invoice_id
+
+    attr_accessor :entity_id
+
+    attr_accessor :amount
+
+    attr_accessor :created_at
+
+    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
+      {
+        :'id' => :'id',
+        :'credit_id' => :'creditId',
+        :'transaction_type' => :'transactionType',
+        :'invoice_id' => :'invoiceId',
+        :'entity_id' => :'entityId',
+        :'amount' => :'amount',
+        :'created_at' => :'createdAt'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'credit_id' => :'String',
+        :'transaction_type' => :'String',
+        :'invoice_id' => :'String',
+        :'entity_id' => :'String',
+        :'amount' => :'Float',
+        :'created_at' => :'Time'
+      }
+    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::CreditTransaction` 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::CreditTransaction`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'credit_id')
+        self.credit_id = attributes[:'credit_id']
+      else
+        self.credit_id = nil
+      end
+
+      if attributes.key?(:'transaction_type')
+        self.transaction_type = attributes[:'transaction_type']
+      else
+        self.transaction_type = nil
+      end
+
+      if attributes.key?(:'invoice_id')
+        self.invoice_id = attributes[:'invoice_id']
+      end
+
+      if attributes.key?(:'entity_id')
+        self.entity_id = attributes[:'entity_id']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      else
+        self.amount = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = 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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @id.to_s.length > 50
+        invalid_properties.push('invalid value for "id", the character length must be smaller than or equal to 50.')
+      end
+
+      if @credit_id.nil?
+        invalid_properties.push('invalid value for "credit_id", credit_id cannot be nil.')
+      end
+
+      if @transaction_type.nil?
+        invalid_properties.push('invalid value for "transaction_type", transaction_type cannot be nil.')
+      end
+
+      if @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at 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 @id.nil?
+      return false if @id.to_s.length > 50
+      return false if @credit_id.nil?
+      return false if @transaction_type.nil?
+      transaction_type_validator = EnumAttributeValidator.new('String', ["CREDITED", "DEBITED", "EXPIRED", "VOIDED"])
+      return false unless transaction_type_validator.valid?(@transaction_type)
+      return false if @amount.nil?
+      return false if @created_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      if id.to_s.length > 50
+        fail ArgumentError, 'invalid value for "id", the character length must be smaller than or equal to 50.'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] transaction_type Object to be assigned
+    def transaction_type=(transaction_type)
+      validator = EnumAttributeValidator.new('String', ["CREDITED", "DEBITED", "EXPIRED", "VOIDED"])
+      unless validator.valid?(transaction_type)
+        fail ArgumentError, "invalid value for \"transaction_type\", must be one of #{validator.allowable_values}."
+      end
+      @transaction_type = transaction_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 &&
+          id == o.id &&
+          credit_id == o.credit_id &&
+          transaction_type == o.transaction_type &&
+          invoice_id == o.invoice_id &&
+          entity_id == o.entity_id &&
+          amount == o.amount &&
+          created_at == o.created_at
+    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
+      [id, credit_id, transaction_type, invoice_id, entity_id, amount, created_at].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/{rate_card_bundle.rb → currency_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
 
@@ -14,12 +14,16 @@ require 'date'
 require 'time'
 
 module TogaiClient
-  class RateCardBundle
-    attr_accessor :rate_strategy
+  # Configuration for getting the currency
+  class CurrencyConfig
+    # Mode to get the currency - CUSTOM: Use the currency provided in the request - ACCOUNT_INVOICE: Use the invoice currency of the given account 
+    attr_accessor :mode
 
-    attr_accessor :slab_strategy
+    # Currency to be used, this will be considered if mode is CUSTOM
+    attr_accessor :currency
 
-    attr_accessor :bundles
+    # Id of the account of which invoice currency will be used, this will be considered if mode is ACCOUNT_INVOICE
+    attr_accessor :account_id
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -46,9 +50,9 @@ module TogaiClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'rate_strategy' => :'rateStrategy',
-        :'slab_strategy' => :'slabStrategy',
-        :'bundles' => :'bundles'
+        :'mode' => :'mode',
+        :'currency' => :'currency',
+        :'account_id' => :'accountId'
       }
     end
 
@@ -60,9 +64,9 @@ module TogaiClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'rate_strategy' => :'String',
-        :'slab_strategy' => :'String',
-        :'bundles' => :'Array<BundleStrategy>'
+        :'mode' => :'String',
+        :'currency' => :'String',
+        :'account_id' => :'String'
       }
     end
 
@@ -76,54 +80,43 @@ 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::RateCardBundle` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TogaiClient::CurrencyConfig` 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::RateCardBundle`. 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::CurrencyConfig`. 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?(:'rate_strategy')
-        self.rate_strategy = attributes[:'rate_strategy']
+      if attributes.key?(:'mode')
+        self.mode = attributes[:'mode']
+      else
+        self.mode = nil
       end
 
-      if attributes.key?(:'slab_strategy')
-        self.slab_strategy = attributes[:'slab_strategy']
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
       end
 
-      if attributes.key?(:'bundles')
-        if (value = attributes[:'bundles']).is_a?(Array)
-          self.bundles = value
-        end
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
       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 @rate_strategy.nil?
-        invalid_properties.push('invalid value for "rate_strategy", rate_strategy cannot be nil.')
-      end
-
-      if @slab_strategy.nil?
-        invalid_properties.push('invalid value for "slab_strategy", slab_strategy cannot be nil.')
-      end
-
-      if @bundles.nil?
-        invalid_properties.push('invalid value for "bundles", bundles cannot be nil.')
-      end
-
-      if @bundles.length > 10
-        invalid_properties.push('invalid value for "bundles", number of items must be less than or equal to 10.')
+      if @mode.nil?
+        invalid_properties.push('invalid value for "mode", mode cannot be nil.')
       end
 
-      if @bundles.length < 1
-        invalid_properties.push('invalid value for "bundles", number of items must be greater than or equal to 1.')
+      if !@currency.nil? && @currency.to_s.length < 1
+        invalid_properties.push('invalid value for "currency", the character length must be great than or equal to 1.')
       end
 
       invalid_properties
@@ -132,54 +125,36 @@ 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 @rate_strategy.nil?
-      rate_strategy_validator = EnumAttributeValidator.new('String', ["FLAT"])
-      return false unless rate_strategy_validator.valid?(@rate_strategy)
-      return false if @slab_strategy.nil?
-      slab_strategy_validator = EnumAttributeValidator.new('String', ["TIER"])
-      return false unless slab_strategy_validator.valid?(@slab_strategy)
-      return false if @bundles.nil?
-      return false if @bundles.length > 10
-      return false if @bundles.length < 1
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @mode.nil?
+      mode_validator = EnumAttributeValidator.new('String', ["CUSTOM", "ACCOUNT_INVOICE"])
+      return false unless mode_validator.valid?(@mode)
+      return false if !@currency.nil? && @currency.to_s.length < 1
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] rate_strategy Object to be assigned
-    def rate_strategy=(rate_strategy)
-      validator = EnumAttributeValidator.new('String', ["FLAT"])
-      unless validator.valid?(rate_strategy)
-        fail ArgumentError, "invalid value for \"rate_strategy\", must be one of #{validator.allowable_values}."
-      end
-      @rate_strategy = rate_strategy
-    end
-
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] slab_strategy Object to be assigned
-    def slab_strategy=(slab_strategy)
-      validator = EnumAttributeValidator.new('String', ["TIER"])
-      unless validator.valid?(slab_strategy)
-        fail ArgumentError, "invalid value for \"slab_strategy\", must be one of #{validator.allowable_values}."
+    # @param [Object] mode Object to be assigned
+    def mode=(mode)
+      validator = EnumAttributeValidator.new('String', ["CUSTOM", "ACCOUNT_INVOICE"])
+      unless validator.valid?(mode)
+        fail ArgumentError, "invalid value for \"mode\", must be one of #{validator.allowable_values}."
       end
-      @slab_strategy = slab_strategy
+      @mode = mode
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] bundles Value to be assigned
-    def bundles=(bundles)
-      if bundles.nil?
-        fail ArgumentError, 'bundles cannot be nil'
+    # @param [Object] currency Value to be assigned
+    def currency=(currency)
+      if currency.nil?
+        fail ArgumentError, 'currency cannot be nil'
       end
 
-      if bundles.length > 10
-        fail ArgumentError, 'invalid value for "bundles", number of items must be less than or equal to 10.'
+      if currency.to_s.length < 1
+        fail ArgumentError, 'invalid value for "currency", the character length must be great than or equal to 1.'
       end
 
-      if bundles.length < 1
-        fail ArgumentError, 'invalid value for "bundles", number of items must be greater than or equal to 1.'
-      end
-
-      @bundles = bundles
+      @currency = currency
     end
 
     # Checks equality by comparing each attribute.
@@ -187,9 +162,9 @@ module TogaiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          rate_strategy == o.rate_strategy &&
-          slab_strategy == o.slab_strategy &&
-          bundles == o.bundles
+          mode == o.mode &&
+          currency == o.currency &&
+          account_id == o.account_id
     end
 
     # @see the `==` method
@@ -201,44 +176,37 @@ module TogaiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [rate_strategy, slab_strategy, bundles].hash
+      [mode, currency, account_id].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)
@@ -273,7 +241,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