apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/date_range_category_totals_response_body.rb

@@ -0,0 +1,88 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # DateRangeCategoryTotalsResponseBody Model.
+  class DateRangeCategoryTotalsResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[DateRangeCategoryTotalsResponse]]
+    attr_accessor :date_range_category_totals
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['date_range_category_totals'] = 'date_range_category_totals'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        date_range_category_totals
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(date_range_category_totals: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      unless date_range_category_totals == SKIP
+        @date_range_category_totals =
+          date_range_category_totals
+      end
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      date_range_category_totals = nil
+      unless hash['date_range_category_totals'].nil?
+        date_range_category_totals = []
+        hash['date_range_category_totals'].each do |structure|
+          date_range_category_totals << (DateRangeCategoryTotalsResponse.from_hash(structure) if structure)
+        end
+      end
+
+      date_range_category_totals = SKIP unless hash.key?('date_range_category_totals')
+
+      # 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.
+      DateRangeCategoryTotalsResponseBody.new(date_range_category_totals: date_range_category_totals,
+                                              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} date_range_category_totals: #{@date_range_category_totals},"\
+      " 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} date_range_category_totals: #{@date_range_category_totals.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/deep_link_params.rb

@@ -0,0 +1,131 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # Enables widget-specific behavior.
+  class DeepLinkParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Only use this option if the `widget_type` is set to `spending_widget`.
+    # When used with the Legacy Spending Widget, used to filter by account.
+    # Contains an `account_guid` (string) optional param.
+    # @return [String]
+    attr_accessor :account_guid
+
+    # 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).
+    # @return [DateRange]
+    attr_accessor :date_range
+
+    # Only use this option if the `widget_type` is set to
+    # `actionable_integration_widget`. Launches a deep link integration. Valid
+    # value is `direct-deposit`.
+    # @return [String]
+    attr_accessor :launch_integration
+
+    # When used with the Cash Flow, Settings, or Money Dashboard widget, sets
+    # the widget's default view. Valid value for Cash Flow or Money Dashboard
+    # Widgets is `manage_income.` Valid values for the Notifications section of
+    # the Settings Widget (`notifications_settings_widget`) are `accounts`,
+    # `budgets`, or `insights`.
+    # @return [String]
+    attr_accessor :view
+
+    # Only use this option if the `widget_type` is set to `master_widget`.
+    # Launches a specific view in the Master Widget. Valid values are
+    # `accounts`, `budgets`, `cash_flow`, `debts`, `finstrong`, `goals`,
+    # `insights`, `investments`, `networth`, `recurringtransactions`,
+    # `spending`, `transactions`, and `trends`.
+    # @return [String]
+    attr_accessor :widget
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_guid'] = 'account_guid'
+      @_hash['date_range'] = 'date_range'
+      @_hash['launch_integration'] = 'launch_integration'
+      @_hash['view'] = 'view'
+      @_hash['widget'] = 'widget'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_guid
+        date_range
+        launch_integration
+        view
+        widget
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_guid: SKIP, date_range: SKIP,
+                   launch_integration: SKIP, view: SKIP, widget: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_guid = account_guid unless account_guid == SKIP
+      @date_range = date_range unless date_range == SKIP
+      @launch_integration = launch_integration unless launch_integration == SKIP
+      @view = view unless view == SKIP
+      @widget = widget unless widget == 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.
+      account_guid = hash.key?('account_guid') ? hash['account_guid'] : SKIP
+      date_range = DateRange.from_hash(hash['date_range']) if hash['date_range']
+      launch_integration =
+        hash.key?('launch_integration') ? hash['launch_integration'] : SKIP
+      view = hash.key?('view') ? hash['view'] : SKIP
+      widget = hash.key?('widget') ? hash['widget'] : 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.
+      DeepLinkParams.new(account_guid: account_guid,
+                         date_range: date_range,
+                         launch_integration: launch_integration,
+                         view: view,
+                         widget: widget,
+                         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} account_guid: #{@account_guid}, date_range: #{@date_range},"\
+      " launch_integration: #{@launch_integration}, view: #{@view}, widget: #{@widget},"\
+      " 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} account_guid: #{@account_guid.inspect}, date_range: #{@date_range.inspect},"\
+      " launch_integration: #{@launch_integration.inspect}, view: #{@view.inspect}, widget:"\
+      " #{@widget.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/enhance_transaction_response.rb

@@ -0,0 +1,371 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # EnhanceTransactionResponse Model.
+  class EnhanceTransactionResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The monetary amount of the `transaction`.
+    # @return [Float]
+    attr_accessor :amount
+
+    # The method used to determine the category assigned to the transaction.
+    # @return [Integer]
+    attr_accessor :categorized_by
+
+    # The category of the `transaction`.
+    # @return [String]
+    attr_accessor :category
+
+    # The unique identifier for the category. Defined by MX.
+    # @return [String]
+    attr_accessor :category_guid
+
+    # The method used to describe the `transaction`.
+    # @return [Integer]
+    attr_accessor :described_by
+
+    # A human-readable version of the `original_description` field. This is
+    # provided by the MX Platform.
+    # @return [String]
+    attr_accessor :description
+
+    # The transaction type assigned by the partner.
+    # @return [String]
+    attr_accessor :extended_transaction_type
+
+    # The unique partner-defined identifier for the transaction.
+    # @return [String]
+    attr_accessor :id
+
+    # Indicates whether the transaction is a bill payment.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_bill_pay
+
+    # Indicates whether the transaction is a direct deposit.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_direct_deposit
+
+    # Indicates whether the transaction is an expense.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_expense
+
+    # Indicates whether the transaction is a fee.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_fee
+
+    # Indicates whether the transaction is income.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_income
+
+    # Indicates whether the transaction is international. If the data provider
+    # determines it isn't international then it will be `false`. It will be
+    # `null` if the data provider does not have this information.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_international
+
+    # Indicates whether the transaction is an overdraft fee.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_overdraft_fee
+
+    # Indicates whether the transaction is a payroll advance.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_payroll_advance
+
+    # Indicates whether the transaction is a subscription payment.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_subscription
+
+    # This field contains additional descriptive information about the
+    # `transaction`.
+    # @return [String]
+    attr_accessor :memo
+
+    # The ISO 18245 category code for the `transaction`.
+    # @return [Integer]
+    attr_accessor :merchant_category_code
+
+    # The unique identifier for the merchant associated with this `transaction`.
+    # Defined by MX.
+    # @return [String]
+    attr_accessor :merchant_guid
+
+    # The unique identifier for the `merchant_location` associated with this
+    # `transaction`. Defined by MX.
+    # @return [String]
+    attr_accessor :merchant_location_guid
+
+    # The original description of the `transaction` as provided by our data
+    # feed.
+    # @return [String]
+    attr_accessor :original_description
+
+    # The unique identifier for the `top_level_category` associated with this
+    # `transaction`. Defined by MX.
+    # @return [String]
+    attr_accessor :top_level_category_guid
+
+    # The type of transaction. Can be either `CREDIT` or `DEBIT`.
+    # @return [Type]
+    attr_accessor :type
+
+    # 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['amount'] = 'amount'
+      @_hash['categorized_by'] = 'categorized_by'
+      @_hash['category'] = 'category'
+      @_hash['category_guid'] = 'category_guid'
+      @_hash['described_by'] = 'described_by'
+      @_hash['description'] = 'description'
+      @_hash['extended_transaction_type'] = 'extended_transaction_type'
+      @_hash['id'] = 'id'
+      @_hash['is_bill_pay'] = 'is_bill_pay'
+      @_hash['is_direct_deposit'] = 'is_direct_deposit'
+      @_hash['is_expense'] = 'is_expense'
+      @_hash['is_fee'] = 'is_fee'
+      @_hash['is_income'] = 'is_income'
+      @_hash['is_international'] = 'is_international'
+      @_hash['is_overdraft_fee'] = 'is_overdraft_fee'
+      @_hash['is_payroll_advance'] = 'is_payroll_advance'
+      @_hash['is_subscription'] = 'is_subscription'
+      @_hash['memo'] = 'memo'
+      @_hash['merchant_category_code'] = 'merchant_category_code'
+      @_hash['merchant_guid'] = 'merchant_guid'
+      @_hash['merchant_location_guid'] = 'merchant_location_guid'
+      @_hash['original_description'] = 'original_description'
+      @_hash['top_level_category_guid'] = 'top_level_category_guid'
+      @_hash['type'] = 'type'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        categorized_by
+        category
+        category_guid
+        described_by
+        description
+        extended_transaction_type
+        id
+        is_bill_pay
+        is_direct_deposit
+        is_expense
+        is_fee
+        is_income
+        is_international
+        is_overdraft_fee
+        is_payroll_advance
+        is_subscription
+        memo
+        merchant_category_code
+        merchant_guid
+        merchant_location_guid
+        original_description
+        top_level_category_guid
+        type
+        user_guid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        amount
+        categorized_by
+        category
+        category_guid
+        described_by
+        description
+        extended_transaction_type
+        id
+        is_bill_pay
+        is_direct_deposit
+        is_expense
+        is_fee
+        is_income
+        is_overdraft_fee
+        is_payroll_advance
+        is_subscription
+        memo
+        merchant_category_code
+        merchant_guid
+        merchant_location_guid
+        original_description
+        top_level_category_guid
+        type
+        user_guid
+      ]
+    end
+
+    def initialize(amount: SKIP, categorized_by: SKIP, category: SKIP,
+                   category_guid: SKIP, described_by: SKIP, description: SKIP,
+                   extended_transaction_type: SKIP, id: SKIP, is_bill_pay: SKIP,
+                   is_direct_deposit: SKIP, is_expense: SKIP, is_fee: SKIP,
+                   is_income: SKIP, is_international: SKIP,
+                   is_overdraft_fee: SKIP, is_payroll_advance: SKIP,
+                   is_subscription: SKIP, memo: SKIP,
+                   merchant_category_code: SKIP, merchant_guid: SKIP,
+                   merchant_location_guid: SKIP, original_description: SKIP,
+                   top_level_category_guid: SKIP, type: SKIP, user_guid: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount unless amount == SKIP
+      @categorized_by = categorized_by unless categorized_by == SKIP
+      @category = category unless category == SKIP
+      @category_guid = category_guid unless category_guid == SKIP
+      @described_by = described_by unless described_by == SKIP
+      @description = description unless description == SKIP
+      unless extended_transaction_type == SKIP
+        @extended_transaction_type =
+          extended_transaction_type
+      end
+      @id = id unless id == SKIP
+      @is_bill_pay = is_bill_pay unless is_bill_pay == SKIP
+      @is_direct_deposit = is_direct_deposit unless is_direct_deposit == SKIP
+      @is_expense = is_expense unless is_expense == SKIP
+      @is_fee = is_fee unless is_fee == SKIP
+      @is_income = is_income unless is_income == SKIP
+      @is_international = is_international unless is_international == SKIP
+      @is_overdraft_fee = is_overdraft_fee unless is_overdraft_fee == SKIP
+      @is_payroll_advance = is_payroll_advance unless is_payroll_advance == SKIP
+      @is_subscription = is_subscription unless is_subscription == SKIP
+      @memo = memo unless memo == SKIP
+      @merchant_category_code = merchant_category_code unless merchant_category_code == SKIP
+      @merchant_guid = merchant_guid unless merchant_guid == SKIP
+      @merchant_location_guid = merchant_location_guid unless merchant_location_guid == SKIP
+      @original_description = original_description unless original_description == SKIP
+      @top_level_category_guid = top_level_category_guid unless top_level_category_guid == SKIP
+      @type = type unless type == 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.
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      categorized_by =
+        hash.key?('categorized_by') ? hash['categorized_by'] : SKIP
+      category = hash.key?('category') ? hash['category'] : SKIP
+      category_guid = hash.key?('category_guid') ? hash['category_guid'] : SKIP
+      described_by = hash.key?('described_by') ? hash['described_by'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      extended_transaction_type =
+        hash.key?('extended_transaction_type') ? hash['extended_transaction_type'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      is_bill_pay = hash.key?('is_bill_pay') ? hash['is_bill_pay'] : SKIP
+      is_direct_deposit =
+        hash.key?('is_direct_deposit') ? hash['is_direct_deposit'] : SKIP
+      is_expense = hash.key?('is_expense') ? hash['is_expense'] : SKIP
+      is_fee = hash.key?('is_fee') ? hash['is_fee'] : SKIP
+      is_income = hash.key?('is_income') ? hash['is_income'] : SKIP
+      is_international =
+        hash.key?('is_international') ? hash['is_international'] : SKIP
+      is_overdraft_fee =
+        hash.key?('is_overdraft_fee') ? hash['is_overdraft_fee'] : SKIP
+      is_payroll_advance =
+        hash.key?('is_payroll_advance') ? hash['is_payroll_advance'] : SKIP
+      is_subscription =
+        hash.key?('is_subscription') ? hash['is_subscription'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      merchant_category_code =
+        hash.key?('merchant_category_code') ? hash['merchant_category_code'] : SKIP
+      merchant_guid = hash.key?('merchant_guid') ? hash['merchant_guid'] : SKIP
+      merchant_location_guid =
+        hash.key?('merchant_location_guid') ? hash['merchant_location_guid'] : SKIP
+      original_description =
+        hash.key?('original_description') ? hash['original_description'] : SKIP
+      top_level_category_guid =
+        hash.key?('top_level_category_guid') ? hash['top_level_category_guid'] : SKIP
+      type = hash.key?('type') ? hash['type'] : 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.
+      EnhanceTransactionResponse.new(amount: amount,
+                                     categorized_by: categorized_by,
+                                     category: category,
+                                     category_guid: category_guid,
+                                     described_by: described_by,
+                                     description: description,
+                                     extended_transaction_type: extended_transaction_type,
+                                     id: id,
+                                     is_bill_pay: is_bill_pay,
+                                     is_direct_deposit: is_direct_deposit,
+                                     is_expense: is_expense,
+                                     is_fee: is_fee,
+                                     is_income: is_income,
+                                     is_international: is_international,
+                                     is_overdraft_fee: is_overdraft_fee,
+                                     is_payroll_advance: is_payroll_advance,
+                                     is_subscription: is_subscription,
+                                     memo: memo,
+                                     merchant_category_code: merchant_category_code,
+                                     merchant_guid: merchant_guid,
+                                     merchant_location_guid: merchant_location_guid,
+                                     original_description: original_description,
+                                     top_level_category_guid: top_level_category_guid,
+                                     type: type,
+                                     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} amount: #{@amount}, categorized_by: #{@categorized_by}, category:"\
+      " #{@category}, category_guid: #{@category_guid}, described_by: #{@described_by},"\
+      " description: #{@description}, extended_transaction_type: #{@extended_transaction_type},"\
+      " id: #{@id}, is_bill_pay: #{@is_bill_pay}, is_direct_deposit: #{@is_direct_deposit},"\
+      " is_expense: #{@is_expense}, is_fee: #{@is_fee}, is_income: #{@is_income},"\
+      " is_international: #{@is_international}, is_overdraft_fee: #{@is_overdraft_fee},"\
+      " is_payroll_advance: #{@is_payroll_advance}, is_subscription: #{@is_subscription}, memo:"\
+      " #{@memo}, merchant_category_code: #{@merchant_category_code}, merchant_guid:"\
+      " #{@merchant_guid}, merchant_location_guid: #{@merchant_location_guid},"\
+      " original_description: #{@original_description}, top_level_category_guid:"\
+      " #{@top_level_category_guid}, type: #{@type}, 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} amount: #{@amount.inspect}, categorized_by: #{@categorized_by.inspect},"\
+      " category: #{@category.inspect}, category_guid: #{@category_guid.inspect}, described_by:"\
+      " #{@described_by.inspect}, description: #{@description.inspect}, extended_transaction_type:"\
+      " #{@extended_transaction_type.inspect}, id: #{@id.inspect}, is_bill_pay:"\
+      " #{@is_bill_pay.inspect}, is_direct_deposit: #{@is_direct_deposit.inspect}, is_expense:"\
+      " #{@is_expense.inspect}, is_fee: #{@is_fee.inspect}, is_income: #{@is_income.inspect},"\
+      " is_international: #{@is_international.inspect}, is_overdraft_fee:"\
+      " #{@is_overdraft_fee.inspect}, is_payroll_advance: #{@is_payroll_advance.inspect},"\
+      " is_subscription: #{@is_subscription.inspect}, memo: #{@memo.inspect},"\
+      " merchant_category_code: #{@merchant_category_code.inspect}, merchant_guid:"\
+      " #{@merchant_guid.inspect}, merchant_location_guid: #{@merchant_location_guid.inspect},"\
+      " original_description: #{@original_description.inspect}, top_level_category_guid:"\
+      " #{@top_level_category_guid.inspect}, type: #{@type.inspect}, user_guid:"\
+      " #{@user_guid.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end