modern_treasury 0.9.0 → 0.11.0

data/lib/modern_treasury/models/hold_list_response.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::Holds#list
+    class HoldListResponse < ModernTreasury::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute object
+      #   The type of object
+      #
+      #   @return [Symbol, ModernTreasury::Models::HoldListResponse::Object]
+      required :object, enum: -> { ModernTreasury::Models::HoldListResponse::Object }
+
+      # @!attribute status
+      #   The status of the hold
+      #
+      #   @return [Symbol, ModernTreasury::Models::HoldListResponse::Status]
+      required :status, enum: -> { ModernTreasury::Models::HoldListResponse::Status }
+
+      # @!attribute target_id
+      #   The ID of the target being held
+      #
+      #   @return [String]
+      required :target_id, String
+
+      # @!attribute target_type
+      #   The type of target being held
+      #
+      #   @return [Symbol, ModernTreasury::Models::HoldListResponse::TargetType]
+      required :target_type, enum: -> { ModernTreasury::Models::HoldListResponse::TargetType }
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!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, nil]
+      optional :live_mode, ModernTreasury::Internal::Type::Boolean
+
+      # @!attribute metadata
+      #   Additional metadata for the hold
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String], nil?: true
+
+      # @!attribute reason
+      #   The reason for the hold
+      #
+      #   @return [String, nil]
+      optional :reason, String, nil?: true
+
+      # @!attribute resolution
+      #   The resolution of the hold
+      #
+      #   @return [String, nil]
+      optional :resolution, String, nil?: true
+
+      # @!attribute resolved_at
+      #   When the hold was resolved
+      #
+      #   @return [Time, nil]
+      optional :resolved_at, Time, nil?: true
+
+      # @!method initialize(id:, created_at:, object:, status:, target_id:, target_type:, updated_at:, live_mode: nil, metadata: nil, reason: nil, resolution: nil, resolved_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::HoldListResponse} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param object [Symbol, ModernTreasury::Models::HoldListResponse::Object] The type of object
+      #
+      #   @param status [Symbol, ModernTreasury::Models::HoldListResponse::Status] The status of the hold
+      #
+      #   @param target_id [String] The ID of the target being held
+      #
+      #   @param target_type [Symbol, ModernTreasury::Models::HoldListResponse::TargetType] The type of target being held
+      #
+      #   @param updated_at [Time]
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Additional metadata for the hold
+      #
+      #   @param reason [String, nil] The reason for the hold
+      #
+      #   @param resolution [String, nil] The resolution of the hold
+      #
+      #   @param resolved_at [Time, nil] When the hold was resolved
+
+      # The type of object
+      #
+      # @see ModernTreasury::Models::HoldListResponse#object
+      module Object
+        extend ModernTreasury::Internal::Type::Enum
+
+        HOLD = :hold
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The status of the hold
+      #
+      # @see ModernTreasury::Models::HoldListResponse#status
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
+        ACTIVE = :active
+        RESOLVED = :resolved
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The type of target being held
+      #
+      # @see ModernTreasury::Models::HoldListResponse#target_type
+      module TargetType
+        extend ModernTreasury::Internal::Type::Enum
+
+        PAYMENT_ORDER = :payment_order
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/hold_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::Holds#retrieve
+    class HoldRetrieveParams < 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/models/hold_retrieve_response.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::Holds#retrieve
+    class HoldRetrieveResponse < ModernTreasury::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute object
+      #   The type of object
+      #
+      #   @return [Symbol, ModernTreasury::Models::HoldRetrieveResponse::Object]
+      required :object, enum: -> { ModernTreasury::Models::HoldRetrieveResponse::Object }
+
+      # @!attribute status
+      #   The status of the hold
+      #
+      #   @return [Symbol, ModernTreasury::Models::HoldRetrieveResponse::Status]
+      required :status, enum: -> { ModernTreasury::Models::HoldRetrieveResponse::Status }
+
+      # @!attribute target_id
+      #   The ID of the target being held
+      #
+      #   @return [String]
+      required :target_id, String
+
+      # @!attribute target_type
+      #   The type of target being held
+      #
+      #   @return [Symbol, ModernTreasury::Models::HoldRetrieveResponse::TargetType]
+      required :target_type, enum: -> { ModernTreasury::Models::HoldRetrieveResponse::TargetType }
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!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, nil]
+      optional :live_mode, ModernTreasury::Internal::Type::Boolean
+
+      # @!attribute metadata
+      #   Additional metadata for the hold
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String], nil?: true
+
+      # @!attribute reason
+      #   The reason for the hold
+      #
+      #   @return [String, nil]
+      optional :reason, String, nil?: true
+
+      # @!attribute resolution
+      #   The resolution of the hold
+      #
+      #   @return [String, nil]
+      optional :resolution, String, nil?: true
+
+      # @!attribute resolved_at
+      #   When the hold was resolved
+      #
+      #   @return [Time, nil]
+      optional :resolved_at, Time, nil?: true
+
+      # @!method initialize(id:, created_at:, object:, status:, target_id:, target_type:, updated_at:, live_mode: nil, metadata: nil, reason: nil, resolution: nil, resolved_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::HoldRetrieveResponse} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param object [Symbol, ModernTreasury::Models::HoldRetrieveResponse::Object] The type of object
+      #
+      #   @param status [Symbol, ModernTreasury::Models::HoldRetrieveResponse::Status] The status of the hold
+      #
+      #   @param target_id [String] The ID of the target being held
+      #
+      #   @param target_type [Symbol, ModernTreasury::Models::HoldRetrieveResponse::TargetType] The type of target being held
+      #
+      #   @param updated_at [Time]
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Additional metadata for the hold
+      #
+      #   @param reason [String, nil] The reason for the hold
+      #
+      #   @param resolution [String, nil] The resolution of the hold
+      #
+      #   @param resolved_at [Time, nil] When the hold was resolved
+
+      # The type of object
+      #
+      # @see ModernTreasury::Models::HoldRetrieveResponse#object
+      module Object
+        extend ModernTreasury::Internal::Type::Enum
+
+        HOLD = :hold
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The status of the hold
+      #
+      # @see ModernTreasury::Models::HoldRetrieveResponse#status
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
+        ACTIVE = :active
+        RESOLVED = :resolved
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The type of target being held
+      #
+      # @see ModernTreasury::Models::HoldRetrieveResponse#target_type
+      module TargetType
+        extend ModernTreasury::Internal::Type::Enum
+
+        PAYMENT_ORDER = :payment_order
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/hold_update_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::Holds#update
+    class HoldUpdateParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      # @!attribute status
+      #   The new status of the hold
+      #
+      #   @return [Symbol, ModernTreasury::Models::HoldUpdateParams::Status]
+      required :status, enum: -> { ModernTreasury::HoldUpdateParams::Status }
+
+      # @!attribute resolution
+      #   The resolution of the hold
+      #
+      #   @return [String, nil]
+      optional :resolution, String, nil?: true
+
+      # @!method initialize(status:, resolution: nil, request_options: {})
+      #   @param status [Symbol, ModernTreasury::Models::HoldUpdateParams::Status] The new status of the hold
+      #
+      #   @param resolution [String, nil] The resolution of the hold
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+
+      # The new status of the hold
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
+        RESOLVED = :resolved
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/hold_update_response.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::Holds#update
+    class HoldUpdateResponse < ModernTreasury::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute object
+      #   The type of object
+      #
+      #   @return [Symbol, ModernTreasury::Models::HoldUpdateResponse::Object]
+      required :object, enum: -> { ModernTreasury::Models::HoldUpdateResponse::Object }
+
+      # @!attribute status
+      #   The status of the hold
+      #
+      #   @return [Symbol, ModernTreasury::Models::HoldUpdateResponse::Status]
+      required :status, enum: -> { ModernTreasury::Models::HoldUpdateResponse::Status }
+
+      # @!attribute target_id
+      #   The ID of the target being held
+      #
+      #   @return [String]
+      required :target_id, String
+
+      # @!attribute target_type
+      #   The type of target being held
+      #
+      #   @return [Symbol, ModernTreasury::Models::HoldUpdateResponse::TargetType]
+      required :target_type, enum: -> { ModernTreasury::Models::HoldUpdateResponse::TargetType }
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!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, nil]
+      optional :live_mode, ModernTreasury::Internal::Type::Boolean
+
+      # @!attribute metadata
+      #   Additional metadata for the hold
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String], nil?: true
+
+      # @!attribute reason
+      #   The reason for the hold
+      #
+      #   @return [String, nil]
+      optional :reason, String, nil?: true
+
+      # @!attribute resolution
+      #   The resolution of the hold
+      #
+      #   @return [String, nil]
+      optional :resolution, String, nil?: true
+
+      # @!attribute resolved_at
+      #   When the hold was resolved
+      #
+      #   @return [Time, nil]
+      optional :resolved_at, Time, nil?: true
+
+      # @!method initialize(id:, created_at:, object:, status:, target_id:, target_type:, updated_at:, live_mode: nil, metadata: nil, reason: nil, resolution: nil, resolved_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::HoldUpdateResponse} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param object [Symbol, ModernTreasury::Models::HoldUpdateResponse::Object] The type of object
+      #
+      #   @param status [Symbol, ModernTreasury::Models::HoldUpdateResponse::Status] The status of the hold
+      #
+      #   @param target_id [String] The ID of the target being held
+      #
+      #   @param target_type [Symbol, ModernTreasury::Models::HoldUpdateResponse::TargetType] The type of target being held
+      #
+      #   @param updated_at [Time]
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Additional metadata for the hold
+      #
+      #   @param reason [String, nil] The reason for the hold
+      #
+      #   @param resolution [String, nil] The resolution of the hold
+      #
+      #   @param resolved_at [Time, nil] When the hold was resolved
+
+      # The type of object
+      #
+      # @see ModernTreasury::Models::HoldUpdateResponse#object
+      module Object
+        extend ModernTreasury::Internal::Type::Enum
+
+        HOLD = :hold
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The status of the hold
+      #
+      # @see ModernTreasury::Models::HoldUpdateResponse#status
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
+        ACTIVE = :active
+        RESOLVED = :resolved
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The type of target being held
+      #
+      # @see ModernTreasury::Models::HoldUpdateResponse#target_type
+      module TargetType
+        extend ModernTreasury::Internal::Type::Enum
+
+        PAYMENT_ORDER = :payment_order
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/internal_account_request_closure_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::InternalAccounts#request_closure
+    class InternalAccountRequestClosureParams < 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/models/journal_entry_list_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::JournalEntries#list
+    class JournalEntryListParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      # @!attribute journal_report_id
+      #   The ID of the journal report
+      #
+      #   @return [String]
+      required :journal_report_id, String
+
+      # @!attribute page
+      #   Page number for pagination
+      #
+      #   @return [Integer, nil]
+      optional :page, Integer
+
+      # @!attribute per_page
+      #   Number of items per page
+      #
+      #   @return [Integer, nil]
+      optional :per_page, Integer
+
+      # @!method initialize(journal_report_id:, page: nil, per_page: nil, request_options: {})
+      #   @param journal_report_id [String] The ID of the journal report
+      #
+      #   @param page [Integer] Page number for pagination
+      #
+      #   @param per_page [Integer] Number of items per page
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/modern_treasury/models/journal_entry_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::JournalEntries#retrieve
+    class JournalEntryRetrieveParams < 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/models/journal_report_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::JournalReports#list
+    class JournalReportListParams < 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/models/journal_report_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::JournalReports#retrieve
+    class JournalReportRetrieveParams < 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/models/journal_report_update_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::JournalReports#update
+    class JournalReportUpdateParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      # @!attribute metadata
+      #
+      #   @return [Object, nil]
+      optional :metadata, ModernTreasury::Internal::Type::Unknown
+
+      # @!attribute status
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!method initialize(metadata: nil, status: nil, request_options: {})
+      #   @param metadata [Object]
+      #   @param status [String]
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/modern_treasury/models/payment_order.rb

