modern_treasury 0.0.0 → 0.1.0.pre.alpha.15

data/lib/modern_treasury/models/external_account_list_params.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class ExternalAccountListParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute after_cursor
+      #
+      #   @return [String, nil]
+      optional :after_cursor, String, nil?: true
+
+      # @!attribute [r] counterparty_id
+      #
+      #   @return [String, nil]
+      optional :counterparty_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :counterparty_id
+
+      # @!attribute [r] metadata
+      #   For example, if you want to query for records with metadata key `Type` and value
+      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+      #     parameters.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, ModernTreasury::HashOf[String]
+
+      # @!parse
+      #   # @return [Hash{Symbol=>String}]
+      #   attr_writer :metadata
+
+      # @!attribute [r] party_name
+      #   Searches the ExternalAccount's party_name AND the Counterparty's party_name
+      #
+      #   @return [String, nil]
+      optional :party_name, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :party_name
+
+      # @!attribute [r] per_page
+      #
+      #   @return [Integer, nil]
+      optional :per_page, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :per_page
+
+      # @!parse
+      #   # @param after_cursor [String, nil]
+      #   # @param counterparty_id [String]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param party_name [String]
+      #   # @param per_page [Integer]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     after_cursor: nil,
+      #     counterparty_id: nil,
+      #     metadata: nil,
+      #     party_name: nil,
+      #     per_page: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/external_account_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class ExternalAccountRetrieveParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!parse
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/external_account_type.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @abstract
+    #
+    # Can be `checking`, `savings` or `other`.
+    #
+    # @example
+    # ```ruby
+    # case external_account_type
+    # in :cash
+    #   # ...
+    # in :checking
+    #   # ...
+    # in :general_ledger
+    #   # ...
+    # in :loan
+    #   # ...
+    # in :non_resident
+    #   # ...
+    # in ...
+    #   #...
+    # end
+    # ```
+    class ExternalAccountType < ModernTreasury::Enum
+      CASH = :cash
+      CHECKING = :checking
+      GENERAL_LEDGER = :general_ledger
+      LOAN = :loan
+      NON_RESIDENT = :non_resident
+      OTHER = :other
+      OVERDRAFT = :overdraft
+      SAVINGS = :savings
+
+      finalize!
+
+      # @!parse
+      #   # @return [Array<Symbol>]
+      #   #
+      #   def self.values; end
+    end
+  end
+end

