e-invoice-api 0.16.2 → 0.18.0

data/lib/e_invoice_api/resources/outbox.rb

@@ -3,14 +3,25 @@
 module EInvoiceAPI
   module Resources
     class Outbox
-      # Retrieve a paginated list of draft documents with filtering options.
+      # Retrieve a paginated list of draft documents with filtering options including
+      # state and text search.
       #
-      # @overload list_draft_documents(page: nil, page_size: nil, request_options: {})
+      # @overload list_draft_documents(page: nil, page_size: nil, search: nil, sort_by: nil, sort_order: nil, state: nil, type: nil, request_options: {})
       #
       # @param page [Integer] Page number
       #
       # @param page_size [Integer] Number of items per page
       #
+      # @param search [String, nil] Search in invoice number, seller/buyer names
+      #
+      # @param sort_by [Symbol, EInvoiceAPI::Models::OutboxListDraftDocumentsParams::SortBy] Field to sort by
+      #
+      # @param sort_order [Symbol, EInvoiceAPI::Models::OutboxListDraftDocumentsParams::SortOrder] Sort direction (asc/desc)
+      #
+      # @param state [Symbol, EInvoiceAPI::Models::DocumentState, nil] Filter by document state
+      #
+      # @param type [Symbol, EInvoiceAPI::Models::DocumentType, nil] Filter by document type
+      #
       # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [EInvoiceAPI::Internal::DocumentsNumberPage<EInvoiceAPI::Models::DocumentResponse>]
@@ -28,10 +39,13 @@ module EInvoiceAPI
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {EInvoiceAPI::Models::OutboxListReceivedDocumentsParams} for more details.
+      #
       # Retrieve a paginated list of sent documents with filtering options including
       # state, type, sender, date range, and text search.
       #
-      # @overload list_received_documents(date_from: nil, date_to: nil, page: nil, page_size: nil, search: nil, sender: nil, state: nil, type: nil, request_options: {})
+      # @overload list_received_documents(date_from: nil, date_to: nil, page: nil, page_size: nil, receiver: nil, search: nil, sender: nil, sort_by: nil, sort_order: nil, state: nil, type: nil, request_options: {})
       #
       # @param date_from [Time, nil] Filter by issue date (from)
       #
@@ -41,9 +55,15 @@ module EInvoiceAPI
       #
       # @param page_size [Integer] Number of items per page
       #
+      # @param receiver [String, nil] Filter by receiver (customer_name, customer_email, customer_tax_id, customer_com
+      #
       # @param search [String, nil] Search in invoice number, seller/buyer names
       #
-      # @param sender [String, nil] Filter by sender ID
+      # @param sender [String, nil] (Deprecated) Filter by sender ID
+      #
+      # @param sort_by [Symbol, EInvoiceAPI::Models::OutboxListReceivedDocumentsParams::SortBy] Field to sort by
+      #
+      # @param sort_order [Symbol, EInvoiceAPI::Models::OutboxListReceivedDocumentsParams::SortOrder] Sort direction (asc/desc)
       #
       # @param state [Symbol, EInvoiceAPI::Models::DocumentState, nil] Filter by document state
       #

data/lib/e_invoice_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EInvoiceAPI
-  VERSION = "0.16.2"
+  VERSION = "0.18.0"
 end

data/rbi/e_invoice_api/models/document_response.rbi

@@ -11,6 +11,9 @@ module EInvoiceAPI
       sig { returns(String) }
       attr_accessor :id
 
+      sig { returns(Time) }
+      attr_accessor :created_at
+
       sig do
         returns(T.nilable(T::Array[EInvoiceAPI::DocumentResponse::Allowance]))
       end
