modern_treasury 0.1.0.pre.alpha.22 → 0.1.0

data/lib/modern_treasury/models/paper_item.rb

@@ -1,178 +0,0 @@
-# frozen_string_literal: true
-
-module ModernTreasury
-  module Models
-    # @see ModernTreasury::Resources::PaperItems#retrieve
-    class PaperItem < ModernTreasury::Internal::Type::BaseModel
-      # @!attribute id
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!attribute account_number
-      #   The account number on the paper item.
-      #
-      #   @return [String, nil]
-      required :account_number, String, nil?: true
-
-      # @!attribute account_number_safe
-      #   The last 4 digits of the account_number.
-      #
-      #   @return [String, nil]
-      required :account_number_safe, String, nil?: true
-
-      # @!attribute amount
-      #   The amount of the paper item.
-      #
-      #   @return [Integer]
-      required :amount, Integer
-
-      # @!attribute check_number
-      #   The check number on the paper item.
-      #
-      #   @return [String, nil]
-      required :check_number, String, nil?: true
-
-      # @!attribute created_at
-      #
-      #   @return [Time]
-      required :created_at, Time
-
-      # @!attribute currency
-      #   The currency of the paper item.
-      #
-      #   @return [Symbol, ModernTreasury::Models::Currency]
-      required :currency, enum: -> { ModernTreasury::Currency }
-
-      # @!attribute deposit_date
-      #   The date the paper item was deposited into your organization's bank account.
-      #
-      #   @return [Date]
-      required :deposit_date, Date
-
-      # @!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::Internal::Type::Boolean
-
-      # @!attribute lockbox_number
-      #   The identifier for the lockbox assigned by the bank.
-      #
-      #   @return [String]
-      required :lockbox_number, String
-
-      # @!attribute memo_field
-      #   The memo field on the paper item.
-      #
-      #   @return [String, nil]
-      required :memo_field, String, nil?: true
-
-      # @!attribute metadata
-      #   Additional data represented as key-value pairs. Both the key and value must be
-      #   strings.
-      #
-      #   @return [Object]
-      required :metadata, ModernTreasury::Internal::Type::Unknown
-
-      # @!attribute object
-      #
-      #   @return [String]
-      required :object, String
-
-      # @!attribute remitter_name
-      #   The name of the remitter on the paper item.
-      #
-      #   @return [String, nil]
-      required :remitter_name, String, nil?: true
-
-      # @!attribute routing_number
-      #   The routing number on the paper item.
-      #
-      #   @return [String, nil]
-      required :routing_number, String, nil?: true
-
-      # @!attribute status
-      #   The current status of the paper item. One of `pending`, `completed`, or
-      #   `returned`.
-      #
-      #   @return [Symbol, ModernTreasury::Models::PaperItem::Status]
-      required :status, enum: -> { ModernTreasury::PaperItem::Status }
-
-      # @!attribute transaction_id
-      #   The ID of the reconciled Transaction or `null`.
-      #
-      #   @return [String, nil]
-      required :transaction_id, String, nil?: true
-
-      # @!attribute transaction_line_item_id
-      #   The ID of the reconciled Transaction Line Item or `null`.
-      #
-      #   @return [String, nil]
-      required :transaction_line_item_id, String, nil?: true
-
-      # @!attribute updated_at
-      #
-      #   @return [Time]
-      required :updated_at, Time
-
-      # @!method initialize(id:, account_number:, account_number_safe:, amount:, check_number:, created_at:, currency:, deposit_date:, live_mode:, lockbox_number:, memo_field:, metadata:, object:, remitter_name:, routing_number:, status:, transaction_id:, transaction_line_item_id:, updated_at:)
-      #   Some parameter documentations has been truncated, see
-      #   {ModernTreasury::Models::PaperItem} for more details.
-      #
-      #   @param id [String]
-      #
-      #   @param account_number [String, nil] The account number on the paper item.
-      #
-      #   @param account_number_safe [String, nil] The last 4 digits of the account_number.
-      #
-      #   @param amount [Integer] The amount of the paper item.
-      #
-      #   @param check_number [String, nil] The check number on the paper item.
-      #
-      #   @param created_at [Time]
-      #
-      #   @param currency [Symbol, ModernTreasury::Models::Currency] The currency of the paper item.
-      #
-      #   @param deposit_date [Date] The date the paper item was deposited into your organization's bank account.
-      #
-      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
-      #
-      #   @param lockbox_number [String] The identifier for the lockbox assigned by the bank.
-      #
-      #   @param memo_field [String, nil] The memo field on the paper item.
-      #
-      #   @param metadata [Object] Additional data represented as key-value pairs. Both the key and value must be s
-      #
-      #   @param object [String]
-      #
-      #   @param remitter_name [String, nil] The name of the remitter on the paper item.
-      #
-      #   @param routing_number [String, nil] The routing number on the paper item.
-      #
-      #   @param status [Symbol, ModernTreasury::Models::PaperItem::Status] The current status of the paper item. One of `pending`, `completed`, or `returne
-      #
-      #   @param transaction_id [String, nil] The ID of the reconciled Transaction or `null`.
-      #
-      #   @param transaction_line_item_id [String, nil] The ID of the reconciled Transaction Line Item or `null`.
-      #
-      #   @param updated_at [Time]
-
-      # The current status of the paper item. One of `pending`, `completed`, or
-      # `returned`.
-      #
-      # @see ModernTreasury::Models::PaperItem#status
-      module Status
-        extend ModernTreasury::Internal::Type::Enum
-
-        COMPLETED = :completed
-        PENDING = :pending
-        RETURNED = :returned
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/modern_treasury/models/paper_item_list_params.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module ModernTreasury
-  module Models
-    # @see ModernTreasury::Resources::PaperItems#list
-    class PaperItemListParams < ModernTreasury::Internal::Type::BaseModel
-      extend ModernTreasury::Internal::Type::RequestParameters::Converter
-      include ModernTreasury::Internal::Type::RequestParameters
-
-      # @!attribute after_cursor
-      #
-      #   @return [String, nil]
-      optional :after_cursor, String, nil?: true
-
-      # @!attribute deposit_date_end
-      #   Specify an inclusive end date (YYYY-MM-DD) when filtering by deposit_date
-      #
-      #   @return [Date, nil]
-      optional :deposit_date_end, Date
-
-      # @!attribute deposit_date_start
-      #   Specify an inclusive start date (YYYY-MM-DD) when filtering by deposit_date
-      #
-      #   @return [Date, nil]
-      optional :deposit_date_start, Date
-
-      # @!attribute lockbox_number
-      #   Specify `lockbox_number` if you wish to see paper items that are associated with
-      #   a specific lockbox number.
-      #
-      #   @return [String, nil]
-      optional :lockbox_number, String
-
-      # @!attribute per_page
-      #
-      #   @return [Integer, nil]
-      optional :per_page, Integer
-
-      # @!method initialize(after_cursor: nil, deposit_date_end: nil, deposit_date_start: nil, lockbox_number: nil, per_page: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {ModernTreasury::Models::PaperItemListParams} for more details.
-      #
-      #   @param after_cursor [String, nil]
-      #
-      #   @param deposit_date_end [Date] Specify an inclusive end date (YYYY-MM-DD) when filtering by deposit_date
-      #
-      #   @param deposit_date_start [Date] Specify an inclusive start date (YYYY-MM-DD) when filtering by deposit_date
-      #
-      #   @param lockbox_number [String] Specify `lockbox_number` if you wish to see paper items that are associated with
-      #
-      #   @param per_page [Integer]
-      #
-      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/modern_treasury/models/paper_item_retrieve_params.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module ModernTreasury
-  module Models
-    # @see ModernTreasury::Resources::PaperItems#retrieve
-    class PaperItemRetrieveParams < ModernTreasury::Internal::Type::BaseModel
-      extend ModernTreasury::Internal::Type::RequestParameters::Converter
-      include ModernTreasury::Internal::Type::RequestParameters
-
-      # @!method initialize(request_options: {})
-      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/modern_treasury/resources/ledger_event_handlers.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module ModernTreasury
-  module Resources
-    class LedgerEventHandlers
-      # @api private
-      #
-      # @param client [ModernTreasury::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/lib/modern_treasury/resources/ledgerable_events.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module ModernTreasury
-  module Resources
-    class LedgerableEvents
-      # @api private
-      #
-      # @param client [ModernTreasury::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/lib/modern_treasury/resources/paper_items.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-module ModernTreasury
-  module Resources
-    class PaperItems
-      # Get details on a single paper item.
-      #
-      # @overload retrieve(id, request_options: {})
-      #
-      # @param id [String] id
-      #
-      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ModernTreasury::Models::PaperItem]
-      #
-      # @see ModernTreasury::Models::PaperItemRetrieveParams
-      def retrieve(id, params = {})
-        @client.request(
-          method: :get,
-          path: ["api/paper_items/%1$s", id],
-          model: ModernTreasury::PaperItem,
-          options: params[:request_options]
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {ModernTreasury::Models::PaperItemListParams} for more details.
-      #
-      # Get a list of all paper items.
-      #
-      # @overload list(after_cursor: nil, deposit_date_end: nil, deposit_date_start: nil, lockbox_number: nil, per_page: nil, request_options: {})
-      #
-      # @param after_cursor [String, nil]
-      #
-      # @param deposit_date_end [Date] Specify an inclusive end date (YYYY-MM-DD) when filtering by deposit_date
-      #
-      # @param deposit_date_start [Date] Specify an inclusive start date (YYYY-MM-DD) when filtering by deposit_date
-      #
-      # @param lockbox_number [String] Specify `lockbox_number` if you wish to see paper items that are associated with
-      #
-      # @param per_page [Integer]
-      #
-      # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [ModernTreasury::Internal::Page<ModernTreasury::Models::PaperItem>]
-      #
-      # @see ModernTreasury::Models::PaperItemListParams
-      def list(params = {})
-        parsed, options = ModernTreasury::PaperItemListParams.dump_request(params)
-        @client.request(
-          method: :get,
-          path: "api/paper_items",
-          query: parsed,
-          page: ModernTreasury::Internal::Page,
-          model: ModernTreasury::PaperItem,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [ModernTreasury::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/rbi/modern_treasury/models/paper_item.rbi

@@ -1,204 +0,0 @@
-# typed: strong
-
-module ModernTreasury
-  module Models
-    class PaperItem < ModernTreasury::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(ModernTreasury::PaperItem, ModernTreasury::Internal::AnyHash)
-        end
-
-      sig { returns(String) }
-      attr_accessor :id
-
-      # The account number on the paper item.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :account_number
-
-      # The last 4 digits of the account_number.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :account_number_safe
-
-      # The amount of the paper item.
-      sig { returns(Integer) }
-      attr_accessor :amount
-
-      # The check number on the paper item.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :check_number
-
-      sig { returns(Time) }
-      attr_accessor :created_at
-
-      # The currency of the paper item.
-      sig { returns(ModernTreasury::Currency::TaggedSymbol) }
-      attr_accessor :currency
-
-      # The date the paper item was deposited into your organization's bank account.
-      sig { returns(Date) }
-      attr_accessor :deposit_date
-
-      # 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::Boolean) }
-      attr_accessor :live_mode
-
-      # The identifier for the lockbox assigned by the bank.
-      sig { returns(String) }
-      attr_accessor :lockbox_number
-
-      # The memo field on the paper item.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :memo_field
-
-      # Additional data represented as key-value pairs. Both the key and value must be
-      # strings.
-      sig { returns(T.anything) }
-      attr_accessor :metadata
-
-      sig { returns(String) }
-      attr_accessor :object
-
-      # The name of the remitter on the paper item.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :remitter_name
-
-      # The routing number on the paper item.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :routing_number
-
-      # The current status of the paper item. One of `pending`, `completed`, or
-      # `returned`.
-      sig { returns(ModernTreasury::PaperItem::Status::TaggedSymbol) }
-      attr_accessor :status
-
-      # The ID of the reconciled Transaction or `null`.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :transaction_id
-
-      # The ID of the reconciled Transaction Line Item or `null`.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :transaction_line_item_id
-
-      sig { returns(Time) }
-      attr_accessor :updated_at
-
-      sig do
-        params(
-          id: String,
-          account_number: T.nilable(String),
-          account_number_safe: T.nilable(String),
-          amount: Integer,
-          check_number: T.nilable(String),
-          created_at: Time,
-          currency: ModernTreasury::Currency::OrSymbol,
-          deposit_date: Date,
-          live_mode: T::Boolean,
-          lockbox_number: String,
-          memo_field: T.nilable(String),
-          metadata: T.anything,
-          object: String,
-          remitter_name: T.nilable(String),
-          routing_number: T.nilable(String),
-          status: ModernTreasury::PaperItem::Status::OrSymbol,
-          transaction_id: T.nilable(String),
-          transaction_line_item_id: T.nilable(String),
-          updated_at: Time
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        id:,
-        # The account number on the paper item.
-        account_number:,
-        # The last 4 digits of the account_number.
-        account_number_safe:,
-        # The amount of the paper item.
-        amount:,
-        # The check number on the paper item.
-        check_number:,
-        created_at:,
-        # The currency of the paper item.
-        currency:,
-        # The date the paper item was deposited into your organization's bank account.
-        deposit_date:,
-        # This field will be true if this object exists in the live environment or false
-        # if it exists in the test environment.
-        live_mode:,
-        # The identifier for the lockbox assigned by the bank.
-        lockbox_number:,
-        # The memo field on the paper item.
-        memo_field:,
-        # Additional data represented as key-value pairs. Both the key and value must be
-        # strings.
-        metadata:,
-        object:,
-        # The name of the remitter on the paper item.
-        remitter_name:,
-        # The routing number on the paper item.
-        routing_number:,
-        # The current status of the paper item. One of `pending`, `completed`, or
-        # `returned`.
-        status:,
-        # The ID of the reconciled Transaction or `null`.
-        transaction_id:,
-        # The ID of the reconciled Transaction Line Item or `null`.
-        transaction_line_item_id:,
-        updated_at:
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            id: String,
-            account_number: T.nilable(String),
-            account_number_safe: T.nilable(String),
-            amount: Integer,
-            check_number: T.nilable(String),
-            created_at: Time,
-            currency: ModernTreasury::Currency::TaggedSymbol,
-            deposit_date: Date,
-            live_mode: T::Boolean,
-            lockbox_number: String,
-            memo_field: T.nilable(String),
-            metadata: T.anything,
-            object: String,
-            remitter_name: T.nilable(String),
-            routing_number: T.nilable(String),
-            status: ModernTreasury::PaperItem::Status::TaggedSymbol,
-            transaction_id: T.nilable(String),
-            transaction_line_item_id: T.nilable(String),
-            updated_at: Time
-          }
-        )
-      end
-      def to_hash
-      end
-
-      # The current status of the paper item. One of `pending`, `completed`, or
-      # `returned`.
-      module Status
-        extend ModernTreasury::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, ModernTreasury::PaperItem::Status) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        COMPLETED =
-          T.let(:completed, ModernTreasury::PaperItem::Status::TaggedSymbol)
-        PENDING =
-          T.let(:pending, ModernTreasury::PaperItem::Status::TaggedSymbol)
-        RETURNED =
-          T.let(:returned, ModernTreasury::PaperItem::Status::TaggedSymbol)
-
-        sig do
-          override.returns(
-            T::Array[ModernTreasury::PaperItem::Status::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-    end
-  end
-end

data/rbi/modern_treasury/models/paper_item_list_params.rbi

@@ -1,88 +0,0 @@
-# typed: strong
-
-module ModernTreasury
-  module Models
-    class PaperItemListParams < ModernTreasury::Internal::Type::BaseModel
-      extend ModernTreasury::Internal::Type::RequestParameters::Converter
-      include ModernTreasury::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(
-            ModernTreasury::PaperItemListParams,
-            ModernTreasury::Internal::AnyHash
-          )
-        end
-
-      sig { returns(T.nilable(String)) }
-      attr_accessor :after_cursor
-
-      # Specify an inclusive end date (YYYY-MM-DD) when filtering by deposit_date
-      sig { returns(T.nilable(Date)) }
-      attr_reader :deposit_date_end
-
-      sig { params(deposit_date_end: Date).void }
-      attr_writer :deposit_date_end
-
-      # Specify an inclusive start date (YYYY-MM-DD) when filtering by deposit_date
-      sig { returns(T.nilable(Date)) }
-      attr_reader :deposit_date_start
-
-      sig { params(deposit_date_start: Date).void }
-      attr_writer :deposit_date_start
-
-      # Specify `lockbox_number` if you wish to see paper items that are associated with
-      # a specific lockbox number.
-      sig { returns(T.nilable(String)) }
-      attr_reader :lockbox_number
-
-      sig { params(lockbox_number: String).void }
-      attr_writer :lockbox_number
-
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :per_page
-
-      sig { params(per_page: Integer).void }
-      attr_writer :per_page
-
-      sig do
-        params(
-          after_cursor: T.nilable(String),
-          deposit_date_end: Date,
-          deposit_date_start: Date,
-          lockbox_number: String,
-          per_page: Integer,
-          request_options: ModernTreasury::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        after_cursor: nil,
-        # Specify an inclusive end date (YYYY-MM-DD) when filtering by deposit_date
-        deposit_date_end: nil,
-        # Specify an inclusive start date (YYYY-MM-DD) when filtering by deposit_date
-        deposit_date_start: nil,
-        # Specify `lockbox_number` if you wish to see paper items that are associated with
-        # a specific lockbox number.
-        lockbox_number: nil,
-        per_page: nil,
-        request_options: {}
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            after_cursor: T.nilable(String),
-            deposit_date_end: Date,
-            deposit_date_start: Date,
-            lockbox_number: String,
-            per_page: Integer,
-            request_options: ModernTreasury::RequestOptions
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/modern_treasury/models/paper_item_retrieve_params.rbi

@@ -1,32 +0,0 @@
-# typed: strong
-
-module ModernTreasury
-  module Models
-    class PaperItemRetrieveParams < ModernTreasury::Internal::Type::BaseModel
-      extend ModernTreasury::Internal::Type::RequestParameters::Converter
-      include ModernTreasury::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(
-            ModernTreasury::PaperItemRetrieveParams,
-            ModernTreasury::Internal::AnyHash
-          )
-        end
-
-      sig do
-        params(request_options: ModernTreasury::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
-      end
-      def self.new(request_options: {})
-      end
-
-      sig do
-        override.returns({ request_options: ModernTreasury::RequestOptions })
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/modern_treasury/resources/ledger_event_handlers.rbi

@@ -1,12 +0,0 @@
-# typed: strong
-
-module ModernTreasury
-  module Resources
-    class LedgerEventHandlers
-      # @api private
-      sig { params(client: ModernTreasury::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/modern_treasury/resources/ledgerable_events.rbi

@@ -1,12 +0,0 @@
-# typed: strong
-
-module ModernTreasury
-  module Resources
-    class LedgerableEvents
-      # @api private
-      sig { params(client: ModernTreasury::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end