data/lib/modern_treasury/models/external_account_update_params.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class ExternalAccountUpdateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute [r] account_type
+      #   Can be `checking`, `savings` or `other`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::ExternalAccountType, nil]
+      optional :account_type, enum: -> { ModernTreasury::Models::ExternalAccountType }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::ExternalAccountType]
+      #   attr_writer :account_type
+
+      # @!attribute counterparty_id
+      #
+      #   @return [String, nil]
+      optional :counterparty_id, String, nil?: true
+
+      # @!attribute [r] metadata
+      #   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{Symbol=>String}, nil]
+      optional :metadata, ModernTreasury::HashOf[String]
+
+      # @!parse
+      #   # @return [Hash{Symbol=>String}]
+      #   attr_writer :metadata
+
+      # @!attribute name
+      #   A nickname for the external account. This is only for internal usage and won't
+      #     affect any payments
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute [r] party_address
+      #
+      #   @return [ModernTreasury::Models::ExternalAccountUpdateParams::PartyAddress, nil]
+      optional :party_address, -> { ModernTreasury::Models::ExternalAccountUpdateParams::PartyAddress }
+
+      # @!parse
+      #   # @return [ModernTreasury::Models::ExternalAccountUpdateParams::PartyAddress]
+      #   attr_writer :party_address
+
+      # @!attribute [r] party_name
+      #   If this value isn't provided, it will be inherited from the counterparty's name.
+      #
+      #   @return [String, nil]
+      optional :party_name, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :party_name
+
+      # @!attribute party_type
+      #   Either `individual` or `business`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::ExternalAccountUpdateParams::PartyType, nil]
+      optional :party_type,
+               enum: -> { ModernTreasury::Models::ExternalAccountUpdateParams::PartyType },
+               nil?: true
+
+      # @!parse
+      #   # @param account_type [Symbol, ModernTreasury::Models::ExternalAccountType]
+      #   # @param counterparty_id [String, nil]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param name [String, nil]
+      #   # @param party_address [ModernTreasury::Models::ExternalAccountUpdateParams::PartyAddress]
+      #   # @param party_name [String]
+      #   # @param party_type [Symbol, ModernTreasury::Models::ExternalAccountUpdateParams::PartyType, nil]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     account_type: nil,
+      #     counterparty_id: nil,
+      #     metadata: nil,
+      #     name: nil,
+      #     party_address: nil,
+      #     party_name: nil,
+      #     party_type: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      class PartyAddress < ModernTreasury::BaseModel
+        # @!attribute country
+        #   Country code conforms to [ISO 3166-1 alpha-2]
+        #
+        #   @return [String, nil]
+        optional :country, String, nil?: true
+
+        # @!attribute line1
+        #
+        #   @return [String, nil]
+        optional :line1, String, nil?: true
+
+        # @!attribute line2
+        #
+        #   @return [String, nil]
+        optional :line2, String, nil?: true
+
+        # @!attribute locality
+        #   Locality or City.
+        #
+        #   @return [String, nil]
+        optional :locality, String, nil?: true
+
+        # @!attribute postal_code
+        #   The postal code of the address.
+        #
+        #   @return [String, nil]
+        optional :postal_code, String, nil?: true
+
+        # @!attribute region
+        #   Region or State.
+        #
+        #   @return [String, nil]
+        optional :region, String, nil?: true
+
+        # @!parse
+        #   # @param country [String, nil]
+        #   # @param line1 [String, nil]
+        #   # @param line2 [String, nil]
+        #   # @param locality [String, nil]
+        #   # @param postal_code [String, nil]
+        #   # @param region [String, nil]
+        #   #
+        #   def initialize(country: nil, line1: nil, line2: nil, locality: nil, postal_code: nil, region: nil, **) = super
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      end
+
+      # @abstract
+      #
+      # Either `individual` or `business`.
+      #
+      # @example
+      # ```ruby
+      # case party_type
+      # in :business
+      #   # ...
+      # in :individual
+      #   # ...
+      # end
+      # ```
+      class PartyType < ModernTreasury::Enum
+        BUSINESS = :business
+        INDIVIDUAL = :individual
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/external_account_verify_params.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class ExternalAccountVerifyParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute originating_account_id
+      #   The ID of the internal account where the micro-deposits originate from. Both
+      #     credit and debit capabilities must be enabled.
+      #
+      #   @return [String]
+      required :originating_account_id, String
+
+      # @!attribute payment_type
+      #   Can be `ach`, `eft`, or `rtp`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::PaymentType]
+      required :payment_type, enum: -> { ModernTreasury::Models::ExternalAccountVerifyParams::PaymentType }
+
+      # @!attribute [r] currency
+      #   Defaults to the currency of the originating account.
+      #
+      #   @return [Symbol, ModernTreasury::Models::Currency, nil]
+      optional :currency, enum: -> { ModernTreasury::Models::Currency }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::Currency]
+      #   attr_writer :currency
+
+      # @!attribute [r] fallback_type
+      #   A payment type to fallback to if the original type is not valid for the
+      #     receiving account. Currently, this only supports falling back from RTP to ACH
+      #     (payment_type=rtp and fallback_type=ach)
+      #
+      #   @return [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::FallbackType, nil]
+      optional :fallback_type, enum: -> { ModernTreasury::Models::ExternalAccountVerifyParams::FallbackType }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::FallbackType]
+      #   attr_writer :fallback_type
+
+      # @!attribute [r] priority
+      #   Either `normal` or `high`. For ACH payments, `high` represents a same-day ACH
+      #     transfer. This will apply to both `payment_type` and `fallback_type`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::Priority, nil]
+      optional :priority, enum: -> { ModernTreasury::Models::ExternalAccountVerifyParams::Priority }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::Priority]
+      #   attr_writer :priority
+
+      # @!parse
+      #   # @param originating_account_id [String]
+      #   # @param payment_type [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::PaymentType]
+      #   # @param currency [Symbol, ModernTreasury::Models::Currency]
+      #   # @param fallback_type [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::FallbackType]
+      #   # @param priority [Symbol, ModernTreasury::Models::ExternalAccountVerifyParams::Priority]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     originating_account_id:,
+      #     payment_type:,
+      #     currency: nil,
+      #     fallback_type: nil,
+      #     priority: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # @abstract
+      #
+      # Can be `ach`, `eft`, or `rtp`.
+      #
+      # @example
+      # ```ruby
+      # case payment_type
+      # in :ach
+      #   # ...
+      # in :au_becs
+      #   # ...
+      # in :bacs
+      #   # ...
+      # in :book
+      #   # ...
+      # in :card
+      #   # ...
+      # in ...
+      #   #...
+      # end
+      # ```
+      class PaymentType < ModernTreasury::Enum
+        ACH = :ach
+        AU_BECS = :au_becs
+        BACS = :bacs
+        BOOK = :book
+        CARD = :card
+        CHATS = :chats
+        CHECK = :check
+        CROSS_BORDER = :cross_border
+        DK_NETS = :dk_nets
+        EFT = :eft
+        HU_ICS = :hu_ics
+        INTERAC = :interac
+        MASAV = :masav
+        MX_CCEN = :mx_ccen
+        NEFT = :neft
+        NICS = :nics
+        NZ_BECS = :nz_becs
+        PL_ELIXIR = :pl_elixir
+        PROVXCHANGE = :provxchange
+        RO_SENT = :ro_sent
+        RTP = :rtp
+        SE_BANKGIROT = :se_bankgirot
+        SEN = :sen
+        SEPA = :sepa
+        SG_GIRO = :sg_giro
+        SIC = :sic
+        SIGNET = :signet
+        SKNBI = :sknbi
+        WIRE = :wire
+        ZENGIN = :zengin
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+
+      # @abstract
+      #
+      # A payment type to fallback to if the original type is not valid for the
+      #   receiving account. Currently, this only supports falling back from RTP to ACH
+      #   (payment_type=rtp and fallback_type=ach)
+      #
+      # @example
+      # ```ruby
+      # case fallback_type
+      # in :ach
+      #   # ...
+      # end
+      # ```
+      class FallbackType < ModernTreasury::Enum
+        ACH = :ach
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+
+      # @abstract
+      #
+      # Either `normal` or `high`. For ACH payments, `high` represents a same-day ACH
+      #   transfer. This will apply to both `payment_type` and `fallback_type`.
+      #
+      # @example
+      # ```ruby
+      # case priority
+      # in :high
+      #   # ...
+      # in :normal
+      #   # ...
+      # end
+      # ```
+      class Priority < ModernTreasury::Enum
+        HIGH = :high
+        NORMAL = :normal
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end