modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.19

data/lib/modern_treasury/models/counterparty_delete_params.rb

@@ -4,16 +4,11 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::Counterparties#delete
     class CounterpartyDeleteParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
-      # @!parse
-      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(request_options: {}, **) = super
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(request_options: {})
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/modern_treasury/models/counterparty_list_params.rb

@@ -4,8 +4,7 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::Counterparties#list
     class CounterpartyListParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute after_cursor
@@ -13,48 +12,32 @@ module ModernTreasury
       #   @return [String, nil]
       optional :after_cursor, String, nil?: true
 
-      # @!attribute [r] created_at_lower_bound
+      # @!attribute created_at_lower_bound
       #   Used to return counterparties created after some datetime.
       #
       #   @return [Time, nil]
       optional :created_at_lower_bound, Time
 
-      # @!parse
-      #   # @return [Time]
-      #   attr_writer :created_at_lower_bound
-
-      # @!attribute [r] created_at_upper_bound
+      # @!attribute created_at_upper_bound
       #   Used to return counterparties created before some datetime.
       #
       #   @return [Time, nil]
       optional :created_at_upper_bound, Time
 
-      # @!parse
-      #   # @return [Time]
-      #   attr_writer :created_at_upper_bound
-
-      # @!attribute [r] email
+      # @!attribute email
       #   Performs a partial string match of the email field. This is also case
       #   insensitive.
       #
       #   @return [String, nil]
       optional :email, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :email
-
-      # @!attribute [r] legal_entity_id
+      # @!attribute legal_entity_id
       #   Filters for counterparties with the given legal entity ID.
       #
       #   @return [String, nil]
       optional :legal_entity_id, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :legal_entity_id
-
-      # @!attribute [r] metadata
+      # @!attribute 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.
@@ -62,57 +45,39 @@ module ModernTreasury
       #   @return [Hash{Symbol=>String}, nil]
       optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
-      # @!parse
-      #   # @return [Hash{Symbol=>String}]
-      #   attr_writer :metadata
-
-      # @!attribute [r] name
+      # @!attribute name
       #   Performs a partial string match of the name field. This is also case
       #   insensitive.
       #
       #   @return [String, nil]
       optional :name, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :name
-
-      # @!attribute [r] per_page
+      # @!attribute per_page
       #
       #   @return [Integer, nil]
       optional :per_page, Integer
 
