feat: include order property when possible on balance transactions endpoint

.openapi-generator/FILES

@@ -8,6 +8,8 @@ lib/tremendous/models/allow_email1.rb
 lib/tremendous/models/allow_ip.rb
 lib/tremendous/models/allow_ip1.rb
 lib/tremendous/models/balance_transaction.rb
+lib/tremendous/models/balance_transaction_order.rb
+lib/tremendous/models/balance_transaction_order_payment.rb
 lib/tremendous/models/base_order_for_create.rb
 lib/tremendous/models/campaign.rb
 lib/tremendous/models/campaign_base.rb
@@ -65,6 +67,7 @@ lib/tremendous/models/fraud_review_list_item.rb
 lib/tremendous/models/fraud_review_reason.rb
 lib/tremendous/models/fraud_review_redemption_method.rb
 lib/tremendous/models/fraud_review_related_rewards.rb
+lib/tremendous/models/fraud_review_risk.rb
 lib/tremendous/models/fraud_review_status.rb
 lib/tremendous/models/fraud_rule200_response.rb
 lib/tremendous/models/fraud_rule400_response.rb
@@ -93,6 +96,8 @@ lib/tremendous/models/get_reward200_response.rb
 lib/tremendous/models/invoice.rb
 lib/tremendous/models/list_balance_transactions200_response.rb
 lib/tremendous/models/list_balance_transactions200_response_transactions_inner.rb
+lib/tremendous/models/list_balance_transactions200_response_transactions_inner_order.rb
+lib/tremendous/models/list_balance_transactions200_response_transactions_inner_order_payment.rb
 lib/tremendous/models/list_campaigns200_response.rb
 lib/tremendous/models/list_campaigns200_response_campaigns_inner.rb
 lib/tremendous/models/list_campaigns200_response_campaigns_inner_email_style.rb

lib/tremendous.rb

@@ -22,6 +22,8 @@
 require 'tremendous/models/allow_ip'
 require 'tremendous/models/allow_ip1'
 require 'tremendous/models/balance_transaction'
+require 'tremendous/models/balance_transaction_order'
+require 'tremendous/models/balance_transaction_order_payment'
 require 'tremendous/models/base_order_for_create'
 require 'tremendous/models/campaign'
 require 'tremendous/models/campaign_base'
@@ -79,6 +81,7 @@
 require 'tremendous/models/fraud_review_reason'
 require 'tremendous/models/fraud_review_redemption_method'
 require 'tremendous/models/fraud_review_related_rewards'
+require 'tremendous/models/fraud_review_risk'
 require 'tremendous/models/fraud_review_status'
 require 'tremendous/models/fraud_rule200_response'
 require 'tremendous/models/fraud_rule400_response'
@@ -107,6 +110,8 @@
 require 'tremendous/models/invoice'
 require 'tremendous/models/list_balance_transactions200_response'
 require 'tremendous/models/list_balance_transactions200_response_transactions_inner'
+require 'tremendous/models/list_balance_transactions200_response_transactions_inner_order'
+require 'tremendous/models/list_balance_transactions200_response_transactions_inner_order_payment'
 require 'tremendous/models/list_campaigns200_response'
 require 'tremendous/models/list_campaigns200_response_campaigns_inner'
 require 'tremendous/models/list_campaigns200_response_campaigns_inner_email_style'

lib/tremendous/models/balance_transaction.rb

@@ -31,14 +31,17 @@ class BalanceTransaction
     # A brief description of the transaction
     attr_accessor :description
 
+    attr_accessor :order
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'created_at' => :'created_at',
         :'amount' => :'amount',
         :'balance' => :'balance',
         :'action' => :'action',
-        :'description' => :'description'
+        :'description' => :'description',
+        :'order' => :'order'
       }
     end
 
@@ -54,7 +57,8 @@ def self.openapi_types
         :'amount' => :'Float',
         :'balance' => :'Float',
         :'action' => :'String',
-        :'description' => :'String'
+        :'description' => :'String',
+        :'order' => :'BalanceTransactionOrder'
       }
     end
 
@@ -108,6 +112,10 @@ def initialize(attributes = {})
       else
         self.description = nil
       end
+
+      if attributes.key?(:'order')
+        self.order = attributes[:'order']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -159,7 +167,8 @@ def ==(o)
           amount == o.amount &&
           balance == o.balance &&
           action == o.action &&
-          description == o.description
+          description == o.description &&
+          order == o.order
     end
 
     # @see the `==` method
@@ -171,7 +180,7 @@ def eql?(o)
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created_at, amount, balance, action, description].hash
+      [created_at, amount, balance, action, description, order].hash
     end
 
     # Builds the object from hash

lib/tremendous/models/balance_transaction_order.rb

@@ -0,0 +1,256 @@
+=begin
+#API Endpoints
+
+#Deliver monetary rewards and incentives to employees, customers, survey participants, and more through the Tremendous API. For organizational tasks, like managing your organization and it's members within Tremendous, please see the Tremendous Organizational API.
+
+The version of the OpenAPI document: 2
+Contact: [email protected]
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Tremendous
+  # Order details
+  class BalanceTransactionOrder
+    attr_accessor :id
+
+    # Reference for this order, supplied by the customer.  When set, `external_id` makes order idempotent. All requests that use the same `external_id` after the initial order creation, will result in a response that returns the data of the initially created order. The response will have a `201` response code. These responses **fail** to create any further orders.  It also allows for retrieving by `external_id` instead of `id` only. 
+    attr_accessor :external_id
+
+    attr_accessor :payment
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'external_id' => :'external_id',
+        :'payment' => :'payment'
+      }
+    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',
+        :'external_id' => :'String',
+        :'payment' => :'BalanceTransactionOrderPayment'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'external_id',
+      ])
+    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 `Tremendous::BalanceTransactionOrder` 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 `Tremendous::BalanceTransactionOrder`. 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']
+      end
+
+      if attributes.key?(:'external_id')
+        self.external_id = attributes[:'external_id']
+      end
+
+      if attributes.key?(:'payment')
+        self.payment = attributes[:'payment']
+      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
+      pattern = Regexp.new(/[A-Z0-9]{4,20}/)
+      if [email protected]? && @id !~ pattern
+        invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
+      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 [email protected]? && @id !~ Regexp.new(/[A-Z0-9]{4,20}/)
+      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
+
+      pattern = Regexp.new(/[A-Z0-9]{4,20}/)
+      if id !~ pattern
+        fail ArgumentError, "invalid value for \"id\", must conform to the pattern #{pattern}."
+      end
+
+      @id = id
+    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 &&
+          external_id == o.external_id &&
+          payment == o.payment
+    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, external_id, payment].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 = Tremendous.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