@@ -839,7 +839,7 @@ module ModernTreasury
           JPMC_PAYMENT_RETURNED_DATETIME = :jpmc_payment_returned_datetime
           JPMC_TRANSACTION_REFERENCE_NUMBER = :jpmc_transaction_reference_number
           LOB_CHECK_ID = :lob_check_id
-          MT_FOF_TRANSFER_ID = :mt_fof_transfer_id
+          MT_FLOW_TRANSFER_ID = :mt_flow_transfer_id
           OTHER = :other
           PARTIAL_SWIFT_MIR = :partial_swift_mir
           PNC_CLEARING_REFERENCE = :pnc_clearing_reference

data/lib/modern_treasury/models/payment_reference.rb

@@ -139,7 +139,7 @@ module ModernTreasury
         JPMC_PAYMENT_RETURNED_DATETIME = :jpmc_payment_returned_datetime
         JPMC_TRANSACTION_REFERENCE_NUMBER = :jpmc_transaction_reference_number
         LOB_CHECK_ID = :lob_check_id
-        MT_FOF_TRANSFER_ID = :mt_fof_transfer_id
+        MT_FLOW_TRANSFER_ID = :mt_flow_transfer_id
         OTHER = :other
         PARTIAL_SWIFT_MIR = :partial_swift_mir
         PNC_CLEARING_REFERENCE = :pnc_clearing_reference

data/lib/modern_treasury/models/return_object.rb

@@ -532,7 +532,7 @@ module ModernTreasury
           JPMC_PAYMENT_RETURNED_DATETIME = :jpmc_payment_returned_datetime
           JPMC_TRANSACTION_REFERENCE_NUMBER = :jpmc_transaction_reference_number
           LOB_CHECK_ID = :lob_check_id
-          MT_FOF_TRANSFER_ID = :mt_fof_transfer_id
+          MT_FLOW_TRANSFER_ID = :mt_flow_transfer_id
           OTHER = :other
           PARTIAL_SWIFT_MIR = :partial_swift_mir
           PNC_CLEARING_REFERENCE = :pnc_clearing_reference

data/lib/modern_treasury/models/transaction.rb

@@ -297,7 +297,7 @@ module ModernTreasury
         HIFI = :hifi
         ISO20022 = :iso20022
         JPMC = :jpmc
-        MT_FOF = :mt_fof
+        MT_FLOW = :mt_flow
         MX = :mx
         PAYPAL = :paypal
         PNC = :pnc