mt-sdk 0.0.1

data/lib/modern_treasury/models/line_item_request.rb

@@ -0,0 +1,98 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # LineItemRequest Model.
+  class LineItemRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Value in specified currency's smallest unit. e.g. $10 would be represented
+    # as 1000.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # Additional data represented as key-value pairs. Both the key and value
+    # must be strings.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # A free-form description of the line item.
+    # @return [String]
+    attr_accessor :description
+
+    # The ID of one of your accounting categories. Note that these will only be
+    # accessible if your accounting system has been connected.
+    # @return [String]
+    attr_accessor :accounting_category_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['metadata'] = 'metadata'
+      @_hash['description'] = 'description'
+      @_hash['accounting_category_id'] = 'accounting_category_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+        description
+        accounting_category_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        accounting_category_id
+      ]
+    end
+
+    def initialize(amount = nil, metadata = SKIP, description = SKIP,
+                   accounting_category_id = SKIP)
+      @amount = amount
+      @metadata = metadata unless metadata == SKIP
+      @description = description unless description == SKIP
+      @accounting_category_id = accounting_category_id unless accounting_category_id == 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.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      accounting_category_id =
+        hash.key?('accounting_category_id') ? hash['accounting_category_id'] : SKIP
+
+      # Create object from extracted values.
+      LineItemRequest.new(amount,
+                          metadata,
+                          description,
+                          accounting_category_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, metadata: #{@metadata}, description: #{@description},"\
+      " accounting_category_id: #{@accounting_category_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, metadata: #{@metadata.inspect}, description:"\
+      " #{@description.inspect}, accounting_category_id: #{@accounting_category_id.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/line_item_update_request.rb

@@ -0,0 +1,63 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # LineItemUpdateRequest Model.
+  class LineItemUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Additional data represented as key-value pairs. Both the key and value
+    # must be strings.
+    # @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.
+      LineItemUpdateRequest.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

data/lib/modern_treasury/models/mreturn.rb

@@ -0,0 +1,425 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # Return Model.
+  class Return < 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 object being returned or `null`.
+    # @return [UUID | String]
+    attr_accessor :returnable_id
+
+    # The type of object being returned or `null`.
+    # @return [ReturnableTypeEnum]
+    attr_accessor :returnable_type
+
+    # The return code. For ACH returns, this is the required ACH return code.
+    # @return [Code1Enum]
+    attr_accessor :code
+
+    # Often the bank will provide an explanation for the return, which is a
+    # short human readable string.
+    # @return [String]
+    attr_accessor :reason
+
+    # If the return code is `R14` or `R15` this is the date the deceased
+    # counterparty passed away.
+    # @return [Date]
+    attr_accessor :date_of_death
+
+    # Some returns may include additional information from the bank. In these
+    # cases, this string will be present.
+    # @return [String]
+    attr_accessor :additional_information
+
+    # The current status of the return.
+    # @return [Status4Enum]
+    attr_accessor :status
+
+    # The ID of the relevant Transaction Line Item or `null`.
+    # @return [UUID | String]
+    attr_accessor :transaction_line_item_id
+
+    # The ID of the relevant Transaction or `null`.
+    # @return [UUID | String]
+    attr_accessor :transaction_id
+
+    # The ID of the relevant Internal Account.
+    # @return [UUID | String]
+    attr_accessor :internal_account_id
+
+    # The type of return. Can be one of: `ach`, `ach_noc`, `au_becs`, `bacs`,
+    # `eft`, `interac`, `manual`, `paper_item`, `wire`.
+    # @return [Type6Enum]
+    attr_accessor :type
+
+    # 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
+
+    # If an originating return failed to be processed by the bank, a description
+    # of the failure reason will be available.
+    # @return [String]
+    attr_accessor :failure_reason
+
+    # The role of the return, can be `originating` or `receiving`.
+    # @return [RoleEnum]
+    attr_accessor :role
+
+    # The role of the return, can be `originating` or `receiving`.
+    # @return [Return]
+    attr_accessor :current_return
+
+    # An array of Payment Reference objects.
+    # @return [Array[PaymentReference]]
+    attr_accessor :reference_numbers
+
+    # The ID of the ledger transaction linked to the return.
+    # @return [UUID | String]
+    attr_accessor :ledger_transaction_id
+
+    # 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['returnable_id'] = 'returnable_id'
+      @_hash['returnable_type'] = 'returnable_type'
+      @_hash['code'] = 'code'
+      @_hash['reason'] = 'reason'
+      @_hash['date_of_death'] = 'date_of_death'
+      @_hash['additional_information'] = 'additional_information'
+      @_hash['status'] = 'status'
+      @_hash['transaction_line_item_id'] = 'transaction_line_item_id'
+      @_hash['transaction_id'] = 'transaction_id'
+      @_hash['internal_account_id'] = 'internal_account_id'
+      @_hash['type'] = 'type'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['failure_reason'] = 'failure_reason'
+      @_hash['role'] = 'role'
+      @_hash['current_return'] = 'current_return'
+      @_hash['reference_numbers'] = 'reference_numbers'
+      @_hash['ledger_transaction_id'] = 'ledger_transaction_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        returnable_id
+        returnable_type
+        code
+        reason
+        date_of_death
+        additional_information
+        transaction_line_item_id
+        transaction_id
+        internal_account_id
+        failure_reason
+        ledger_transaction_id
+      ]
+    end
+
+    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
+                   updated_at = nil, returnable_id = nil, returnable_type = nil,
+                   code = nil, reason = nil, date_of_death = nil,
+                   additional_information = nil, status = nil,
+                   transaction_line_item_id = nil, transaction_id = nil,
+                   internal_account_id = nil, type = nil, amount = nil,
+                   currency = nil, failure_reason = nil, role = nil,
+                   current_return = nil, reference_numbers = nil,
+                   ledger_transaction_id = nil)
+      @id = id
+      @object = object
+      @live_mode = live_mode
+      @created_at = created_at
+      @updated_at = updated_at
+      @returnable_id = returnable_id
+      @returnable_type = returnable_type
+      @code = code
+      @reason = reason
+      @date_of_death = date_of_death
+      @additional_information = additional_information
+      @status = status
+      @transaction_line_item_id = transaction_line_item_id
+      @transaction_id = transaction_id
+      @internal_account_id = internal_account_id
+      @type = type
+      @amount = amount
+      @currency = currency
+      @failure_reason = failure_reason
+      @role = role
+      @current_return = current_return
+      @reference_numbers = reference_numbers
+      @ledger_transaction_id = ledger_transaction_id
+    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
+      returnable_id = hash.key?('returnable_id') ? hash['returnable_id'] : nil
+      returnable_type =
+        hash.key?('returnable_type') ? hash['returnable_type'] : nil
+      code = hash.key?('code') ? hash['code'] : nil
+      reason = hash.key?('reason') ? hash['reason'] : nil
+      date_of_death = hash.key?('date_of_death') ? hash['date_of_death'] : nil
+      additional_information =
+        hash.key?('additional_information') ? hash['additional_information'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      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
+      internal_account_id =
+        hash.key?('internal_account_id') ? hash['internal_account_id'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      failure_reason =
+        hash.key?('failure_reason') ? hash['failure_reason'] : nil
+      role = hash.key?('role') ? hash['role'] : nil
+      current_return = Return.from_hash(hash['current_return']) if hash['current_return']
+      # Parameter is an array, so we need to iterate through it
+      reference_numbers = nil
+      unless hash['reference_numbers'].nil?
+        reference_numbers = []
+        hash['reference_numbers'].each do |structure|
+          reference_numbers << (PaymentReference.from_hash(structure) if structure)
+        end
+      end
+
+      reference_numbers = nil unless hash.key?('reference_numbers')
+      ledger_transaction_id =
+        hash.key?('ledger_transaction_id') ? hash['ledger_transaction_id'] : nil
+
+      # Create object from extracted values.
+      Return.new(id,
+                 object,
+                 live_mode,
+                 created_at,
+                 updated_at,
+                 returnable_id,
+                 returnable_type,
+                 code,
+                 reason,
+                 date_of_death,
+                 additional_information,
+                 status,
+                 transaction_line_item_id,
+                 transaction_id,
+                 internal_account_id,
+                 type,
+                 amount,
+                 currency,
+                 failure_reason,
+                 role,
+                 current_return,
+                 reference_numbers,
+                 ledger_transaction_id)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_updated_at
+      DateTimeHelper.to_rfc3339(updated_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Return | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.object,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.live_mode,
+                                  ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+            APIHelper.valid_type?(value.created_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.updated_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.returnable_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.returnable_type,
+                                  ->(val) { ReturnableTypeEnum.validate(val) }) and
+            APIHelper.valid_type?(value.code,
+                                  ->(val) { Code1Enum.validate(val) }) and
+            APIHelper.valid_type?(value.reason,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.date_of_death,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.additional_information,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.status,
+                                  ->(val) { Status4Enum.validate(val) }) and
+            APIHelper.valid_type?(value.transaction_line_item_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.transaction_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.internal_account_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.type,
+                                  ->(val) { Type6Enum.validate(val) }) and
+            APIHelper.valid_type?(value.amount,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.currency,
+                                  ->(val) { CurrencyEnum.validate(val) }) and
+            APIHelper.valid_type?(value.failure_reason,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.role,
+                                  ->(val) { RoleEnum.validate(val) }) and
+            APIHelper.valid_type?(value.current_return,
+                                  ->(val) { Return.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.reference_numbers,
+                                  ->(val) { PaymentReference.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.ledger_transaction_id,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['object'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['live_mode'],
+                                ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+          APIHelper.valid_type?(value['created_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['updated_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['returnable_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['returnable_type'],
+                                ->(val) { ReturnableTypeEnum.validate(val) }) and
+          APIHelper.valid_type?(value['code'],
+                                ->(val) { Code1Enum.validate(val) }) and
+          APIHelper.valid_type?(value['reason'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['date_of_death'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['additional_information'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['status'],
+                                ->(val) { Status4Enum.validate(val) }) and
+          APIHelper.valid_type?(value['transaction_line_item_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['transaction_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['internal_account_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['type'],
+                                ->(val) { Type6Enum.validate(val) }) and
+          APIHelper.valid_type?(value['amount'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['currency'],
+                                ->(val) { CurrencyEnum.validate(val) }) and
+          APIHelper.valid_type?(value['failure_reason'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['role'],
+                                ->(val) { RoleEnum.validate(val) }) and
+          APIHelper.valid_type?(value['current_return'],
+                                ->(val) { Return.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['reference_numbers'],
+                                ->(val) { PaymentReference.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['ledger_transaction_id'],
+                                ->(val) { val.instance_of? String })
+      )
+    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}, returnable_id: #{@returnable_id},"\
+      " returnable_type: #{@returnable_type}, code: #{@code}, reason: #{@reason}, date_of_death:"\
+      " #{@date_of_death}, additional_information: #{@additional_information}, status: #{@status},"\
+      " transaction_line_item_id: #{@transaction_line_item_id}, transaction_id:"\
+      " #{@transaction_id}, internal_account_id: #{@internal_account_id}, type: #{@type}, amount:"\
+      " #{@amount}, currency: #{@currency}, failure_reason: #{@failure_reason}, role: #{@role},"\
+      " current_return: #{@current_return}, reference_numbers: #{@reference_numbers},"\
+      " ledger_transaction_id: #{@ledger_transaction_id}>"
+    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}, returnable_id: #{@returnable_id.inspect}, returnable_type:"\
+      " #{@returnable_type.inspect}, code: #{@code.inspect}, reason: #{@reason.inspect},"\
+      " date_of_death: #{@date_of_death.inspect}, additional_information:"\
+      " #{@additional_information.inspect}, status: #{@status.inspect}, transaction_line_item_id:"\
+      " #{@transaction_line_item_id.inspect}, transaction_id: #{@transaction_id.inspect},"\
+      " internal_account_id: #{@internal_account_id.inspect}, type: #{@type.inspect}, amount:"\
+      " #{@amount.inspect}, currency: #{@currency.inspect}, failure_reason:"\
+      " #{@failure_reason.inspect}, role: #{@role.inspect}, current_return:"\
+      " #{@current_return.inspect}, reference_numbers: #{@reference_numbers.inspect},"\
+      " ledger_transaction_id: #{@ledger_transaction_id.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/normal_balance2_enum.rb

@@ -0,0 +1,36 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # The normal balance of the ledger account category.
+  class NormalBalance2Enum
+    NORMAL_BALANCE2_ENUM = [
+      # TODO: Write general description for CREDIT
+      CREDIT = 'credit'.freeze,
+
+      # TODO: Write general description for DEBIT
+      DEBIT = 'debit'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      NORMAL_BALANCE2_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = CREDIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'credit' then CREDIT
+      when 'debit' then DEBIT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/normal_balance_enum.rb

@@ -0,0 +1,36 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # The normal balance of the ledger account.
+  class NormalBalanceEnum
+    NORMAL_BALANCE_ENUM = [
+      # TODO: Write general description for CREDIT
+      CREDIT = 'credit'.freeze,
+
+      # TODO: Write general description for DEBIT
+      DEBIT = 'debit'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      NORMAL_BALANCE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = CREDIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'credit' then CREDIT
+      when 'debit' then DEBIT
+      else
+        default_value
+      end
+    end
+  end
+end