nacha 0.1.15 → 0.1.17

data/lib/nacha/record/rck_entry_detail.rb

@@ -7,6 +7,26 @@ require 'nacha/record/detail_record_type'
 module Nacha
   module Record
     # Represents a Re-presented Check Entry (RCK) detail record.
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as an RCK Entry Detail record with a constant value of '6'.
+    # @!attribute [rw] transaction_code
+    #   @return [Nacha::Numeric] Defines the type of account and transaction (debit).
+    # @!attribute [rw] receiving_dfi_identification
+    #   @return [Nacha::AbaNumber] The routing number of the financial institution that holds the account being debited.
+    # @!attribute [rw] dfi_account_number
+    #   @return [String] The account number to be debited.
+    # @!attribute [rw] amount
+    #   @return [Nacha::Numeric] The amount of the re-presented check.
+    # @!attribute [rw] check_serial_number
+    #   @return [String] The serial number of the original check.
+    # @!attribute [rw] individual_name
+    #   @return [String] The name of the person who wrote the original check.
+    # @!attribute [rw] discretionary_data
+    #   @return [String] An optional field for the Originator's use.
+    # @!attribute [rw] addenda_record_indicator
+    #   @return [Nacha::Numeric] Indicates if an addenda record is present.
+    # @!attribute [rw] trace_number
+    #   @return [Nacha::Numeric] A unique number assigned by the ODFI to trace the entry.
     class RckEntryDetail < Nacha::Record::Base
       include DetailRecordType
 

data/lib/nacha/record/second_iat_addenda.rb

@@ -7,6 +7,18 @@ require 'nacha/record/addenda_record_type'
 module Nacha
   module Record
     # Represents a second IAT addenda record
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as an Addenda record with a constant value of '7'.
+    # @!attribute [rw] addenda_type_code
+    #   @return [String] Specifies this is the second in a series of IAT addenda records with code '11'.
+    # @!attribute [rw] originator_name
+    #   @return [String] The name of the originator of the transaction.
+    # @!attribute [rw] originator_street_address
+    #   @return [String] The street address of the originator.
+    # @!attribute [rw] reserved
+    #   @return [String] A reserved field for future use.
+    # @!attribute [rw] entry_detail_sequence_number
+    #   @return [Nacha::Numeric] The sequence number of the IAT Entry Detail record this addenda is associated with.
     class SecondIatAddenda < Nacha::Record::Base
       include AddendaRecordType
 

data/lib/nacha/record/seventh_iat_addenda.rb

@@ -6,7 +6,19 @@ require 'nacha/record/addenda_record_type'
 
 module Nacha
   module Record
-    # Represents a seventh IAT addenda record.
+    # Represents a seventh IatAddenda addenda record.
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as an Addenda record with a constant value of '7'.
+    # @!attribute [rw] addenda_type_code
+    #   @return [String] Specifies this is the seventh in a series of IAT addenda records with code '16'.
+    # @!attribute [rw] receiver_city_state
+    #   @return [String] The city and state/province of the receiver.
+    # @!attribute [rw] receiver_country_postal
+    #   @return [String] The country and postal code of the receiver.
+    # @!attribute [rw] reserved
+    #   @return [String] A reserved field for future use.
+    # @!attribute [rw] entry_detail_sequence_number
+    #   @return [Nacha::Numeric] The sequence number of the IAT Entry Detail record this addenda is associated with.
     class SeventhIatAddenda < Nacha::Record::Base
       include AddendaRecordType
 

data/lib/nacha/record/shr_addenda.rb

@@ -7,6 +7,30 @@ require 'nacha/record/addenda_record_type'
 module Nacha
   module Record
     # Represents a Shared Network Entry (SHR) addenda record.
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as an Addenda record with a constant value of '7'.
+    # @!attribute [rw] addenda_type_code
+    #   @return [String] Specifies the type of addenda, '02' for SHR terminal information.
+    # @!attribute [rw] reference_information_1
+    #   @return [String] First reference field for additional transaction details.
+    # @!attribute [rw] reference_information_2
+    #   @return [String] Second reference field for additional transaction details.
+    # @!attribute [rw] terminal_identification_code
+    #   @return [String] A unique code identifying the shared network terminal.
+    # @!attribute [rw] transaction_serial_number
+    #   @return [String] The serial number assigned to the transaction by the terminal.
+    # @!attribute [rw] transaction_date
+    #   @return [String] The date of the shared network transaction.
+    # @!attribute [rw] authorization_code_or_card_expiration_date
+    #   @return [String] The authorization code or card expiration date for the transaction.
+    # @!attribute [rw] terminal_location
+    #   @return [String] The physical location of the terminal.
+    # @!attribute [rw] terminal_city
+    #   @return [String] The city where the terminal is located.
+    # @!attribute [rw] terminal_state
+    #   @return [Nacha::Numeric] The state where the terminal is located.
+    # @!attribute [rw] trace_number
+    #   @return [Nacha::Numeric] The trace number of the associated SHR Entry Detail record.
     class ShrAddenda < Nacha::Record::Base
       include AddendaRecordType
 