-      # @!parse
-      #   # @return [Integer]
-      #   attr_writer :per_page
-
-      # @!parse
-      #   # @param after_cursor [String, nil]
-      #   # @param created_at_lower_bound [Time]
-      #   # @param created_at_upper_bound [Time]
-      #   # @param email [String]
-      #   # @param legal_entity_id [String]
-      #   # @param metadata [Hash{Symbol=>String}]
-      #   # @param name [String]
-      #   # @param per_page [Integer]
-      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(
-      #     after_cursor: nil,
-      #     created_at_lower_bound: nil,
-      #     created_at_upper_bound: nil,
-      #     email: nil,
-      #     legal_entity_id: nil,
-      #     metadata: nil,
-      #     name: nil,
-      #     per_page: nil,
-      #     request_options: {},
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(after_cursor: nil, created_at_lower_bound: nil, created_at_upper_bound: nil, email: nil, legal_entity_id: nil, metadata: nil, name: nil, per_page: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::CounterpartyListParams} for more details.
+      #
+      #   @param after_cursor [String, nil]
+      #
+      #   @param created_at_lower_bound [Time] Used to return counterparties created after some datetime.
+      #
+      #   @param created_at_upper_bound [Time] Used to return counterparties created before some datetime.
+      #
+      #   @param email [String] Performs a partial string match of the email field. This is also case insensitiv
+      #
+      #   @param legal_entity_id [String] Filters for counterparties with the given legal entity ID.
+      #
+      #   @param metadata [Hash{Symbol=>String}] For example, if you want to query for records with metadata key `Type` and value
+      #
+      #   @param name [String] Performs a partial string match of the name field. This is also case insensitive
+      #
+      #   @param per_page [Integer]
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/modern_treasury/models/counterparty_retrieve_params.rb

@@ -4,16 +4,11 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::Counterparties#retrieve
     class CounterpartyRetrieveParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
-      # @!parse
-      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(request_options: {}, **) = super
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(request_options: {})
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/modern_treasury/models/counterparty_update_params.rb

@@ -4,91 +4,64 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::Counterparties#update
     class CounterpartyUpdateParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
-      # @!attribute [r] email
+      # @!attribute email
       #   A new email for the counterparty.
       #
       #   @return [String, nil]
       optional :email, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :email
-
       # @!attribute legal_entity_id
       #   The id of the legal entity.
       #
       #   @return [String, nil]
       optional :legal_entity_id, String, nil?: true
 
-      # @!attribute [r] metadata
+      # @!attribute 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::Internal::Type::HashOf[String]
 
-      # @!parse
-      #   # @return [Hash{Symbol=>String}]
-      #   attr_writer :metadata
-
-      # @!attribute [r] name
+      # @!attribute name
       #   A new name for the counterparty. Will only update if passed.
       #
       #   @return [String, nil]
       optional :name, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :name
-
-      # @!attribute [r] send_remittance_advice
+      # @!attribute send_remittance_advice
       #   If this is `true`, Modern Treasury will send an email to the counterparty
       #   whenever an associated payment order is sent to the bank.
       #
       #   @return [Boolean, nil]
       optional :send_remittance_advice, ModernTreasury::Internal::Type::Boolean
 
-      # @!parse
-      #   # @return [Boolean]
-      #   attr_writer :send_remittance_advice
-
-      # @!attribute [r] taxpayer_identifier
+      # @!attribute taxpayer_identifier
       #   Either a valid SSN or EIN.
       #
       #   @return [String, nil]
       optional :taxpayer_identifier, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :taxpayer_identifier
-
-      # @!parse
-      #   # @param email [String]
-      #   # @param legal_entity_id [String, nil]
-      #   # @param metadata [Hash{Symbol=>String}]
-      #   # @param name [String]
-      #   # @param send_remittance_advice [Boolean]
-      #   # @param taxpayer_identifier [String]
-      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(
-      #     email: nil,
-      #     legal_entity_id: nil,
-      #     metadata: nil,
-      #     name: nil,
-      #     send_remittance_advice: nil,
-      #     taxpayer_identifier: nil,
-      #     request_options: {},
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(email: nil, legal_entity_id: nil, metadata: nil, name: nil, send_remittance_advice: nil, taxpayer_identifier: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::CounterpartyUpdateParams} for more details.
+      #
+      #   @param email [String] A new email for the counterparty.
+      #
+      #   @param legal_entity_id [String, nil] The id of the legal entity.
+      #
+      #   @param metadata [Hash{Symbol=>String}] Additional data in the form of key-value pairs. Pairs can be removed by passing
+      #
+      #   @param name [String] A new name for the counterparty. Will only update if passed.
+      #
+      #   @param send_remittance_advice [Boolean] If this is `true`, Modern Treasury will send an email to the counterparty whenev
+      #
+      #   @param taxpayer_identifier [String] Either a valid SSN or EIN.
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/modern_treasury/models/currency.rb

@@ -196,11 +196,8 @@ module ModernTreasury
       ZWN = :ZWN
       ZWR = :ZWR
 
-      finalize!
-
-      # @!parse
-      #   # @return [Array<Symbol>]
-      #   def self.values; end
+      # @!method self.values
+      #   @return [Array<Symbol>]
     end
   end
 end

data/lib/modern_treasury/models/document.rb

@@ -21,9 +21,9 @@ module ModernTreasury
 
       # @!attribute document_details
       #
-      #   @return [Array<ModernTreasury::Models::Document::DocumentDetail>]
+      #   @return [Array<ModernTreasury::Document::DocumentDetail>]
       required :document_details,
-               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::Document::DocumentDetail] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Document::DocumentDetail] }
 
       # @!attribute document_type
       #   A category given to the document, can be `null`.
@@ -42,13 +42,13 @@ module ModernTreasury
       #   `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
       #   `case`, `internal_account`, `decision`, or `external_account`.
       #
