modern_treasury 0.10.0 → 0.11.0

data/lib/modern_treasury/resources/journal_reports.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Resources
+    class JournalReports
+      # Retrieve a specific journal report
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The ID of the journal report
+      #
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see ModernTreasury::Models::JournalReportRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/journal_reports/%1$s", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # Update a journal report
+      #
+      # @overload update(id, metadata: nil, status: nil, request_options: {})
+      #
+      # @param id [String] The ID of the journal report
+      #
+      # @param metadata [Object]
+      #
+      # @param status [String]
+      #
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see ModernTreasury::Models::JournalReportUpdateParams
+      def update(id, params = {})
+        parsed, options = ModernTreasury::JournalReportUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["api/journal_reports/%1$s", id],
+          body: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Retrieve a list of journal reports
+      #
+      # @overload list(request_options: {})
+      #
+      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see ModernTreasury::Models::JournalReportListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "api/journal_reports",
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [ModernTreasury::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/modern_treasury/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ModernTreasury
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

data/lib/modern_treasury.rb

@@ -125,6 +125,14 @@ require_relative "modern_treasury/models/foreign_exchange_quote_create_params"
 require_relative "modern_treasury/models/foreign_exchange_quote_list_params"
 require_relative "modern_treasury/models/foreign_exchange_quote_retrieve_params"
 require_relative "modern_treasury/models/foreign_exchange_rate"
+require_relative "modern_treasury/models/hold_create_params"
+require_relative "modern_treasury/models/hold_create_response"
+require_relative "modern_treasury/models/hold_list_params"
+require_relative "modern_treasury/models/hold_list_response"
+require_relative "modern_treasury/models/hold_retrieve_params"
+require_relative "modern_treasury/models/hold_retrieve_response"
+require_relative "modern_treasury/models/hold_update_params"
+require_relative "modern_treasury/models/hold_update_response"
 require_relative "modern_treasury/models/identification_create_request"
 require_relative "modern_treasury/models/incoming_payment_detail"
 require_relative "modern_treasury/models/incoming_payment_detail_create_async_params"
@@ -134,6 +142,7 @@ require_relative "modern_treasury/models/incoming_payment_detail_update_params"
 require_relative "modern_treasury/models/internal_account"
 require_relative "modern_treasury/models/internal_account_create_params"
 require_relative "modern_treasury/models/internal_account_list_params"
+require_relative "modern_treasury/models/internal_account_request_closure_params"
 require_relative "modern_treasury/models/internal_account_retrieve_params"
 require_relative "modern_treasury/models/internal_accounts/balance_report"
 require_relative "modern_treasury/models/internal_accounts/balance_report_create_params"
@@ -155,6 +164,11 @@ require_relative "modern_treasury/models/invoices/line_item_list_params"
 require_relative "modern_treasury/models/invoices/line_item_retrieve_params"
 require_relative "modern_treasury/models/invoices/line_item_update_params"
 require_relative "modern_treasury/models/invoice_update_params"
+require_relative "modern_treasury/models/journal_entry_list_params"
+require_relative "modern_treasury/models/journal_entry_retrieve_params"
+require_relative "modern_treasury/models/journal_report_list_params"
+require_relative "modern_treasury/models/journal_report_retrieve_params"
+require_relative "modern_treasury/models/journal_report_update_params"
 require_relative "modern_treasury/models/ledger"
 require_relative "modern_treasury/models/ledger_account"
 require_relative "modern_treasury/models/ledger_account_balance_monitor"
@@ -300,11 +314,14 @@ require_relative "modern_treasury/resources/events"
 require_relative "modern_treasury/resources/expected_payments"
 require_relative "modern_treasury/resources/external_accounts"
 require_relative "modern_treasury/resources/foreign_exchange_quotes"
+require_relative "modern_treasury/resources/holds"
 require_relative "modern_treasury/resources/incoming_payment_details"
 require_relative "modern_treasury/resources/internal_accounts"
 require_relative "modern_treasury/resources/internal_accounts/balance_reports"
 require_relative "modern_treasury/resources/invoices"
 require_relative "modern_treasury/resources/invoices/line_items"
+require_relative "modern_treasury/resources/journal_entries"
+require_relative "modern_treasury/resources/journal_reports"
 require_relative "modern_treasury/resources/ledger_account_balance_monitors"
 require_relative "modern_treasury/resources/ledger_account_categories"
 require_relative "modern_treasury/resources/ledger_accounts"

data/rbi/modern_treasury/client.rbi

@@ -121,6 +121,15 @@ module ModernTreasury
     sig { returns(ModernTreasury::Resources::PaymentActions) }
     attr_reader :payment_actions
 
+    sig { returns(ModernTreasury::Resources::JournalEntries) }
+    attr_reader :journal_entries
+
+    sig { returns(ModernTreasury::Resources::JournalReports) }
+    attr_reader :journal_reports
+
+    sig { returns(ModernTreasury::Resources::Holds) }
+    attr_reader :holds
+
     # A test endpoint often used to confirm credentials and headers are being passed
     # in correctly.
     sig do

data/rbi/modern_treasury/models/hold_create_params.rbi

@@ -0,0 +1,125 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class HoldCreateParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::HoldCreateParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      # The status of the hold
+      sig { returns(ModernTreasury::HoldCreateParams::Status::OrSymbol) }
+      attr_accessor :status
+
+      # The ID of the target to hold
+      sig { returns(String) }
+      attr_accessor :target_id
+
+      # The type of target to hold
+      sig { returns(ModernTreasury::HoldCreateParams::TargetType::OrSymbol) }
+      attr_accessor :target_type
+
+      # Additional metadata for the hold
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :metadata
+
+      # The reason for the hold
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reason
+
+      sig do
+        params(
+          status: ModernTreasury::HoldCreateParams::Status::OrSymbol,
+          target_id: String,
+          target_type: ModernTreasury::HoldCreateParams::TargetType::OrSymbol,
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          reason: T.nilable(String),
+          request_options: ModernTreasury::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The status of the hold
+        status:,
+        # The ID of the target to hold
+        target_id:,
+        # The type of target to hold
+        target_type:,
+        # Additional metadata for the hold
+        metadata: nil,
+        # The reason for the hold
+        reason: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            status: ModernTreasury::HoldCreateParams::Status::OrSymbol,
+            target_id: String,
+            target_type: ModernTreasury::HoldCreateParams::TargetType::OrSymbol,
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            reason: T.nilable(String),
+            request_options: ModernTreasury::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The status of the hold
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModernTreasury::HoldCreateParams::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(:active, ModernTreasury::HoldCreateParams::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[ModernTreasury::HoldCreateParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The type of target to hold
+      module TargetType
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModernTreasury::HoldCreateParams::TargetType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PAYMENT_ORDER =
+          T.let(
+            :payment_order,
+            ModernTreasury::HoldCreateParams::TargetType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[ModernTreasury::HoldCreateParams::TargetType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/modern_treasury/models/hold_create_response.rbi

@@ -0,0 +1,232 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class HoldCreateResponse < ModernTreasury::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::Models::HoldCreateResponse,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The type of object
+      sig do
+        returns(
+          ModernTreasury::Models::HoldCreateResponse::Object::TaggedSymbol
+        )
+      end
+      attr_accessor :object
+
+      # The status of the hold
+      sig do
+        returns(
+          ModernTreasury::Models::HoldCreateResponse::Status::TaggedSymbol
+        )
+      end
+      attr_accessor :status
+
+      # The ID of the target being held
+      sig { returns(String) }
+      attr_accessor :target_id
+
+      # The type of target being held
+      sig do
+        returns(
+          ModernTreasury::Models::HoldCreateResponse::TargetType::TaggedSymbol
+        )
+      end
+      attr_accessor :target_type
+
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # This field will be true if this object exists in the live environment or false
+      # if it exists in the test environment.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :live_mode
+
+      sig { params(live_mode: T::Boolean).void }
+      attr_writer :live_mode
+
+      # Additional metadata for the hold
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :metadata
+
+      # The reason for the hold
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reason
+
+      # The resolution of the hold
+      sig { returns(T.nilable(String)) }
+      attr_accessor :resolution
+
+      # When the hold was resolved
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :resolved_at
+
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          object: ModernTreasury::Models::HoldCreateResponse::Object::OrSymbol,
+          status: ModernTreasury::Models::HoldCreateResponse::Status::OrSymbol,
+          target_id: String,
+          target_type:
+            ModernTreasury::Models::HoldCreateResponse::TargetType::OrSymbol,
+          updated_at: Time,
+          live_mode: T::Boolean,
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          reason: T.nilable(String),
+          resolution: T.nilable(String),
+          resolved_at: T.nilable(Time)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        created_at:,
+        # The type of object
+        object:,
+        # The status of the hold
+        status:,
+        # The ID of the target being held
+        target_id:,
+        # The type of target being held
+        target_type:,
+        updated_at:,
+        # This field will be true if this object exists in the live environment or false
+        # if it exists in the test environment.
+        live_mode: nil,
+        # Additional metadata for the hold
+        metadata: nil,
+        # The reason for the hold
+        reason: nil,
+        # The resolution of the hold
+        resolution: nil,
+        # When the hold was resolved
+        resolved_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            object:
+              ModernTreasury::Models::HoldCreateResponse::Object::TaggedSymbol,
+            status:
+              ModernTreasury::Models::HoldCreateResponse::Status::TaggedSymbol,
+            target_id: String,
+            target_type:
+              ModernTreasury::Models::HoldCreateResponse::TargetType::TaggedSymbol,
+            updated_at: Time,
+            live_mode: T::Boolean,
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            reason: T.nilable(String),
+            resolution: T.nilable(String),
+            resolved_at: T.nilable(Time)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The type of object
+      module Object
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModernTreasury::Models::HoldCreateResponse::Object)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        HOLD =
+          T.let(
+            :hold,
+            ModernTreasury::Models::HoldCreateResponse::Object::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::Models::HoldCreateResponse::Object::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The status of the hold
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModernTreasury::Models::HoldCreateResponse::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(
+            :active,
+            ModernTreasury::Models::HoldCreateResponse::Status::TaggedSymbol
+          )
+        RESOLVED =
+          T.let(
+            :resolved,
+            ModernTreasury::Models::HoldCreateResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::Models::HoldCreateResponse::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The type of target being held
+      module TargetType
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ModernTreasury::Models::HoldCreateResponse::TargetType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PAYMENT_ORDER =
+          T.let(
+            :payment_order,
+            ModernTreasury::Models::HoldCreateResponse::TargetType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::Models::HoldCreateResponse::TargetType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/modern_treasury/models/hold_list_params.rbi

@@ -0,0 +1,150 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class HoldListParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::HoldListParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :after_cursor
+
+      # 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.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :per_page
+
+      sig { params(per_page: Integer).void }
+      attr_writer :per_page
+
+      # Translation missing: en.openapi.descriptions.payment_order.query_params.status
+      sig do
+        returns(T.nilable(ModernTreasury::HoldListParams::Status::OrSymbol))
+      end
+      attr_accessor :status
+
+      # Translation missing:
+      # en.openapi.descriptions.payment_order.query_params.target_id
+      sig { returns(T.nilable(String)) }
+      attr_accessor :target_id
+
+      # Translation missing:
+      # en.openapi.descriptions.payment_order.query_params.target_type
+      sig do
+        returns(T.nilable(ModernTreasury::HoldListParams::TargetType::OrSymbol))
+      end
+      attr_accessor :target_type
+
+      sig do
+        params(
+          after_cursor: T.nilable(String),
+          metadata: T::Hash[Symbol, String],
+          per_page: Integer,
+          status: T.nilable(ModernTreasury::HoldListParams::Status::OrSymbol),
+          target_id: T.nilable(String),
+          target_type:
+            T.nilable(ModernTreasury::HoldListParams::TargetType::OrSymbol),
+          request_options: ModernTreasury::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        after_cursor: nil,
+        # 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.
+        metadata: nil,
+        per_page: nil,
+        # Translation missing: en.openapi.descriptions.payment_order.query_params.status
+        status: nil,
+        # Translation missing:
+        # en.openapi.descriptions.payment_order.query_params.target_id
+        target_id: nil,
+        # Translation missing:
+        # en.openapi.descriptions.payment_order.query_params.target_type
+        target_type: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            after_cursor: T.nilable(String),
+            metadata: T::Hash[Symbol, String],
+            per_page: Integer,
+            status: T.nilable(ModernTreasury::HoldListParams::Status::OrSymbol),
+            target_id: T.nilable(String),
+            target_type:
+              T.nilable(ModernTreasury::HoldListParams::TargetType::OrSymbol),
+            request_options: ModernTreasury::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Translation missing: en.openapi.descriptions.payment_order.query_params.status
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ModernTreasury::HoldListParams::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(:active, ModernTreasury::HoldListParams::Status::TaggedSymbol)
+        RESOLVED =
+          T.let(:resolved, ModernTreasury::HoldListParams::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[ModernTreasury::HoldListParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Translation missing:
+      # en.openapi.descriptions.payment_order.query_params.target_type
+      module TargetType
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModernTreasury::HoldListParams::TargetType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PAYMENT_ORDER =
+          T.let(
+            :payment_order,
+            ModernTreasury::HoldListParams::TargetType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[ModernTreasury::HoldListParams::TargetType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end