data/lib/nacha/record/shr_entry_detail.rb

@@ -7,6 +7,28 @@ require 'nacha/record/detail_record_type'
 module Nacha
   module Record
     # Represents a Shared Network Entry (SHR) detail record.
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as an SHR Entry Detail record with a constant value of '6'.
+    # @!attribute [rw] transaction_code
+    #   @return [Nacha::Numeric] Defines the type of account and transaction.
+    # @!attribute [rw] receiving_dfi_identification
+    #   @return [Nacha::AbaNumber] The routing number of the financial institution receiving the entry.
+    # @!attribute [rw] dfi_account_number
+    #   @return [String] The account number being credited or debited.
+    # @!attribute [rw] amount
+    #   @return [Nacha::Numeric] The amount of the transaction.
+    # @!attribute [rw] card_expiration_date
+    #   @return [String] The expiration date of the card used in the transaction.
+    # @!attribute [rw] document_reference_number
+    #   @return [String] A reference number for the transaction document.
+    # @!attribute [rw] individual_card_account_number
+    #   @return [String] The account number of the card used in the transaction.
+    # @!attribute [rw] card_transaction_type
+    #   @return [String] A code identifying the type of card transaction.
+    # @!attribute [rw] addenda_record_indicator
+    #   @return [Nacha::Numeric] Indicates if an addenda record with terminal information is present.
+    # @!attribute [rw] trace_number
+    #   @return [Nacha::Numeric] A unique number assigned by the ODFI to trace the entry.
     class ShrEntryDetail < Nacha::Record::Base
       include DetailRecordType
 

data/lib/nacha/record/sixth_iat_addenda.rb

@@ -7,6 +7,18 @@ require 'nacha/record/addenda_record_type'
 module Nacha
   module Record
     # Represents a sixth IAT addenda record
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as an Addenda record with a constant value of '7'.
+    # @!attribute [rw] addenda_type_code
+    #   @return [String] Specifies this is the sixth in a series of IAT addenda records with code '15'.
+    # @!attribute [rw] receiver_identification_number
+    #   @return [String] An identification number for the receiver of the transaction.
+    # @!attribute [rw] receiver_street_address
+    #   @return [String] The street address of the receiver.
+    # @!attribute [rw] reserved
+    #   @return [String] A reserved field for future use.
+    # @!attribute [rw] entry_detail_sequence_number
+    #   @return [Nacha::Numeric] The sequence number of the IAT Entry Detail record this addenda is associated with.
     class SixthIatAddenda < Nacha::Record::Base
       include AddendaRecordType
 

data/lib/nacha/record/tel_entry_detail.rb

@@ -7,6 +7,26 @@ require 'nacha/record/detail_record_type'
 module Nacha
   module Record
     # Represents a Telephone-Initiated Entry (TEL) detail record.
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as a TEL Entry Detail record with a constant value of '6'.
+    # @!attribute [rw] transaction_code
+    #   @return [Nacha::Numeric] Defines the type of account and transaction (debit).
+    # @!attribute [rw] receiving_dfi_identification
+    #   @return [Nacha::AbaNumber] The routing number of the financial institution receiving the entry.
+    # @!attribute [rw] dfi_account_number
+    #   @return [String] The account number to be debited.
+    # @!attribute [rw] amount
+    #   @return [Nacha::Numeric] The amount of the transaction.
+    # @!attribute [rw] individual_identification_number
+    #   @return [String] An identifier for the individual, if provided.
+    # @!attribute [rw] individual_name
+    #   @return [String] The name of the individual who authorized the transaction.
+    # @!attribute [rw] payment_type_code
+    #   @return [String] Indicates whether the transaction is a single entry or a recurring payment.
+    # @!attribute [rw] addenda_record_indicator
+    #   @return [Nacha::Numeric] Indicates if an addenda record is present.
+    # @!attribute [rw] trace_number
+    #   @return [Nacha::Numeric] A unique number assigned by the ODFI to trace the entry.
     class TelEntryDetail < Nacha::Record::Base
       include DetailRecordType
 

data/lib/nacha/record/third_iat_addenda.rb