-      #   @return [Symbol, ModernTreasury::Models::Document::DocumentableType]
-      required :documentable_type, enum: -> { ModernTreasury::Models::Document::DocumentableType }
+      #   @return [Symbol, ModernTreasury::Document::DocumentableType]
+      required :documentable_type, enum: -> { ModernTreasury::Document::DocumentableType }
 
       # @!attribute file
       #
-      #   @return [ModernTreasury::Models::Document::File]
-      required :file, -> { ModernTreasury::Models::Document::File }
+      #   @return [ModernTreasury::Document::File]
+      required :file, -> { ModernTreasury::Document::File }
 
       # @!attribute live_mode
       #   This field will be true if this object exists in the live environment or false
@@ -73,39 +73,33 @@ module ModernTreasury
       #   @return [Time]
       required :updated_at, Time
 
-      # @!parse
-      #   # @param id [String]
-      #   # @param created_at [Time]
-      #   # @param discarded_at [Time, nil]
-      #   # @param document_details [Array<ModernTreasury::Models::Document::DocumentDetail>]
-      #   # @param document_type [String, nil]
-      #   # @param documentable_id [String]
-      #   # @param documentable_type [Symbol, ModernTreasury::Models::Document::DocumentableType]
-      #   # @param file [ModernTreasury::Models::Document::File]
-      #   # @param live_mode [Boolean]
-      #   # @param object [String]
-      #   # @param source [String]
-      #   # @param updated_at [Time]
-      #   #
-      #   def initialize(
-      #     id:,
-      #     created_at:,
-      #     discarded_at:,
-      #     document_details:,
-      #     document_type:,
-      #     documentable_id:,
-      #     documentable_type:,
-      #     file:,
-      #     live_mode:,
-      #     object:,
-      #     source:,
-      #     updated_at:,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(id:, created_at:, discarded_at:, document_details:, document_type:, documentable_id:, documentable_type:, file:, live_mode:, object:, source:, updated_at:)
+      #   Some parameter documentations has been truncated, see {ModernTreasury::Document}
+      #   for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param discarded_at [Time, nil]
+      #
+      #   @param document_details [Array<ModernTreasury::Document::DocumentDetail>]
+      #
+      #   @param document_type [String, nil] A category given to the document, can be `null`.
+      #
+      #   @param documentable_id [String] The unique identifier for the associated object.
+      #
+      #   @param documentable_type [Symbol, ModernTreasury::Document::DocumentableType] The type of the associated object. Currently can be one of `payment_order`, `tra
+      #
+      #   @param file [ModernTreasury::Document::File]
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param object [String]
+      #
+      #   @param source [String] The source of the document. Can be `vendor`, `customer`, or `modern_treasury`.
+      #
+      #   @param updated_at [Time]
 
       class DocumentDetail < ModernTreasury::Internal::Type::BaseModel
         # @!attribute id
@@ -150,38 +144,32 @@ module ModernTreasury
         #   @return [Time]
         required :updated_at, Time
 
-        # @!parse
-        #   # @param id [String]
-        #   # @param created_at [Time]
-        #   # @param discarded_at [Time, nil]
-        #   # @param document_identifier [String]
-        #   # @param document_identifier_type [String]
-        #   # @param live_mode [Boolean]
-        #   # @param object [String]
-        #   # @param updated_at [Time]
-        #   #
-        #   def initialize(
-        #     id:,
-        #     created_at:,
-        #     discarded_at:,
-        #     document_identifier:,
-        #     document_identifier_type:,
-        #     live_mode:,
-        #     object:,
-        #     updated_at:,
-        #     **
-        #   )
-        #     super
-        #   end
-
-        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, created_at:, discarded_at:, document_identifier:, document_identifier_type:, live_mode:, object:, updated_at:)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::Document::DocumentDetail} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param discarded_at [Time, nil]
+        #
+        #   @param document_identifier [String]
+        #
+        #   @param document_identifier_type [String]
+        #
+        #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+        #
+        #   @param object [String]
+        #
+        #   @param updated_at [Time]
       end
 
       # The type of the associated object. Currently can be one of `payment_order`,
       # `transaction`, `paper_item`, `expected_payment`, `counterparty`, `organization`,
       # `case`, `internal_account`, `decision`, or `external_account`.
       #
