mt-sdk 0.0.1

data/lib/modern_treasury/models/return_create_request.rb

@@ -0,0 +1,119 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # ReturnCreateRequest Model.
+  class ReturnCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the object being returned or `null`.
+    # @return [UUID | String]
+    attr_accessor :returnable_id
+
+    # The return code. For ACH returns, this is the required ACH return code.
+    # @return [Code1Enum]
+    attr_accessor :code
+
+    # An optional description of the reason for the return. This is for internal
+    # usage and will not be transmitted to the bank.”
+    # @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 type of object being returned. Currently, this may only be
+    # incoming_payment_detail.
+    # @return [String]
+    attr_reader :returnable_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['returnable_id'] = 'returnable_id'
+      @_hash['code'] = 'code'
+      @_hash['reason'] = 'reason'
+      @_hash['date_of_death'] = 'date_of_death'
+      @_hash['additional_information'] = 'additional_information'
+      @_hash['returnable_type'] = 'returnable_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        reason
+        date_of_death
+        additional_information
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        returnable_id
+        code
+        reason
+        date_of_death
+        additional_information
+      ]
+    end
+
+    def initialize(returnable_id = nil, code = SKIP, reason = SKIP,
+                   date_of_death = SKIP, additional_information = SKIP)
+      @returnable_id = returnable_id
+      @code = code unless code == SKIP
+      @reason = reason unless reason == SKIP
+      @date_of_death = date_of_death unless date_of_death == SKIP
+      @additional_information = additional_information unless additional_information == SKIP
+      @returnable_type = 'incoming_payment_detail'
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      returnable_id = hash.key?('returnable_id') ? hash['returnable_id'] : nil
+      code = hash.key?('code') ? hash['code'] : SKIP
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      date_of_death = hash.key?('date_of_death') ? hash['date_of_death'] : SKIP
+      additional_information =
+        hash.key?('additional_information') ? hash['additional_information'] : SKIP
+
+      # Create object from extracted values.
+      ReturnCreateRequest.new(returnable_id,
+                              code,
+                              reason,
+                              date_of_death,
+                              additional_information)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} returnable_id: #{@returnable_id}, code: #{@code}, reason: #{@reason},"\
+      " date_of_death: #{@date_of_death}, additional_information: #{@additional_information},"\
+      " returnable_type: #{@returnable_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} returnable_id: #{@returnable_id.inspect}, code: #{@code.inspect}, reason:"\
+      " #{@reason.inspect}, date_of_death: #{@date_of_death.inspect}, additional_information:"\
+      " #{@additional_information.inspect}, returnable_type: #{@returnable_type.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/returnable_type1_enum.rb