@@ -7,6 +7,18 @@ require 'nacha/record/addenda_record_type'
 module Nacha
   module Record
     # Represents a third IAT addenda record.
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as an Addenda record with a constant value of '7'.
+    # @!attribute [rw] addenda_type_code
+    #   @return [String] Specifies this is the third in a series of IAT addenda records with code '12'.
+    # @!attribute [rw] originator_city_state
+    #   @return [String] The city and state/province of the originator.
+    # @!attribute [rw] originator_country_postal
+    #   @return [String] The country and postal code of the originator.
+    # @!attribute [rw] reserved
+    #   @return [String] A reserved field for future use.
+    # @!attribute [rw] entry_detail_sequence_number
+    #   @return [Nacha::Numeric] The sequence number of the IAT Entry Detail record this addenda is associated with.
     class ThirdIatAddenda < Nacha::Record::Base
       include AddendaRecordType
 

data/lib/nacha/record/trc_entry_detail.rb

@@ -7,6 +7,28 @@ require 'nacha/record/detail_record_type'
 module Nacha
   module Record
     # Represents a Truncated Entry (TRC) detail record.
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as a TRC Entry Detail record with a constant value of '6'.
+    # @!attribute [rw] transaction_code
+    #   @return [Nacha::Numeric] Defines the type of account and transaction.
+    # @!attribute [rw] receiving_dfi_identification
+    #   @return [Nacha::AbaNumber] The routing number of the financial institution receiving the entry.
+    # @!attribute [rw] dfi_account_number
+    #   @return [String] The account number being credited or debited.
+    # @!attribute [rw] amount
+    #   @return [Nacha::Numeric] The amount of the transaction.
+    # @!attribute [rw] check_serial_number
+    #   @return [String] The serial number of the truncated check.
+    # @!attribute [rw] process_control_field
+    #   @return [String] A field containing information from the check's MICR line.
+    # @!attribute [rw] item_research_number
+    #   @return [String] A number used for research purposes.
+    # @!attribute [rw] item_type_indicator
+    #   @return [String] An optional indicator for the item type.
+    # @!attribute [rw] addenda_record_indicator
+    #   @return [Nacha::Numeric] Indicates if an addenda record is present.
+    # @!attribute [rw] trace_number
+    #   @return [Nacha::Numeric] A unique number assigned by the ODFI to trace the entry.
     class TrcEntryDetail < Nacha::Record::Base
       include DetailRecordType
 

data/lib/nacha/record/trx_addenda.rb

@@ -7,6 +7,16 @@ require 'nacha/record/addenda_record_type'
 module Nacha
   module Record
     # Represents a Truncated Entry (TRX) addenda record.
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as an Addenda record with a constant value of '7'.
+    # @!attribute [rw] addenda_type_code
+    #   @return [String] Specifies the type of addenda, '05' for TRX remittance information.
+    # @!attribute [rw] payment_related_information
+    #   @return [String] Contains remittance information, such as invoice numbers.
+    # @!attribute [rw] addenda_sequence_number
+    #   @return [Nacha::Numeric] The sequence number of this addenda record within the entry.
+    # @!attribute [rw] entry_detail_sequence_number
+    #   @return [Nacha::Numeric] The sequence number of the associated TRX Entry Detail record.
     class TrxAddenda < Nacha::Record::Base
       include AddendaRecordType
 

data/lib/nacha/record/trx_entry_detail.rb

@@ -7,6 +7,30 @@ require 'nacha/record/detail_record_type'
 module Nacha
   module Record
     # Represents a Truncated Entry with Remittance Data (TRX) detail record.
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as a TRX Entry Detail record with a constant value of '6'.
+    # @!attribute [rw] transaction_code
+    #   @return [Nacha::Numeric] Defines the type of account and transaction.
+    # @!attribute [rw] receiving_dfi_identification
+    #   @return [Nacha::AbaNumber] The routing number of the financial institution receiving the entry.
+    # @!attribute [rw] dfi_account_number
+    #   @return [String] The account number being credited or debited.
+    # @!attribute [rw] total_amount
+    #   @return [Nacha::Numeric] The total amount of the entry.
+    # @!attribute [rw] identification_number
+    #   @return [String] An identifier for the receiver.
+    # @!attribute [rw] number_of_addenda_records
+    #   @return [Nacha::Numeric] The number of addenda records that follow.
+    # @!attribute [rw] receiving_company_name_id_number
+    #   @return [String] The name or identifier of the receiving company.
+    # @!attribute [rw] reserved
+    #   @return [String] A reserved field.
+    # @!attribute [rw] item_type_indicator
+    #   @return [String] An optional indicator for the item type.
+    # @!attribute [rw] addenda_record_indicator
+    #   @return [Nacha::Numeric] Indicates that one or more addenda records are present.
+    # @!attribute [rw] trace_number
+    #   @return [Nacha::Numeric] A unique number assigned by the ODFI to trace the entry.
     class TrxEntryDetail < Nacha::Record::Base
       include DetailRecordType
 

