mt-sdk 0.0.1

data/lib/modern_treasury/models/foreign_exchange_indicator_enum.rb

@@ -0,0 +1,38 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # Indicates the type of FX transfer to initiate, can be either
+  # `variable_to_fixed`, `fixed_to_variable`, or `null` if the payment order
+  # currency matches the originating account currency.
+  class ForeignExchangeIndicatorEnum
+    FOREIGN_EXCHANGE_INDICATOR_ENUM = [
+      # TODO: Write general description for FIXED_TO_VARIABLE
+      FIXED_TO_VARIABLE = 'fixed_to_variable'.freeze,
+
+      # TODO: Write general description for VARIABLE_TO_FIXED
+      VARIABLE_TO_FIXED = 'variable_to_fixed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FOREIGN_EXCHANGE_INDICATOR_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = FIXED_TO_VARIABLE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'fixed_to_variable' then FIXED_TO_VARIABLE
+      when 'variable_to_fixed' then VARIABLE_TO_FIXED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/incoming_payment_detail.rb

@@ -0,0 +1,348 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # IncomingPaymentDetail Model.
+  class IncomingPaymentDetail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :object
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :live_mode
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # This field will be true if this object exists in the live environment or
+    # false if it exists in the test environment.
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # The ID of the Internal Account for the incoming payment detail. This is
+    # always present.
+    # @return [UUID | String]
+    attr_accessor :internal_account_id
+
+    # If the incoming payment detail is in a virtual account, the ID of the
+    # Virtual Account.
+    # @return [UUID | String]
+    attr_accessor :virtual_account_id
+
+    # If the incoming payment detail is in a virtual account, the ID of the
+    # Virtual Account.
+    # @return [VirtualAccount]
+    attr_accessor :virtual_account
+
+    # The ID of the reconciled Transaction Line Item or `null`.
+    # @return [UUID | String]
+    attr_accessor :transaction_line_item_id
+
+    # The ID of the reconciled Transaction or `null`.
+    # @return [UUID | String]
+    attr_accessor :transaction_id
+
+    # The ID of the ledger transaction linked to the incoming payment detail or
+    # `null`.
+    # @return [UUID | String]
+    attr_accessor :ledger_transaction_id
+
+    # One of: `ach`, `book`, `check`, `eft`, `interac`, `rtp`, `sepa`, `signet`,
+    # or `wire`.
+    # @return [Type4Enum]
+    attr_accessor :type
+
+    # The raw data from the payment pre-notification file that we get from the
+    # bank.
+    # @return [Object]
+    attr_accessor :data
+
+    # Value in specified currency's smallest unit. e.g. $10 would be represented
+    # as 1000.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # Three-letter ISO currency code.
+    # @return [CurrencyEnum]
+    attr_accessor :currency
+
+    # One of `credit` or `debit`.
+    # @return [Direction4Enum]
+    attr_accessor :direction
+
+    # The current status of the incoming payment order. One of `pending`,
+    # `completed`, or `returned`.
+    # @return [Status2Enum]
+    attr_accessor :status
+
+    # Additional data represented as key-value pairs. Both the key and value
+    # must be strings.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # The date on which the corresponding transaction will occur.
+    # @return [Date]
+    attr_accessor :as_of_date
+
+    # The identifier of the vendor bank.
+    # @return [UUID | String]
+    attr_accessor :vendor_id
+
+    # The routing number of the originating account for the incoming payment
+    # detail.
+    # @return [String]
+    attr_accessor :originating_routing_number
+
+    # The type of the originating routing number for the incoming payment
+    # detail.
+    # @return [OriginatingRoutingNumberTypeEnum]
+    attr_accessor :originating_routing_number_type
+
+    # The account number of the originating account for the incoming payment
+    # detail.
+    # @return [String]
+    attr_accessor :originating_account_number
+
+    # The last 4 digits of the originating account_number for the incoming
+    # payment detail.
+    # @return [String]
+    attr_accessor :originating_account_number_safe
+
+    # The type of the originating account number for the incoming payment
+    # detail.
+    # @return [OriginatingAccountNumberTypeEnum]
+    attr_accessor :originating_account_number_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['object'] = 'object'
+      @_hash['live_mode'] = 'live_mode'
+      @_hash['created_at'] = 'created_at'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['internal_account_id'] = 'internal_account_id'
+      @_hash['virtual_account_id'] = 'virtual_account_id'
+      @_hash['virtual_account'] = 'virtual_account'
+      @_hash['transaction_line_item_id'] = 'transaction_line_item_id'
+      @_hash['transaction_id'] = 'transaction_id'
+      @_hash['ledger_transaction_id'] = 'ledger_transaction_id'
+      @_hash['type'] = 'type'
+      @_hash['data'] = 'data'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['direction'] = 'direction'
+      @_hash['status'] = 'status'
+      @_hash['metadata'] = 'metadata'
+      @_hash['as_of_date'] = 'as_of_date'
+      @_hash['vendor_id'] = 'vendor_id'
+      @_hash['originating_routing_number'] = 'originating_routing_number'
+      @_hash['originating_routing_number_type'] =
+        'originating_routing_number_type'
+      @_hash['originating_account_number'] = 'originating_account_number'
+      @_hash['originating_account_number_safe'] =
+        'originating_account_number_safe'
+      @_hash['originating_account_number_type'] =
+        'originating_account_number_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        originating_account_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        virtual_account_id
+        transaction_line_item_id
+        transaction_id
+        ledger_transaction_id
+        vendor_id
+        originating_routing_number
+        originating_routing_number_type
+        originating_account_number
+        originating_account_number_safe
+        originating_account_number_type
+      ]
+    end
+
+    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
+                   updated_at = nil, internal_account_id = nil,
+                   virtual_account_id = nil, virtual_account = nil,
+                   transaction_line_item_id = nil, transaction_id = nil,
+                   ledger_transaction_id = nil, type = nil, data = nil,
+                   amount = nil, currency = nil, direction = nil, status = nil,
+                   metadata = nil, as_of_date = nil, vendor_id = nil,
+                   originating_routing_number = nil,
+                   originating_routing_number_type = nil,
+                   originating_account_number_safe = nil,
+                   originating_account_number_type = nil,
+                   originating_account_number = SKIP)
+      @id = id
+      @object = object
+      @live_mode = live_mode
+      @created_at = created_at
+      @updated_at = updated_at
+      @internal_account_id = internal_account_id
+      @virtual_account_id = virtual_account_id
+      @virtual_account = virtual_account
+      @transaction_line_item_id = transaction_line_item_id
+      @transaction_id = transaction_id
+      @ledger_transaction_id = ledger_transaction_id
+      @type = type
+      @data = data
+      @amount = amount
+      @currency = currency
+      @direction = direction
+      @status = status
+      @metadata = metadata
+      @as_of_date = as_of_date
+      @vendor_id = vendor_id
+      @originating_routing_number = originating_routing_number
+      @originating_routing_number_type = originating_routing_number_type
+      unless originating_account_number == SKIP
+        @originating_account_number =
+          originating_account_number
+      end
+      @originating_account_number_safe = originating_account_number_safe
+      @originating_account_number_type = originating_account_number_type
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : nil
+      object = hash.key?('object') ? hash['object'] : nil
+      live_mode = hash.key?('live_mode') ? hash['live_mode'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      updated_at = if hash.key?('updated_at')
+                     (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
+                   end
+      internal_account_id =
+        hash.key?('internal_account_id') ? hash['internal_account_id'] : nil
+      virtual_account_id =
+        hash.key?('virtual_account_id') ? hash['virtual_account_id'] : nil
+      virtual_account = VirtualAccount.from_hash(hash['virtual_account']) if
+        hash['virtual_account']
+      transaction_line_item_id =
+        hash.key?('transaction_line_item_id') ? hash['transaction_line_item_id'] : nil
+      transaction_id =
+        hash.key?('transaction_id') ? hash['transaction_id'] : nil
+      ledger_transaction_id =
+        hash.key?('ledger_transaction_id') ? hash['ledger_transaction_id'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      data = hash.key?('data') ? hash['data'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      direction = hash.key?('direction') ? hash['direction'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+      as_of_date = hash.key?('as_of_date') ? hash['as_of_date'] : nil
+      vendor_id = hash.key?('vendor_id') ? hash['vendor_id'] : nil
+      originating_routing_number =
+        hash.key?('originating_routing_number') ? hash['originating_routing_number'] : nil
+      originating_routing_number_type =
+        hash.key?('originating_routing_number_type') ? hash['originating_routing_number_type'] : nil
+      originating_account_number_safe =
+        hash.key?('originating_account_number_safe') ? hash['originating_account_number_safe'] : nil
+      originating_account_number_type =
+        hash.key?('originating_account_number_type') ? hash['originating_account_number_type'] : nil
+      originating_account_number =
+        hash.key?('originating_account_number') ? hash['originating_account_number'] : SKIP
+
+      # Create object from extracted values.
+      IncomingPaymentDetail.new(id,
+                                object,
+                                live_mode,
+                                created_at,
+                                updated_at,
+                                internal_account_id,
+                                virtual_account_id,
+                                virtual_account,
+                                transaction_line_item_id,
+                                transaction_id,
+                                ledger_transaction_id,
+                                type,
+                                data,
+                                amount,
+                                currency,
+                                direction,
+                                status,
+                                metadata,
+                                as_of_date,
+                                vendor_id,
+                                originating_routing_number,
+                                originating_routing_number_type,
+                                originating_account_number_safe,
+                                originating_account_number_type,
+                                originating_account_number)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, object: #{@object}, live_mode: #{@live_mode}, created_at:"\
+      " #{@created_at}, updated_at: #{@updated_at}, internal_account_id: #{@internal_account_id},"\
+      " virtual_account_id: #{@virtual_account_id}, virtual_account: #{@virtual_account},"\
+      " transaction_line_item_id: #{@transaction_line_item_id}, transaction_id:"\
+      " #{@transaction_id}, ledger_transaction_id: #{@ledger_transaction_id}, type: #{@type},"\
+      " data: #{@data}, amount: #{@amount}, currency: #{@currency}, direction: #{@direction},"\
+      " status: #{@status}, metadata: #{@metadata}, as_of_date: #{@as_of_date}, vendor_id:"\
+      " #{@vendor_id}, originating_routing_number: #{@originating_routing_number},"\
+      " originating_routing_number_type: #{@originating_routing_number_type},"\
+      " originating_account_number: #{@originating_account_number},"\
+      " originating_account_number_safe: #{@originating_account_number_safe},"\
+      " originating_account_number_type: #{@originating_account_number_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, object: #{@object.inspect}, live_mode:"\
+      " #{@live_mode.inspect}, created_at: #{@created_at.inspect}, updated_at:"\
+      " #{@updated_at.inspect}, internal_account_id: #{@internal_account_id.inspect},"\
+      " virtual_account_id: #{@virtual_account_id.inspect}, virtual_account:"\
+      " #{@virtual_account.inspect}, transaction_line_item_id:"\
+      " #{@transaction_line_item_id.inspect}, transaction_id: #{@transaction_id.inspect},"\
+      " ledger_transaction_id: #{@ledger_transaction_id.inspect}, type: #{@type.inspect}, data:"\
+      " #{@data.inspect}, amount: #{@amount.inspect}, currency: #{@currency.inspect}, direction:"\
+      " #{@direction.inspect}, status: #{@status.inspect}, metadata: #{@metadata.inspect},"\
+      " as_of_date: #{@as_of_date.inspect}, vendor_id: #{@vendor_id.inspect},"\
+      " originating_routing_number: #{@originating_routing_number.inspect},"\
+      " originating_routing_number_type: #{@originating_routing_number_type.inspect},"\
+      " originating_account_number: #{@originating_account_number.inspect},"\
+      " originating_account_number_safe: #{@originating_account_number_safe.inspect},"\
+      " originating_account_number_type: #{@originating_account_number_type.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/incoming_payment_detail_create_request.rb

@@ -0,0 +1,141 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # IncomingPaymentDetailCreateRequest Model.
+  class IncomingPaymentDetailCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # One of `ach`, `wire`, `check`.
+    # @return [Type10Enum]
+    attr_accessor :type
+
+    # One of `credit`, `debit`.
+    # @return [Direction14Enum]
+    attr_accessor :direction
+
+    # Value in specified currency's smallest unit. e.g. $10 would be represented
+    # as 1000.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # Three-letter ISO currency code.
+    # @return [CurrencyEnum]
+    attr_accessor :currency
+
+    # The ID of one of your internal accounts.
+    # @return [UUID | String]
+    attr_accessor :internal_account_id
+
+    # An optional parameter to associate the incoming payment detail to a
+    # virtual account.
+    # @return [UUID | String]
+    attr_accessor :virtual_account_id
+
+    # Defaults to today.
+    # @return [Date]
+    attr_accessor :as_of_date
+
+    # Defaults to a random description.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['direction'] = 'direction'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['internal_account_id'] = 'internal_account_id'
+      @_hash['virtual_account_id'] = 'virtual_account_id'
+      @_hash['as_of_date'] = 'as_of_date'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        direction
+        amount
+        currency
+        internal_account_id
+        virtual_account_id
+        as_of_date
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        virtual_account_id
+        as_of_date
+        description
+      ]
+    end
+
+    def initialize(type = SKIP, direction = SKIP, amount = SKIP,
+                   currency = SKIP, internal_account_id = SKIP,
+                   virtual_account_id = SKIP, as_of_date = SKIP,
+                   description = SKIP)
+      @type = type unless type == SKIP
+      @direction = direction unless direction == SKIP
+      @amount = amount unless amount == SKIP
+      @currency = currency unless currency == SKIP
+      @internal_account_id = internal_account_id unless internal_account_id == SKIP
+      @virtual_account_id = virtual_account_id unless virtual_account_id == SKIP
+      @as_of_date = as_of_date unless as_of_date == SKIP
+      @description = description unless description == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      direction = hash.key?('direction') ? hash['direction'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      internal_account_id =
+        hash.key?('internal_account_id') ? hash['internal_account_id'] : SKIP
+      virtual_account_id =
+        hash.key?('virtual_account_id') ? hash['virtual_account_id'] : SKIP
+      as_of_date = hash.key?('as_of_date') ? hash['as_of_date'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+
+      # Create object from extracted values.
+      IncomingPaymentDetailCreateRequest.new(type,
+                                             direction,
+                                             amount,
+                                             currency,
+                                             internal_account_id,
+                                             virtual_account_id,
+                                             as_of_date,
+                                             description)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, direction: #{@direction}, amount: #{@amount}, currency:"\
+      " #{@currency}, internal_account_id: #{@internal_account_id}, virtual_account_id:"\
+      " #{@virtual_account_id}, as_of_date: #{@as_of_date}, description: #{@description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, direction: #{@direction.inspect}, amount:"\
+      " #{@amount.inspect}, currency: #{@currency.inspect}, internal_account_id:"\
+      " #{@internal_account_id.inspect}, virtual_account_id: #{@virtual_account_id.inspect},"\
+      " as_of_date: #{@as_of_date.inspect}, description: #{@description.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/incoming_payment_detail_update_request.rb

@@ -0,0 +1,63 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # IncomingPaymentDetailUpdateRequest Model.
+  class IncomingPaymentDetailUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Additional data in the form of key-value pairs. Pairs can be removed by
+    # passing an empty string or `null` as the value.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metadata = SKIP)
+      @metadata = metadata unless metadata == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+
+      # Create object from extracted values.
+      IncomingPaymentDetailUpdateRequest.new(metadata)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata.inspect}>"
+    end
+  end
+end