@@ -0,0 +1,48 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # returnable_type1.
+  class ReturnableType1Enum
+    RETURNABLE_TYPE1_ENUM = [
+      # TODO: Write general description for INCOMING_PAYMENT_DETAIL
+      INCOMING_PAYMENT_DETAIL = 'incoming_payment_detail'.freeze,
+
+      # TODO: Write general description for PAPER_ITEM
+      PAPER_ITEM = 'paper_item'.freeze,
+
+      # TODO: Write general description for PAYMENT_ORDER
+      PAYMENT_ORDER = 'payment_order'.freeze,
+
+      # TODO: Write general description for ENUM_RETURN
+      ENUM_RETURN = 'return'.freeze,
+
+      # TODO: Write general description for REVERSAL
+      REVERSAL = 'reversal'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RETURNABLE_TYPE1_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = INCOMING_PAYMENT_DETAIL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'incoming_payment_detail' then INCOMING_PAYMENT_DETAIL
+      when 'paper_item' then PAPER_ITEM
+      when 'payment_order' then PAYMENT_ORDER
+      when 'enum_return' then ENUM_RETURN
+      when 'reversal' then REVERSAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/returnable_type_enum.rb

@@ -0,0 +1,48 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # The type of object being returned or `null`.
+  class ReturnableTypeEnum
+    RETURNABLE_TYPE_ENUM = [
+      # TODO: Write general description for INCOMING_PAYMENT_DETAIL
+      INCOMING_PAYMENT_DETAIL = 'incoming_payment_detail'.freeze,
+
+      # TODO: Write general description for PAPER_ITEM
+      PAPER_ITEM = 'paper_item'.freeze,
+
+      # TODO: Write general description for PAYMENT_ORDER
+      PAYMENT_ORDER = 'payment_order'.freeze,
+
+      # TODO: Write general description for ENUM_RETURN
+      ENUM_RETURN = 'return'.freeze,
+
+      # TODO: Write general description for REVERSAL
+      REVERSAL = 'reversal'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RETURNABLE_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = INCOMING_PAYMENT_DETAIL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'incoming_payment_detail' then INCOMING_PAYMENT_DETAIL
+      when 'paper_item' then PAPER_ITEM
+      when 'payment_order' then PAYMENT_ORDER
+      when 'enum_return' then ENUM_RETURN
+      when 'reversal' then REVERSAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/reversal.rb

@@ -0,0 +1,151 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ModernTreasury
+  # Reversal Model.
+  class Reversal < 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 current status of the reversal.
+    # @return [Status19Enum]
+    attr_accessor :status
+
+    # The ID of the relevant Payment Order.
+    # @return [UUID | String]
+    attr_accessor :payment_order_id
+
+    # Additional data represented as key-value pairs. Both the key and value
+    # must be strings.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # The reason for the reversal.
+    # @return [ReasonEnum]
+    attr_accessor :reason
+
+    # 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['status'] = 'status'
+      @_hash['payment_order_id'] = 'payment_order_id'
+      @_hash['metadata'] = 'metadata'
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        payment_order_id
+      ]
+    end
+
+    def initialize(id = nil, object = nil, live_mode = nil, created_at = nil,
+                   updated_at = nil, status = nil, payment_order_id = nil,
+                   metadata = nil, reason = nil)
+      @id = id
+      @object = object
+      @live_mode = live_mode
+      @created_at = created_at
+      @updated_at = updated_at
+      @status = status
+      @payment_order_id = payment_order_id
+      @metadata = metadata
+      @reason = reason
+    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
+      status = hash.key?('status') ? hash['status'] : nil
+      payment_order_id =
+        hash.key?('payment_order_id') ? hash['payment_order_id'] : nil
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+      reason = hash.key?('reason') ? hash['reason'] : nil
+
+      # Create object from extracted values.
+      Reversal.new(id,
+                   object,
+                   live_mode,
+                   created_at,
+                   updated_at,
+                   status,
+                   payment_order_id,
+                   metadata,
+                   reason)
+    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}, status: #{@status}, payment_order_id:"\
+      " #{@payment_order_id}, metadata: #{@metadata}, reason: #{@reason}>"
+    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}, status: #{@status.inspect}, payment_order_id:"\
+      " #{@payment_order_id.inspect}, metadata: #{@metadata.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/reversal_create_request.rb

@@ -0,0 +1,86 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # ReversalCreateRequest Model.
+  class ReversalCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason for the reversal. Must be one of `duplicate`,
+    # `incorrect_amount`, `incorrect_receiving_account`,
+    # `date_earlier_than_intended`, `date_later_than_intended`.
+    # @return [Reason1Enum]
+    attr_accessor :reason
+
+    # Additional data represented as key-value pairs. Both the key and value
+    # must be strings.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # Additional data represented as key-value pairs. Both the key and value
+    # must be strings.
+    # @return [LedgerTransactionCreateRequest]
+    attr_accessor :ledger_transaction
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason'] = 'reason'
+      @_hash['metadata'] = 'metadata'
+      @_hash['ledger_transaction'] = 'ledger_transaction'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+        ledger_transaction
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reason = nil, metadata = SKIP, ledger_transaction = SKIP)
+      @reason = reason
+      @metadata = metadata unless metadata == SKIP
+      @ledger_transaction = ledger_transaction unless ledger_transaction == 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.
+      reason = hash.key?('reason') ? hash['reason'] : nil
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      ledger_transaction = LedgerTransactionCreateRequest.from_hash(hash['ledger_transaction']) if
+        hash['ledger_transaction']
+
+      # Create object from extracted values.
+      ReversalCreateRequest.new(reason,
+                                metadata,
+                                ledger_transaction)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reason: #{@reason}, metadata: #{@metadata}, ledger_transaction:"\
+      " #{@ledger_transaction}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reason: #{@reason.inspect}, metadata: #{@metadata.inspect},"\
+      " ledger_transaction: #{@ledger_transaction.inspect}>"
+    end
+  end
+end

data/lib/modern_treasury/models/role_enum.rb

@@ -0,0 +1,36 @@
+# modern_treasury
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ModernTreasury
+  # The role of the return, can be `originating` or `receiving`.
+  class RoleEnum
+    ROLE_ENUM = [
+      # TODO: Write general description for ORIGINATING
+      ORIGINATING = 'originating'.freeze,
+
+      # TODO: Write general description for RECEIVING
+      RECEIVING = 'receiving'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ROLE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ORIGINATING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'originating' then ORIGINATING
+      when 'receiving' then RECEIVING
+      else
+        default_value
+      end
+    end
+  end
+end