-      # @see ModernTreasury::Models::Document#documentable_type
+      # @see ModernTreasury::Document#documentable_type
       module DocumentableType
         extend ModernTreasury::Internal::Type::Enum
 
@@ -198,53 +186,36 @@ module ModernTreasury
         DECISION = :decision
         CONNECTION = :connection
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
-      # @see ModernTreasury::Models::Document#file
+      # @see ModernTreasury::Document#file
       class File < ModernTreasury::Internal::Type::BaseModel
-        # @!attribute [r] content_type
+        # @!attribute content_type
         #   The MIME content type of the document.
         #
         #   @return [String, nil]
         optional :content_type, String
 
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :content_type
-
-        # @!attribute [r] filename
+        # @!attribute filename
         #   The original filename of the document.
         #
         #   @return [String, nil]
         optional :filename, String
 
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :filename
-
-        # @!attribute [r] size
+        # @!attribute size
         #   The size of the document in bytes.
         #
         #   @return [Integer, nil]
         optional :size, Integer
 
-        # @!parse
-        #   # @return [Integer]
-        #   attr_writer :size
-
-        # @!parse
-        #   # @param content_type [String]
-        #   # @param filename [String]
-        #   # @param size [Integer]
-        #   #
-        #   def initialize(content_type: nil, filename: nil, size: nil, **) = super
-
-        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+        # @!method initialize(content_type: nil, filename: nil, size: nil)
+        #   @param content_type [String] The MIME content type of the document.
+        #
+        #   @param filename [String] The original filename of the document.
+        #
+        #   @param size [Integer] The size of the document in bytes.
       end
     end
   end

data/lib/modern_treasury/models/document_create_params.rb

@@ -4,8 +4,7 @@ module ModernTreasury
   module Models
     # @see ModernTreasury::Resources::Documents#create
     class DocumentCreateParams < ModernTreasury::Internal::Type::BaseModel
-      # @!parse
-      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
       include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute documentable_id
@@ -16,34 +15,30 @@ module ModernTreasury
 
       # @!attribute documentable_type
       #
-      #   @return [Symbol, ModernTreasury::Models::DocumentCreateParams::DocumentableType]
-      required :documentable_type, enum: -> { ModernTreasury::Models::DocumentCreateParams::DocumentableType }
+      #   @return [Symbol, ModernTreasury::DocumentCreateParams::DocumentableType]
+      required :documentable_type, enum: -> { ModernTreasury::DocumentCreateParams::DocumentableType }
 
       # @!attribute file
       #
-      #   @return [Pathname, StringIO]
-      required :file, ModernTreasury::Internal::Type::IOLike
+      #   @return [Pathname, StringIO, IO, ModernTreasury::FilePart]
+      required :file, ModernTreasury::Internal::Type::FileInput
 
-      # @!attribute [r] document_type
+      # @!attribute document_type
       #   A category given to the document, can be `null`.
       #
       #   @return [String, nil]
       optional :document_type, String
 
-      # @!parse
-      #   # @return [String]
-      #   attr_writer :document_type
-
-      # @!parse
-      #   # @param documentable_id [String]
-      #   # @param documentable_type [Symbol, ModernTreasury::Models::DocumentCreateParams::DocumentableType]
-      #   # @param file [Pathname, StringIO]
-      #   # @param document_type [String]
-      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(documentable_id:, documentable_type:, file:, document_type: nil, request_options: {}, **) = super
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method initialize(documentable_id:, documentable_type:, file:, document_type: nil, request_options: {})
+      #   @param documentable_id [String] The unique identifier for the associated object.
+      #
+      #   @param documentable_type [Symbol, ModernTreasury::DocumentCreateParams::DocumentableType]
+      #
+      #   @param file [Pathname, StringIO, IO, ModernTreasury::FilePart]
+      #
+      #   @param document_type [String] A category given to the document, can be `null`.
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
 
       module DocumentableType
         extend ModernTreasury::Internal::Type::Enum
@@ -61,11 +56,8 @@ module ModernTreasury
         DECISIONS = :decisions
         CONNECTIONS = :connections
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end