data/lib/nacha/record/web_addenda.rb

@@ -7,6 +7,16 @@ require 'nacha/record/addenda_record_type'
 module Nacha
   module Record
     # Represents an Internet-Initiated Entry (WEB) addenda record.
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as an Addenda record with a constant value of '7'.
+    # @!attribute [rw] addenda_type_code
+    #   @return [String] Specifies the type of addenda, '05' for WEB payment information.
+    # @!attribute [rw] payment_related_information
+    #   @return [String] Contains additional information about the payment, such as a reference number.
+    # @!attribute [rw] addenda_sequence_number
+    #   @return [Nacha::Numeric] The sequence number of this addenda record.
+    # @!attribute [rw] entry_detail_sequence_number
+    #   @return [Nacha::Numeric] The sequence number of the associated WEB Entry Detail record.
     class WebAddenda < Nacha::Record::Base
       include AddendaRecordType
 

data/lib/nacha/record/web_entry_detail.rb

@@ -7,6 +7,26 @@ require 'nacha/record/detail_record_type'
 module Nacha
   module Record
     # Represents an Internet-Initiated Entry (WEB) detail record.
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as a WEB Entry Detail record with a constant value of '6'.
+    # @!attribute [rw] transaction_code
+    #   @return [Nacha::Numeric] Defines the type of account and transaction.
+    # @!attribute [rw] receiving_dfi_identification
+    #   @return [Nacha::AbaNumber] The routing number of the financial institution receiving the entry.
+    # @!attribute [rw] dfi_account_number
+    #   @return [String] The account number to be credited or debited.
+    # @!attribute [rw] amount
+    #   @return [Nacha::Numeric] The amount of the transaction.
+    # @!attribute [rw] individual_identification_number
+    #   @return [String] An identifier for the individual authorizing the transaction.
+    # @!attribute [rw] individual_name
+    #   @return [String] The name of the individual authorizing the transaction.
+    # @!attribute [rw] payment_type_code
+    #   @return [String] Indicates if the payment is a single entry or recurring.
+    # @!attribute [rw] addenda_record_indicator
+    #   @return [Nacha::Numeric] Indicates if an addenda record is present.
+    # @!attribute [rw] trace_number
+    #   @return [Nacha::Numeric] A unique number assigned by the ODFI to trace the entry.
     class WebEntryDetail < Nacha::Record::Base
       include DetailRecordType
 

data/lib/nacha/record/xck_entry_detail.rb

@@ -7,6 +7,28 @@ require 'nacha/record/detail_record_type'
 module Nacha
   module Record
     # Represents a Destroyed Check Entry (XCK) detail record.
+    # @!attribute [rw] record_type_code
+    #   @return [String] Identifies the record as an XCK Entry Detail record with a constant value of '6'.
+    # @!attribute [rw] transaction_code
+    #   @return [Nacha::Numeric] Defines the type of account and transaction.
+    # @!attribute [rw] receiving_dfi_identification
+    #   @return [Nacha::AbaNumber] The routing number of the financial institution receiving the entry.
+    # @!attribute [rw] dfi_account_number
+    #   @return [String] The account number to be credited or debited.
+    # @!attribute [rw] amount
+    #   @return [Nacha::Numeric] The amount of the destroyed check.
+    # @!attribute [rw] check_serial_number
+    #   @return [String] The serial number of the destroyed check.
+    # @!attribute [rw] process_control_field
+    #   @return [String] A field containing information from the check's MICR line.
+    # @!attribute [rw] item_research_number
+    #   @return [String] A number used for research purposes.
+    # @!attribute [rw] discretionary_data
+    #   @return [String] An optional field for the Originator's use.
+    # @!attribute [rw] addenda_record_indicator
+    #   @return [Nacha::Numeric] Indicates if an addenda record is present.
+    # @!attribute [rw] trace_number
+    #   @return [Nacha::Numeric] A unique number assigned by the ODFI to trace the entry.
     class XckEntryDetail < Nacha::Record::Base
       include DetailRecordType
 

data/lib/nacha/version.rb

@@ -2,7 +2,7 @@
 
 module Nacha
   module Version
-    STRING = '0.1.15'
+    STRING = '0.1.17'
   end
   VERSION = Version::STRING
 end

data/nacha.gemspec

@@ -40,4 +40,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'simplecov-lcov'
+  spec.add_development_dependency 'yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nacha
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.17
 platform: ruby
 authors:
 - David H. Wilkins
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-22 00:00:00.000000000 Z
+date: 2025-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -234,6 +234,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby parser for ACH files.
 email:
 - dwilkins@conecuh.com