@@ -242,6 +245,7 @@ module EInvoiceAPI
       sig do
         params(
           id: String,
+          created_at: Time,
           allowances:
             T.nilable(
               T::Array[EInvoiceAPI::DocumentResponse::Allowance::OrHash]
@@ -307,6 +311,7 @@ module EInvoiceAPI
       end
       def self.new(
         id:,
+        created_at:,
         allowances: nil,
         # The amount due for payment. Must be positive and rounded to maximum 2 decimals
         amount_due: nil,
@@ -415,6 +420,7 @@ module EInvoiceAPI
         override.returns(
           {
             id: String,
+            created_at: Time,
             allowances:
               T.nilable(T::Array[EInvoiceAPI::DocumentResponse::Allowance]),
             amount_due: T.nilable(String),

data/rbi/e_invoice_api/models/document_type.rbi

@@ -11,6 +11,10 @@ module EInvoiceAPI
       INVOICE = T.let(:INVOICE, EInvoiceAPI::DocumentType::TaggedSymbol)
       CREDIT_NOTE = T.let(:CREDIT_NOTE, EInvoiceAPI::DocumentType::TaggedSymbol)
       DEBIT_NOTE = T.let(:DEBIT_NOTE, EInvoiceAPI::DocumentType::TaggedSymbol)
+      SELFBILLING_INVOICE =
+        T.let(:SELFBILLING_INVOICE, EInvoiceAPI::DocumentType::TaggedSymbol)
+      SELFBILLING_CREDIT_NOTE =
+        T.let(:SELFBILLING_CREDIT_NOTE, EInvoiceAPI::DocumentType::TaggedSymbol)
 
       sig do
         override.returns(T::Array[EInvoiceAPI::DocumentType::TaggedSymbol])

data/rbi/e_invoice_api/models/inbox_list_credit_notes_params.rbi

@@ -28,10 +28,46 @@ module EInvoiceAPI
       sig { params(page_size: Integer).void }
       attr_writer :page_size
 
+      # Field to sort by
+      sig do
+        returns(
+          T.nilable(EInvoiceAPI::InboxListCreditNotesParams::SortBy::OrSymbol)
+        )
+      end
+      attr_reader :sort_by
+
+      sig do
+        params(
+          sort_by: EInvoiceAPI::InboxListCreditNotesParams::SortBy::OrSymbol
+        ).void
+      end
+      attr_writer :sort_by
+
+      # Sort direction (asc/desc)
+      sig do
+        returns(
+          T.nilable(
+            EInvoiceAPI::InboxListCreditNotesParams::SortOrder::OrSymbol
+          )
+        )
+      end
+      attr_reader :sort_order
+
+      sig do
+        params(
+          sort_order:
+            EInvoiceAPI::InboxListCreditNotesParams::SortOrder::OrSymbol
+        ).void
+      end
+      attr_writer :sort_order
+
       sig do
         params(
           page: Integer,
           page_size: Integer,
+          sort_by: EInvoiceAPI::InboxListCreditNotesParams::SortBy::OrSymbol,
+          sort_order:
+            EInvoiceAPI::InboxListCreditNotesParams::SortOrder::OrSymbol,
           request_options: EInvoiceAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -40,6 +76,10 @@ module EInvoiceAPI
         page: nil,
         # Number of items per page
         page_size: nil,
+        # Field to sort by
+        sort_by: nil,
+        # Sort direction (asc/desc)
+        sort_order: nil,
         request_options: {}
       )
       end
@@ -49,12 +89,104 @@ module EInvoiceAPI
           {
             page: Integer,
             page_size: Integer,
+            sort_by: EInvoiceAPI::InboxListCreditNotesParams::SortBy::OrSymbol,
+            sort_order:
+              EInvoiceAPI::InboxListCreditNotesParams::SortOrder::OrSymbol,
             request_options: EInvoiceAPI::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      # Field to sort by
+      module SortBy
+        extend EInvoiceAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, EInvoiceAPI::InboxListCreditNotesParams::SortBy)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CREATED_AT =
+          T.let(
+            :created_at,
+            EInvoiceAPI::InboxListCreditNotesParams::SortBy::TaggedSymbol
+          )
+        INVOICE_DATE =
+          T.let(
+            :invoice_date,
+            EInvoiceAPI::InboxListCreditNotesParams::SortBy::TaggedSymbol
+          )
+        DUE_DATE =
+          T.let(
+            :due_date,
+            EInvoiceAPI::InboxListCreditNotesParams::SortBy::TaggedSymbol
+          )
+        INVOICE_TOTAL =
+          T.let(
+            :invoice_total,
+            EInvoiceAPI::InboxListCreditNotesParams::SortBy::TaggedSymbol
+          )
+        CUSTOMER_NAME =
+          T.let(
+            :customer_name,
+            EInvoiceAPI::InboxListCreditNotesParams::SortBy::TaggedSymbol
+          )
+        VENDOR_NAME =
+          T.let(
+            :vendor_name,
+            EInvoiceAPI::InboxListCreditNotesParams::SortBy::TaggedSymbol
+          )
+        INVOICE_ID =
+          T.let(
+            :invoice_id,
+            EInvoiceAPI::InboxListCreditNotesParams::SortBy::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              EInvoiceAPI::InboxListCreditNotesParams::SortBy::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Sort direction (asc/desc)
+      module SortOrder
+        extend EInvoiceAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, EInvoiceAPI::InboxListCreditNotesParams::SortOrder)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ASC =
+          T.let(
+            :asc,
+            EInvoiceAPI::InboxListCreditNotesParams::SortOrder::TaggedSymbol
+          )
+        DESC =
+          T.let(
+            :desc,
+            EInvoiceAPI::InboxListCreditNotesParams::SortOrder::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              EInvoiceAPI::InboxListCreditNotesParams::SortOrder::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/e_invoice_api/models/inbox_list_invoices_params.rbi

@@ -28,10 +28,42 @@ module EInvoiceAPI
       sig { params(page_size: Integer).void }
       attr_writer :page_size
 
+      # Field to sort by
+      sig do
+        returns(
+          T.nilable(EInvoiceAPI::InboxListInvoicesParams::SortBy::OrSymbol)
+        )
+      end
+      attr_reader :sort_by
+
+      sig do
+        params(
+          sort_by: EInvoiceAPI::InboxListInvoicesParams::SortBy::OrSymbol
+        ).void
+      end
+      attr_writer :sort_by
+
+      # Sort direction (asc/desc)
+      sig do
+        returns(
+          T.nilable(EInvoiceAPI::InboxListInvoicesParams::SortOrder::OrSymbol)
+        )
+      end
+      attr_reader :sort_order
+
+      sig do
+        params(
+          sort_order: EInvoiceAPI::InboxListInvoicesParams::SortOrder::OrSymbol
+        ).void
+      end
+      attr_writer :sort_order
+
       sig do
         params(
           page: Integer,
           page_size: Integer,
+          sort_by: EInvoiceAPI::InboxListInvoicesParams::SortBy::OrSymbol,
+          sort_order: EInvoiceAPI::InboxListInvoicesParams::SortOrder::OrSymbol,
           request_options: EInvoiceAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -40,6 +72,10 @@ module EInvoiceAPI
         page: nil,
         # Number of items per page
         page_size: nil,
+        # Field to sort by
+        sort_by: nil,
+        # Sort direction (asc/desc)
+        sort_order: nil,
         request_options: {}
       )
       end
@@ -49,12 +85,102 @@ module EInvoiceAPI
           {
             page: Integer,
             page_size: Integer,
+            sort_by: EInvoiceAPI::InboxListInvoicesParams::SortBy::OrSymbol,
+            sort_order:
+              EInvoiceAPI::InboxListInvoicesParams::SortOrder::OrSymbol,
             request_options: EInvoiceAPI::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      # Field to sort by
+      module SortBy
+        extend EInvoiceAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, EInvoiceAPI::InboxListInvoicesParams::SortBy)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CREATED_AT =
+          T.let(
+            :created_at,
+            EInvoiceAPI::InboxListInvoicesParams::SortBy::TaggedSymbol
+          )
+        INVOICE_DATE =
+          T.let(
+            :invoice_date,
+            EInvoiceAPI::InboxListInvoicesParams::SortBy::TaggedSymbol
+          )
+        DUE_DATE =
+          T.let(
+            :due_date,
+            EInvoiceAPI::InboxListInvoicesParams::SortBy::TaggedSymbol
+          )
+        INVOICE_TOTAL =
+          T.let(
+            :invoice_total,
+            EInvoiceAPI::InboxListInvoicesParams::SortBy::TaggedSymbol
+          )
+        CUSTOMER_NAME =
+          T.let(
+            :customer_name,
+            EInvoiceAPI::InboxListInvoicesParams::SortBy::TaggedSymbol
+          )
+        VENDOR_NAME =
+          T.let(
+            :vendor_name,
+            EInvoiceAPI::InboxListInvoicesParams::SortBy::TaggedSymbol
+          )
+        INVOICE_ID =
+          T.let(
+            :invoice_id,
+            EInvoiceAPI::InboxListInvoicesParams::SortBy::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[EInvoiceAPI::InboxListInvoicesParams::SortBy::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Sort direction (asc/desc)
+      module SortOrder
+        extend EInvoiceAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, EInvoiceAPI::InboxListInvoicesParams::SortOrder)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ASC =
+          T.let(
+            :asc,
+            EInvoiceAPI::InboxListInvoicesParams::SortOrder::TaggedSymbol
+          )
+        DESC =
+          T.let(
+            :desc,
+            EInvoiceAPI::InboxListInvoicesParams::SortOrder::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              EInvoiceAPI::InboxListInvoicesParams::SortOrder::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/e_invoice_api/models/inbox_list_params.rbi

@@ -37,10 +37,32 @@ module EInvoiceAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :search
 
-      # Filter by sender ID
+      # Filter by sender (vendor_name, vendor_email, vendor_tax_id, vendor_company_id)
       sig { returns(T.nilable(String)) }
       attr_accessor :sender
 
+      # Field to sort by
+      sig { returns(T.nilable(EInvoiceAPI::InboxListParams::SortBy::OrSymbol)) }
+      attr_reader :sort_by
+
+      sig do
+        params(sort_by: EInvoiceAPI::InboxListParams::SortBy::OrSymbol).void
+      end
+      attr_writer :sort_by
+
+      # Sort direction (asc/desc)
+      sig do
+        returns(T.nilable(EInvoiceAPI::InboxListParams::SortOrder::OrSymbol))
+      end
+      attr_reader :sort_order
+
+      sig do
+        params(
+          sort_order: EInvoiceAPI::InboxListParams::SortOrder::OrSymbol
+        ).void
+      end
+      attr_writer :sort_order
+
       # Filter by document state
       sig { returns(T.nilable(EInvoiceAPI::DocumentState::OrSymbol)) }
       attr_accessor :state
@@ -57,6 +79,8 @@ module EInvoiceAPI
           page_size: Integer,
           search: T.nilable(String),
           sender: T.nilable(String),
+          sort_by: EInvoiceAPI::InboxListParams::SortBy::OrSymbol,
+          sort_order: EInvoiceAPI::InboxListParams::SortOrder::OrSymbol,
           state: T.nilable(EInvoiceAPI::DocumentState::OrSymbol),
           type: T.nilable(EInvoiceAPI::DocumentType::OrSymbol),
           request_options: EInvoiceAPI::RequestOptions::OrHash
@@ -73,8 +97,12 @@ module EInvoiceAPI
         page_size: nil,
         # Search in invoice number, seller/buyer names
         search: nil,
-        # Filter by sender ID
+        # Filter by sender (vendor_name, vendor_email, vendor_tax_id, vendor_company_id)
         sender: nil,
+        # Field to sort by
+        sort_by: nil,
+        # Sort direction (asc/desc)
+        sort_order: nil,
         # Filter by document state
         state: nil,
         # Filter by document type
@@ -92,6 +120,8 @@ module EInvoiceAPI
             page_size: Integer,
             search: T.nilable(String),
             sender: T.nilable(String),
+            sort_by: EInvoiceAPI::InboxListParams::SortBy::OrSymbol,
+            sort_order: EInvoiceAPI::InboxListParams::SortOrder::OrSymbol,
             state: T.nilable(EInvoiceAPI::DocumentState::OrSymbol),
             type: T.nilable(EInvoiceAPI::DocumentType::OrSymbol),
             request_options: EInvoiceAPI::RequestOptions
@@ -100,6 +130,73 @@ module EInvoiceAPI
       end
       def to_hash
       end
+
+      # Field to sort by
+      module SortBy
+        extend EInvoiceAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, EInvoiceAPI::InboxListParams::SortBy) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CREATED_AT =
+          T.let(:created_at, EInvoiceAPI::InboxListParams::SortBy::TaggedSymbol)
+        INVOICE_DATE =
+          T.let(
+            :invoice_date,
+            EInvoiceAPI::InboxListParams::SortBy::TaggedSymbol
+          )
+        DUE_DATE =
+          T.let(:due_date, EInvoiceAPI::InboxListParams::SortBy::TaggedSymbol)
+        INVOICE_TOTAL =
+          T.let(
+            :invoice_total,
+            EInvoiceAPI::InboxListParams::SortBy::TaggedSymbol
+          )
+        CUSTOMER_NAME =
+          T.let(
+            :customer_name,
+            EInvoiceAPI::InboxListParams::SortBy::TaggedSymbol
+          )
+        VENDOR_NAME =
+          T.let(
+            :vendor_name,
+            EInvoiceAPI::InboxListParams::SortBy::TaggedSymbol
+          )
+        INVOICE_ID =
+          T.let(:invoice_id, EInvoiceAPI::InboxListParams::SortBy::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[EInvoiceAPI::InboxListParams::SortBy::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Sort direction (asc/desc)
+      module SortOrder
+        extend EInvoiceAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, EInvoiceAPI::InboxListParams::SortOrder)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ASC = T.let(:asc, EInvoiceAPI::InboxListParams::SortOrder::TaggedSymbol)
+        DESC =
+          T.let(:desc, EInvoiceAPI::InboxListParams::SortOrder::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[EInvoiceAPI::InboxListParams::SortOrder::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/e_invoice_api/models/lookup_retrieve_response.rbi

@@ -306,6 +306,14 @@ module EInvoiceAPI
         sig { returns(T.nilable(String)) }
         attr_accessor :error
 
+        # DNS lookup method used: 'naptr' (new spec) or 'busdox' (legacy)
+        sig { returns(T.nilable(String)) }
+        attr_accessor :lookup_method
+
+        # Hostname of the SMP (Service Metadata Publisher) discovered via DNS
+        sig { returns(T.nilable(String)) }
+        attr_accessor :smp_hostname
+
         # Information about the DNS lookup performed
         sig do
           params(
@@ -315,7 +323,9 @@ module EInvoiceAPI
               ],
             sml_hostname: String,
             status: String,
-            error: T.nilable(String)
+            error: T.nilable(String),
+            lookup_method: T.nilable(String),
+            smp_hostname: T.nilable(String)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -326,7 +336,11 @@ module EInvoiceAPI
           # Status of the DNS lookup: 'success', 'error', or 'pending'
           status:,
           # Error message if the DNS lookup failed
-          error: nil
+          error: nil,
+          # DNS lookup method used: 'naptr' (new spec) or 'busdox' (legacy)
+          lookup_method: nil,
+          # Hostname of the SMP (Service Metadata Publisher) discovered via DNS
+          smp_hostname: nil
         )
         end
 
@@ -339,7 +353,9 @@ module EInvoiceAPI
                 ],
               sml_hostname: String,
               status: String,
-              error: T.nilable(String)
+              error: T.nilable(String),
+              lookup_method: T.nilable(String),
+              smp_hostname: T.nilable(String)
             }
           )
         end