modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

data/lib/modern_treasury/models/incoming_payment_detail_list_params.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class IncomingPaymentDetailListParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute after_cursor
+      #
+      #   @return [String, nil]
+      optional :after_cursor, String, nil?: true
+
+      # @!attribute [r] as_of_date_end
+      #   Filters incoming payment details with an as_of_date starting on or before the
+      #     specified date (YYYY-MM-DD).
+      #
+      #   @return [Date, nil]
+      optional :as_of_date_end, Date
+
+      # @!parse
+      #   # @return [Date]
+      #   attr_writer :as_of_date_end
+
+      # @!attribute [r] as_of_date_start
+      #   Filters incoming payment details with an as_of_date starting on or after the
+      #     specified date (YYYY-MM-DD).
+      #
+      #   @return [Date, nil]
+      optional :as_of_date_start, Date
+
+      # @!parse
+      #   # @return [Date]
+      #   attr_writer :as_of_date_start
+
+      # @!attribute [r] direction
+      #   One of `credit` or `debit`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::TransactionDirection, nil]
+      optional :direction, enum: -> { ModernTreasury::Models::TransactionDirection }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::TransactionDirection]
+      #   attr_writer :direction
+
+      # @!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] per_page
+      #
+      #   @return [Integer, nil]
+      optional :per_page, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :per_page
+
+      # @!attribute [r] status
+      #   The current status of the incoming payment order. One of `pending`, `completed`,
+      #     or `returned`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Status, nil]
+      optional :status, enum: -> { ModernTreasury::Models::IncomingPaymentDetailListParams::Status }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Status]
+      #   attr_writer :status
+
+      # @!attribute [r] type
+      #   One of: `ach`, `book`, `check`, `eft`, `interac`, `rtp`, `sepa`, `signet`, or
+      #     `wire`.
+      #
+      #   @return [Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Type, nil]
+      optional :type, enum: -> { ModernTreasury::Models::IncomingPaymentDetailListParams::Type }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Type]
+      #   attr_writer :type
+
+      # @!attribute [r] virtual_account_id
+      #   If the incoming payment detail is in a virtual account, the ID of the Virtual
+      #     Account.
+      #
+      #   @return [String, nil]
+      optional :virtual_account_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :virtual_account_id
+
+      # @!parse
+      #   # @param after_cursor [String, nil]
+      #   # @param as_of_date_end [Date]
+      #   # @param as_of_date_start [Date]
+      #   # @param direction [Symbol, ModernTreasury::Models::TransactionDirection]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param per_page [Integer]
+      #   # @param status [Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Status]
+      #   # @param type [Symbol, ModernTreasury::Models::IncomingPaymentDetailListParams::Type]
+      #   # @param virtual_account_id [String]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     after_cursor: nil,
+      #     as_of_date_end: nil,
+      #     as_of_date_start: nil,
+      #     direction: nil,
+      #     metadata: nil,
+      #     per_page: nil,
+      #     status: nil,
+      #     type: nil,
+      #     virtual_account_id: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # The current status of the incoming payment order. One of `pending`, `completed`,
+      #   or `returned`.
+      module Status
+        extend ModernTreasury::Enum
+
+        COMPLETED = :completed
+        PENDING = :pending
+        RETURNED = :returned
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # One of: `ach`, `book`, `check`, `eft`, `interac`, `rtp`, `sepa`, `signet`, or
+      #   `wire`.
+      module Type
+        extend ModernTreasury::Enum
+
+        ACH = :ach
+        BOOK = :book
+        CHECK = :check
+        EFT = :eft
+        INTERAC = :interac
+        RTP = :rtp
+        SEPA = :sepa
+        SIGNET = :signet
+        WIRE = :wire
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/incoming_payment_detail_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class IncomingPaymentDetailRetrieveParams < 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/incoming_payment_detail_update_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class IncomingPaymentDetailUpdateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!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
+
+      # @!parse
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(metadata: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/internal_account.rb

@@ -0,0 +1,299 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class InternalAccount < ModernTreasury::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_details
+      #   An array of account detail objects.
+      #
+      #   @return [Array<ModernTreasury::Models::AccountDetail>]
+      required :account_details, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::AccountDetail] }
+
+      # @!attribute account_type
+      #   Can be checking, savings or other.
+      #
+      #   @return [Symbol, ModernTreasury::Models::InternalAccount::AccountType, nil]
+      required :account_type, enum: -> { ModernTreasury::Models::InternalAccount::AccountType }, nil?: true
+
+      # @!attribute connection
+      #   Specifies which financial institution the accounts belong to.
+      #
+      #   @return [ModernTreasury::Models::Connection]
+      required :connection, -> { ModernTreasury::Models::Connection }
+
+      # @!attribute counterparty_id
+      #   The Counterparty associated to this account.
+      #
+      #   @return [String, nil]
+      required :counterparty_id, String, nil?: true
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   The currency of the account.
+      #
+      #   @return [Symbol, ModernTreasury::Models::Currency]
+      required :currency, enum: -> { ModernTreasury::Models::Currency }
+
+      # @!attribute ledger_account_id
+      #   If the internal account links to a ledger account in Modern Treasury, the id of
+      #     the ledger account will be populated here.
+      #
+      #   @return [String, nil]
+      required :ledger_account_id, String, nil?: true
+
+      # @!attribute legal_entity_id
+      #   The Legal Entity associated to this account
+      #
+      #   @return [String, nil]
+      required :legal_entity_id, String, nil?: true
+
+      # @!attribute 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 [Boolean]
+      required :live_mode, ModernTreasury::BooleanModel
+
+      # @!attribute metadata
+      #   Additional data represented as key-value pairs. Both the key and value must be
+      #     strings.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, ModernTreasury::HashOf[String]
+
+      # @!attribute name
+      #   A nickname for the account.
+      #
+      #   @return [String, nil]
+      required :name, String, nil?: true
+
+      # @!attribute object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute parent_account_id
+      #   The parent InternalAccount of this account.
+      #
+      #   @return [String, nil]
+      required :parent_account_id, String, nil?: true
+
+      # @!attribute party_address
+      #   The address associated with the owner or null.
+      #
+      #   @return [ModernTreasury::Models::InternalAccount::PartyAddress, nil]
+      required :party_address, -> { ModernTreasury::Models::InternalAccount::PartyAddress }, nil?: true
+
+      # @!attribute party_name
+      #   The legal name of the entity which owns the account.
+      #
+      #   @return [String]
+      required :party_name, String
+
+      # @!attribute party_type
+      #   Either individual or business.
+      #
+      #   @return [Symbol, ModernTreasury::Models::InternalAccount::PartyType, nil]
+      required :party_type, enum: -> { ModernTreasury::Models::InternalAccount::PartyType }, nil?: true
+
+      # @!attribute routing_details
+      #   An array of routing detail objects.
+      #
+      #   @return [Array<ModernTreasury::Models::RoutingDetail>]
+      required :routing_details, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::RoutingDetail] }
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param account_details [Array<ModernTreasury::Models::AccountDetail>]
+      #   # @param account_type [Symbol, ModernTreasury::Models::InternalAccount::AccountType, nil]
+      #   # @param connection [ModernTreasury::Models::Connection]
+      #   # @param counterparty_id [String, nil]
+      #   # @param created_at [Time]
+      #   # @param currency [Symbol, ModernTreasury::Models::Currency]
+      #   # @param ledger_account_id [String, nil]
+      #   # @param legal_entity_id [String, nil]
+      #   # @param live_mode [Boolean]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param name [String, nil]
+      #   # @param object [String]
+      #   # @param parent_account_id [String, nil]
+      #   # @param party_address [ModernTreasury::Models::InternalAccount::PartyAddress, nil]
+      #   # @param party_name [String]
+      #   # @param party_type [Symbol, ModernTreasury::Models::InternalAccount::PartyType, nil]
+      #   # @param routing_details [Array<ModernTreasury::Models::RoutingDetail>]
+      #   # @param updated_at [Time]
+      #   #
+      #   def initialize(
+      #     id:,
+      #     account_details:,
+      #     account_type:,
+      #     connection:,
+      #     counterparty_id:,
+      #     created_at:,
+      #     currency:,
+      #     ledger_account_id:,
+      #     legal_entity_id:,
+      #     live_mode:,
+      #     metadata:,
+      #     name:,
+      #     object:,
+      #     parent_account_id:,
+      #     party_address:,
+      #     party_name:,
+      #     party_type:,
+      #     routing_details:,
+      #     updated_at:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # Can be checking, savings or other.
+      module AccountType
+        extend 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
+
+      class PartyAddress < ModernTreasury::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute country
+        #   Country code conforms to [ISO 3166-1 alpha-2]
+        #
+        #   @return [String, nil]
+        required :country, String, nil?: true
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute line1
+        #
+        #   @return [String, nil]
+        required :line1, String, nil?: true
+
+        # @!attribute line2
+        #
+        #   @return [String, nil]
+        required :line2, String, nil?: true
+
+        # @!attribute 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 [Boolean]
+        required :live_mode, ModernTreasury::BooleanModel
+
+        # @!attribute locality
+        #   Locality or City.
+        #
+        #   @return [String, nil]
+        required :locality, String, nil?: true
+
+        # @!attribute object
+        #
+        #   @return [String]
+        required :object, String
+
+        # @!attribute postal_code
+        #   The postal code of the address.
+        #
+        #   @return [String, nil]
+        required :postal_code, String, nil?: true
+
+        # @!attribute region
+        #   Region or State.
+        #
+        #   @return [String, nil]
+        required :region, String, nil?: true
+
+        # @!attribute updated_at
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!parse
+        #   # The address associated with the owner or null.
+        #   #
+        #   # @param id [String]
+        #   # @param country [String, nil]
+        #   # @param created_at [Time]
+        #   # @param line1 [String, nil]
+        #   # @param line2 [String, nil]
+        #   # @param live_mode [Boolean]
+        #   # @param locality [String, nil]
+        #   # @param object [String]
+        #   # @param postal_code [String, nil]
+        #   # @param region [String, nil]
+        #   # @param updated_at [Time]
+        #   #
+        #   def initialize(
+        #     id:,
+        #     country:,
+        #     created_at:,
+        #     line1:,
+        #     line2:,
+        #     live_mode:,
+        #     locality:,
+        #     object:,
+        #     postal_code:,
+        #     region:,
+        #     updated_at:,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      end
+
+      # Either individual or business.
+      module PartyType
+        extend ModernTreasury::Enum
+
+        BUSINESS = :business
+        INDIVIDUAL = :individual
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/internal_account_create_params.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class InternalAccountCreateParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute connection_id
+      #   The identifier of the financial institution the account belongs to.
+      #
+      #   @return [String]
+      required :connection_id, String
+
+      # @!attribute currency
+      #   Either "USD" or "CAD". Internal accounts created at Increase only supports
+      #     "USD".
+      #
+      #   @return [Symbol, ModernTreasury::Models::InternalAccountCreateParams::Currency]
+      required :currency, enum: -> { ModernTreasury::Models::InternalAccountCreateParams::Currency }
+
+      # @!attribute name
+      #   The nickname of the account.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute party_name
+      #   The legal name of the entity which owns the account.
+      #
+      #   @return [String]
+      required :party_name, String
+
+      # @!attribute [r] counterparty_id
+      #   The Counterparty associated to this account.
+      #
+      #   @return [String, nil]
+      optional :counterparty_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :counterparty_id
+
+      # @!attribute [r] legal_entity_id
+      #   The LegalEntity associated to this account.
+      #
+      #   @return [String, nil]
+      optional :legal_entity_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :legal_entity_id
+
+      # @!attribute [r] parent_account_id
+      #   The parent internal account of this new account.
+      #
+      #   @return [String, nil]
+      optional :parent_account_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :parent_account_id
+
+      # @!attribute [r] party_address
+      #   The address associated with the owner or null.
+      #
+      #   @return [ModernTreasury::Models::InternalAccountCreateParams::PartyAddress, nil]
+      optional :party_address, -> { ModernTreasury::Models::InternalAccountCreateParams::PartyAddress }
+
+      # @!parse
+      #   # @return [ModernTreasury::Models::InternalAccountCreateParams::PartyAddress]
+      #   attr_writer :party_address
+
+      # @!attribute [r] vendor_attributes
+      #   A hash of vendor specific attributes that will be used when creating the account
+      #     at the vendor specified by the given connection.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :vendor_attributes, ModernTreasury::HashOf[String]
+
+      # @!parse
+      #   # @return [Hash{Symbol=>String}]
+      #   attr_writer :vendor_attributes
+
+      # @!parse
+      #   # @param connection_id [String]
+      #   # @param currency [Symbol, ModernTreasury::Models::InternalAccountCreateParams::Currency]
+      #   # @param name [String]
+      #   # @param party_name [String]
+      #   # @param counterparty_id [String]
+      #   # @param legal_entity_id [String]
+      #   # @param parent_account_id [String]
+      #   # @param party_address [ModernTreasury::Models::InternalAccountCreateParams::PartyAddress]
+      #   # @param vendor_attributes [Hash{Symbol=>String}]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     connection_id:,
+      #     currency:,
+      #     name:,
+      #     party_name:,
+      #     counterparty_id: nil,
+      #     legal_entity_id: nil,
+      #     parent_account_id: nil,
+      #     party_address: nil,
+      #     vendor_attributes: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # Either "USD" or "CAD". Internal accounts created at Increase only supports
+      #   "USD".
+      module Currency
+        extend ModernTreasury::Enum
+
+        USD = :USD
+        CAD = :CAD
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      class PartyAddress < ModernTreasury::BaseModel
+        # @!attribute country
+        #   Country code conforms to [ISO 3166-1 alpha-2]
+        #
+        #   @return [String]
+        required :country, String
+
+        # @!attribute line1
+        #
+        #   @return [String]
+        required :line1, String
+
+        # @!attribute locality
+        #   Locality or City.
+        #
+        #   @return [String]
+        required :locality, String
+
+        # @!attribute postal_code
+        #   The postal code of the address.
+        #
+        #   @return [String]
+        required :postal_code, String
+
+        # @!attribute region
+        #   Region or State.
+        #
+        #   @return [String]
+        required :region, String
+
+        # @!attribute [r] line2
+        #
+        #   @return [String, nil]
+        optional :line2, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :line2
+
+        # @!parse
+        #   # The address associated with the owner or null.
+        #   #
+        #   # @param country [String]
+        #   # @param line1 [String]
+        #   # @param locality [String]
+        #   # @param postal_code [String]
+        #   # @param region [String]
+        #   # @param line2 [String]
+        #   #
+        #   def initialize(country:, line1:, locality:, postal_code:, region:, line2: nil, **) = super
+
+        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      end
+    end
+  end
+end