apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/credit_card_product.rb

@@ -0,0 +1,276 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # CreditCardProduct Model.
+  class CreditCardProduct < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The annual fee associated with the `credit_card_product`.
+    # @return [Float]
+    attr_accessor :annual_fee
+
+    # The duration of an introductory rate on balance transfers, given in
+    # months.
+    # @return [Integer]
+    attr_accessor :duration_of_introductory_rate_on_balance_transfer
+
+    # The duration of an introductory rate on balance transfers, given in
+    # months.
+    # @return [Integer]
+    attr_accessor :duration_of_introductory_rate_on_purchases
+
+    # Unique identifier for the account. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # Indicates if the credit card product has cashback rewards.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_cashback_rewards
+
+    # This indicates whether the credit card offers a rewards system that is
+    # different than standard cashback or travel rewards.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_other_rewards
+
+    # This indicates whether the credit card offers travel rewards.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_travel_rewards
+
+    # This indicates whether the credit card offers a limited time period where
+    # a membership fee is waived.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_zero_introductory_annual_fee
+
+    # This indicates whether the credit card offers a zero percent introductory
+    # rate.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_zero_percent_introductory_rate
+
+    # This indicates that the credit card offers a zero percent rate when
+    # transferring a balance from a different credit card.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_zero_percent_introductory_rate_on_balance_transfer
+
+    # This indicates whether the financial institution is still accepting
+    # applicants for the credit card.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_accepting_applicants
+
+    # This indicates whether the credit card is still supported by the financial
+    # institution.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_active_credit_card_product
+
+    # This indicates whether the credit card is associated with a small
+    # business.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_small_business_card
+
+    # The name associated with the `credit_card_product`.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['annual_fee'] = 'annual_fee'
+      @_hash['duration_of_introductory_rate_on_balance_transfer'] =
+        'duration_of_introductory_rate_on_balance_transfer'
+      @_hash['duration_of_introductory_rate_on_purchases'] =
+        'duration_of_introductory_rate_on_purchases'
+      @_hash['guid'] = 'guid'
+      @_hash['has_cashback_rewards'] = 'has_cashback_rewards'
+      @_hash['has_other_rewards'] = 'has_other_rewards'
+      @_hash['has_travel_rewards'] = 'has_travel_rewards'
+      @_hash['has_zero_introductory_annual_fee'] =
+        'has_zero_introductory_annual_fee'
+      @_hash['has_zero_percent_introductory_rate'] =
+        'has_zero_percent_introductory_rate'
+      @_hash['has_zero_percent_introductory_rate_on_balance_transfer'] =
+        'has_zero_percent_introductory_rate_on_balance_transfer'
+      @_hash['is_accepting_applicants'] = 'is_accepting_applicants'
+      @_hash['is_active_credit_card_product'] =
+        'is_active_credit_card_product'
+      @_hash['is_small_business_card'] = 'is_small_business_card'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        annual_fee
+        duration_of_introductory_rate_on_balance_transfer
+        duration_of_introductory_rate_on_purchases
+        guid
+        has_cashback_rewards
+        has_other_rewards
+        has_travel_rewards
+        has_zero_introductory_annual_fee
+        has_zero_percent_introductory_rate
+        has_zero_percent_introductory_rate_on_balance_transfer
+        is_accepting_applicants
+        is_active_credit_card_product
+        is_small_business_card
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        duration_of_introductory_rate_on_balance_transfer
+        duration_of_introductory_rate_on_purchases
+      ]
+    end
+
+    def initialize(annual_fee: SKIP,
+                   duration_of_introductory_rate_on_balance_transfer: SKIP,
+                   duration_of_introductory_rate_on_purchases: SKIP, guid: SKIP,
+                   has_cashback_rewards: SKIP, has_other_rewards: SKIP,
+                   has_travel_rewards: SKIP,
+                   has_zero_introductory_annual_fee: SKIP,
+                   has_zero_percent_introductory_rate: SKIP,
+                   has_zero_percent_introductory_rate_on_balance_transfer: SKIP,
+                   is_accepting_applicants: SKIP,
+                   is_active_credit_card_product: SKIP,
+                   is_small_business_card: SKIP, name: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @annual_fee = annual_fee unless annual_fee == SKIP
+      unless duration_of_introductory_rate_on_balance_transfer == SKIP
+        @duration_of_introductory_rate_on_balance_transfer =
+          duration_of_introductory_rate_on_balance_transfer
+      end
+      unless duration_of_introductory_rate_on_purchases == SKIP
+        @duration_of_introductory_rate_on_purchases =
+          duration_of_introductory_rate_on_purchases
+      end
+      @guid = guid unless guid == SKIP
+      @has_cashback_rewards = has_cashback_rewards unless has_cashback_rewards == SKIP
+      @has_other_rewards = has_other_rewards unless has_other_rewards == SKIP
+      @has_travel_rewards = has_travel_rewards unless has_travel_rewards == SKIP
+      unless has_zero_introductory_annual_fee == SKIP
+        @has_zero_introductory_annual_fee =
+          has_zero_introductory_annual_fee
+      end
+      unless has_zero_percent_introductory_rate == SKIP
+        @has_zero_percent_introductory_rate =
+          has_zero_percent_introductory_rate
+      end
+      unless has_zero_percent_introductory_rate_on_balance_transfer == SKIP
+        @has_zero_percent_introductory_rate_on_balance_transfer =
+          has_zero_percent_introductory_rate_on_balance_transfer
+      end
+      @is_accepting_applicants = is_accepting_applicants unless is_accepting_applicants == SKIP
+      unless is_active_credit_card_product == SKIP
+        @is_active_credit_card_product =
+          is_active_credit_card_product
+      end
+      @is_small_business_card = is_small_business_card unless is_small_business_card == SKIP
+      @name = name unless name == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      annual_fee = hash.key?('annual_fee') ? hash['annual_fee'] : SKIP
+      duration_of_introductory_rate_on_balance_transfer =
+        hash.key?('duration_of_introductory_rate_on_balance_transfer') ? hash['duration_of_introductory_rate_on_balance_transfer'] : SKIP
+      duration_of_introductory_rate_on_purchases =
+        hash.key?('duration_of_introductory_rate_on_purchases') ? hash['duration_of_introductory_rate_on_purchases'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      has_cashback_rewards =
+        hash.key?('has_cashback_rewards') ? hash['has_cashback_rewards'] : SKIP
+      has_other_rewards =
+        hash.key?('has_other_rewards') ? hash['has_other_rewards'] : SKIP
+      has_travel_rewards =
+        hash.key?('has_travel_rewards') ? hash['has_travel_rewards'] : SKIP
+      has_zero_introductory_annual_fee =
+        hash.key?('has_zero_introductory_annual_fee') ? hash['has_zero_introductory_annual_fee'] : SKIP
+      has_zero_percent_introductory_rate =
+        hash.key?('has_zero_percent_introductory_rate') ? hash['has_zero_percent_introductory_rate'] : SKIP
+      has_zero_percent_introductory_rate_on_balance_transfer =
+        hash.key?('has_zero_percent_introductory_rate_on_balance_transfer') ? hash['has_zero_percent_introductory_rate_on_balance_transfer'] : SKIP
+      is_accepting_applicants =
+        hash.key?('is_accepting_applicants') ? hash['is_accepting_applicants'] : SKIP
+      is_active_credit_card_product =
+        hash.key?('is_active_credit_card_product') ? hash['is_active_credit_card_product'] : SKIP
+      is_small_business_card =
+        hash.key?('is_small_business_card') ? hash['is_small_business_card'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      CreditCardProduct.new(annual_fee: annual_fee,
+                            duration_of_introductory_rate_on_balance_transfer: duration_of_introductory_rate_on_balance_transfer,
+                            duration_of_introductory_rate_on_purchases: duration_of_introductory_rate_on_purchases,
+                            guid: guid,
+                            has_cashback_rewards: has_cashback_rewards,
+                            has_other_rewards: has_other_rewards,
+                            has_travel_rewards: has_travel_rewards,
+                            has_zero_introductory_annual_fee: has_zero_introductory_annual_fee,
+                            has_zero_percent_introductory_rate: has_zero_percent_introductory_rate,
+                            has_zero_percent_introductory_rate_on_balance_transfer: has_zero_percent_introductory_rate_on_balance_transfer,
+                            is_accepting_applicants: is_accepting_applicants,
+                            is_active_credit_card_product: is_active_credit_card_product,
+                            is_small_business_card: is_small_business_card,
+                            name: name,
+                            additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} annual_fee: #{@annual_fee},"\
+      ' duration_of_introductory_rate_on_balance_transfer:'\
+      " #{@duration_of_introductory_rate_on_balance_transfer},"\
+      ' duration_of_introductory_rate_on_purchases:'\
+      " #{@duration_of_introductory_rate_on_purchases}, guid: #{@guid}, has_cashback_rewards:"\
+      " #{@has_cashback_rewards}, has_other_rewards: #{@has_other_rewards}, has_travel_rewards:"\
+      " #{@has_travel_rewards}, has_zero_introductory_annual_fee:"\
+      " #{@has_zero_introductory_annual_fee}, has_zero_percent_introductory_rate:"\
+      " #{@has_zero_percent_introductory_rate},"\
+      ' has_zero_percent_introductory_rate_on_balance_transfer:'\
+      " #{@has_zero_percent_introductory_rate_on_balance_transfer}, is_accepting_applicants:"\
+      " #{@is_accepting_applicants}, is_active_credit_card_product:"\
+      " #{@is_active_credit_card_product}, is_small_business_card: #{@is_small_business_card},"\
+      " name: #{@name}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} annual_fee: #{@annual_fee.inspect},"\
+      ' duration_of_introductory_rate_on_balance_transfer:'\
+      " #{@duration_of_introductory_rate_on_balance_transfer.inspect},"\
+      ' duration_of_introductory_rate_on_purchases:'\
+      " #{@duration_of_introductory_rate_on_purchases.inspect}, guid: #{@guid.inspect},"\
+      " has_cashback_rewards: #{@has_cashback_rewards.inspect}, has_other_rewards:"\
+      " #{@has_other_rewards.inspect}, has_travel_rewards: #{@has_travel_rewards.inspect},"\
+      " has_zero_introductory_annual_fee: #{@has_zero_introductory_annual_fee.inspect},"\
+      " has_zero_percent_introductory_rate: #{@has_zero_percent_introductory_rate.inspect},"\
+      ' has_zero_percent_introductory_rate_on_balance_transfer:'\
+      " #{@has_zero_percent_introductory_rate_on_balance_transfer.inspect},"\
+      " is_accepting_applicants: #{@is_accepting_applicants.inspect},"\
+      " is_active_credit_card_product: #{@is_active_credit_card_product.inspect},"\
+      " is_small_business_card: #{@is_small_business_card.inspect}, name: #{@name.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/credit_card_product_response.rb

@@ -0,0 +1,77 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # CreditCardProductResponse Model.
+  class CreditCardProductResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CreditCardProduct]
+    attr_accessor :credit_card_product
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['credit_card_product'] = 'credit_card_product'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        credit_card_product
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(credit_card_product: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @credit_card_product = credit_card_product unless credit_card_product == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      credit_card_product = CreditCardProduct.from_hash(hash['credit_card_product']) if
+        hash['credit_card_product']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      CreditCardProductResponse.new(credit_card_product: credit_card_product,
+                                    additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} credit_card_product: #{@credit_card_product}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} credit_card_product: #{@credit_card_product.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/data_request.rb

@@ -0,0 +1,76 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # Contains a products array that specifies the products you want to aggregate.
+  class DataRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Contains the products you want to aggregate upon a successful connection.
+    # For accepted products, see [Defining
+    # Products](/products/connectivity/overview/intro-to-unified-product-orderin
+    # g/#defining-products).
+    # @return [Array[SupportedProduct]]
+    attr_accessor :products
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['products'] = 'products'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(products:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @products = products
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      products = hash.key?('products') ? hash['products'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      DataRequest.new(products: products,
+                      additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} products: #{@products}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} products: #{@products.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/date_range.rb

@@ -0,0 +1,87 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # Only use this option if the `widget_type` is set to `spending_widget`. When
+  # used with the Legacy Spending widget, used to filter by date range. Set the
+  # `date_range` using `start_date` (string) and `end_date` (string).
+  class DateRange < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The start date of the range in `YYYY-MM-DD` format.
+    # @return [String]
+    attr_accessor :start_date
+
+    # The end date of the range in `YYYY-MM-DD` format.
+    # @return [String]
+    attr_accessor :end_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start_date
+        end_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start_date: SKIP, end_date: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      DateRange.new(start_date: start_date,
+                    end_date: end_date,
+                    additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} start_date: #{@start_date}, end_date: #{@end_date}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} start_date: #{@start_date.inspect}, end_date: #{@end_date.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/date_range_category_totals_response.rb

@@ -0,0 +1,115 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # DateRangeCategoryTotalsResponse Model.
+  class DateRangeCategoryTotalsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for the category. Defined by MX.
+    # @return [String]
+    attr_accessor :category_guid
+
+    # The Unix timestamp for the end date of the date range.
+    # @return [Integer]
+    attr_accessor :end_date
+
+    # The Unix timestamp for the start date of the date range.
+    # @return [Integer]
+    attr_accessor :start_date
+
+    # The total amount for the category within the date range.
+    # @return [Float]
+    attr_accessor :total
+
+    # The unique identifier for the user. Defined by MX.
+    # @return [String]
+    attr_accessor :user_guid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['category_guid'] = 'category_guid'
+      @_hash['end_date'] = 'end_date'
+      @_hash['start_date'] = 'start_date'
+      @_hash['total'] = 'total'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        category_guid
+        end_date
+        start_date
+        total
+        user_guid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(category_guid: SKIP, end_date: SKIP, start_date: SKIP,
+                   total: SKIP, user_guid: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @category_guid = category_guid unless category_guid == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @total = total unless total == SKIP
+      @user_guid = user_guid unless user_guid == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      category_guid = hash.key?('category_guid') ? hash['category_guid'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      total = hash.key?('total') ? hash['total'] : SKIP
+      user_guid = hash.key?('user_guid') ? hash['user_guid'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      DateRangeCategoryTotalsResponse.new(category_guid: category_guid,
+                                          end_date: end_date,
+                                          start_date: start_date,
+                                          total: total,
+                                          user_guid: user_guid,
+                                          additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} category_guid: #{@category_guid}, end_date: #{@end_date}, start_date:"\
+      " #{@start_date}, total: #{@total}, user_guid: #{@user_guid}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} category_guid: #{@category_guid.inspect}, end_date: #{@end_date.inspect},"\
+      " start_date: #{@start_date.inspect}, total: #{@total.inspect}, user_guid:"\
+      " #{@user_guid.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end