e-invoice-api 0.25.0 → 0.26.1

data/rbi/e_invoice_api/models/me_retrieve_response.rbi

@@ -11,19 +11,9 @@ module EInvoiceAPI
           )
         end
 
-      # Credit balance of the tenant
-      sig { returns(Integer) }
-      attr_accessor :credit_balance
-
       sig { returns(String) }
       attr_accessor :name
 
-      # Plan of the tenant
-      sig do
-        returns(EInvoiceAPI::Models::MeRetrieveResponse::Plan::TaggedSymbol)
-      end
-      attr_accessor :plan
-
       # BCC recipient email to deliver documents
       sig { returns(T.nilable(String)) }
       attr_accessor :bcc_recipient_email
@@ -63,6 +53,13 @@ module EInvoiceAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :company_zip
 
+      # Credit balance of the tenant
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :credit_balance
+
+      sig { params(credit_balance: Integer).void }
+      attr_writer :credit_balance
+
       sig { returns(T.nilable(String)) }
       attr_accessor :description
 
@@ -74,6 +71,21 @@ module EInvoiceAPI
       sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :peppol_ids
 
+      # Plan of the tenant
+      sig do
+        returns(
+          T.nilable(EInvoiceAPI::Models::MeRetrieveResponse::Plan::TaggedSymbol)
+        )
+      end
+      attr_reader :plan
+
+      sig do
+        params(
+          plan: EInvoiceAPI::Models::MeRetrieveResponse::Plan::OrSymbol
+        ).void
+      end
+      attr_writer :plan
+
       # Whether the tenant is registered on our SMP
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :smp_registration
@@ -84,9 +96,7 @@ module EInvoiceAPI
 
       sig do
         params(
-          credit_balance: Integer,
           name: String,
-          plan: EInvoiceAPI::Models::MeRetrieveResponse::Plan::OrSymbol,
           bcc_recipient_email: T.nilable(String),
           company_address: T.nilable(String),
           company_city: T.nilable(String),
@@ -96,19 +106,17 @@ module EInvoiceAPI
           company_number: T.nilable(String),
           company_tax_id: T.nilable(String),
           company_zip: T.nilable(String),
+          credit_balance: Integer,
           description: T.nilable(String),
           ibans: T.nilable(T::Array[String]),
           peppol_ids: T.nilable(T::Array[String]),
+          plan: EInvoiceAPI::Models::MeRetrieveResponse::Plan::OrSymbol,
           smp_registration: T.nilable(T::Boolean),
           smp_registration_date: T.nilable(Time)
         ).returns(T.attached_class)
       end
       def self.new(
-        # Credit balance of the tenant
-        credit_balance:,
         name:,
-        # Plan of the tenant
-        plan:,
         # BCC recipient email to deliver documents
         bcc_recipient_email: nil,
         # Address of the company. Must be in the form of `Street Name Street Number`
@@ -130,11 +138,15 @@ module EInvoiceAPI
         company_tax_id: nil,
         # Zip code of the company
         company_zip: nil,
+        # Credit balance of the tenant
+        credit_balance: nil,
         description: nil,
         # IBANs of the tenant
         ibans: nil,
         # Peppol IDs of the tenant
         peppol_ids: nil,
+        # Plan of the tenant
+        plan: nil,
         # Whether the tenant is registered on our SMP
         smp_registration: nil,
         # Date when the tenant was registered on SMP
@@ -145,9 +157,7 @@ module EInvoiceAPI
       sig do
         override.returns(
           {
-            credit_balance: Integer,
             name: String,
-            plan: EInvoiceAPI::Models::MeRetrieveResponse::Plan::TaggedSymbol,
             bcc_recipient_email: T.nilable(String),
             company_address: T.nilable(String),
             company_city: T.nilable(String),
@@ -157,9 +167,11 @@ module EInvoiceAPI
             company_number: T.nilable(String),
             company_tax_id: T.nilable(String),
             company_zip: T.nilable(String),
+            credit_balance: Integer,
             description: T.nilable(String),
             ibans: T.nilable(T::Array[String]),
             peppol_ids: T.nilable(T::Array[String]),
+            plan: EInvoiceAPI::Models::MeRetrieveResponse::Plan::TaggedSymbol,
             smp_registration: T.nilable(T::Boolean),
             smp_registration_date: T.nilable(Time)
           }

data/rbi/e_invoice_api/models/outbox_list_draft_documents_params.rbi

@@ -28,10 +28,64 @@ module EInvoiceAPI
       sig { params(page_size: Integer).void }
       attr_writer :page_size
 
+      # Search in invoice number, seller/buyer names
+      sig { returns(T.nilable(String)) }
+      attr_accessor :search
+
+      # Field to sort by
+      sig do
+        returns(
+          T.nilable(
+            EInvoiceAPI::OutboxListDraftDocumentsParams::SortBy::OrSymbol
+          )
+        )
+      end
+      attr_reader :sort_by
+
+      sig do
+        params(
+          sort_by: EInvoiceAPI::OutboxListDraftDocumentsParams::SortBy::OrSymbol
+        ).void
+      end
+      attr_writer :sort_by
+
+      # Sort direction (asc/desc)
+      sig do
+        returns(
+          T.nilable(
+            EInvoiceAPI::OutboxListDraftDocumentsParams::SortOrder::OrSymbol
+          )
+        )
+      end
+      attr_reader :sort_order
+
+      sig do
+        params(
+          sort_order:
+            EInvoiceAPI::OutboxListDraftDocumentsParams::SortOrder::OrSymbol
+        ).void
+      end
+      attr_writer :sort_order
+
+      # Filter by document state
+      sig { returns(T.nilable(EInvoiceAPI::DocumentState::OrSymbol)) }
+      attr_accessor :state
+
+      # Filter by document type
+      sig { returns(T.nilable(EInvoiceAPI::DocumentType::OrSymbol)) }
+      attr_accessor :type
+
       sig do
         params(
           page: Integer,
           page_size: Integer,
+          search: T.nilable(String),
+          sort_by:
+            EInvoiceAPI::OutboxListDraftDocumentsParams::SortBy::OrSymbol,
+          sort_order:
+            EInvoiceAPI::OutboxListDraftDocumentsParams::SortOrder::OrSymbol,
+          state: T.nilable(EInvoiceAPI::DocumentState::OrSymbol),
+          type: T.nilable(EInvoiceAPI::DocumentType::OrSymbol),
           request_options: EInvoiceAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -40,6 +94,16 @@ module EInvoiceAPI
         page: nil,
         # Number of items per page
         page_size: nil,
+        # Search in invoice number, seller/buyer names
+        search: 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
+        type: nil,
         request_options: {}
       )
       end
@@ -49,12 +113,111 @@ module EInvoiceAPI
           {
             page: Integer,
             page_size: Integer,
+            search: T.nilable(String),
+            sort_by:
+              EInvoiceAPI::OutboxListDraftDocumentsParams::SortBy::OrSymbol,
+            sort_order:
+              EInvoiceAPI::OutboxListDraftDocumentsParams::SortOrder::OrSymbol,
+            state: T.nilable(EInvoiceAPI::DocumentState::OrSymbol),
+            type: T.nilable(EInvoiceAPI::DocumentType::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::OutboxListDraftDocumentsParams::SortBy)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CREATED_AT =
+          T.let(
+            :created_at,
+            EInvoiceAPI::OutboxListDraftDocumentsParams::SortBy::TaggedSymbol
+          )
+        INVOICE_DATE =
+          T.let(
+            :invoice_date,
+            EInvoiceAPI::OutboxListDraftDocumentsParams::SortBy::TaggedSymbol
+          )
+        DUE_DATE =
+          T.let(
+            :due_date,
+            EInvoiceAPI::OutboxListDraftDocumentsParams::SortBy::TaggedSymbol
+          )
+        INVOICE_TOTAL =
+          T.let(
+            :invoice_total,
+            EInvoiceAPI::OutboxListDraftDocumentsParams::SortBy::TaggedSymbol
+          )
+        CUSTOMER_NAME =
+          T.let(
+            :customer_name,
+            EInvoiceAPI::OutboxListDraftDocumentsParams::SortBy::TaggedSymbol
+          )
+        VENDOR_NAME =
+          T.let(
+            :vendor_name,
+            EInvoiceAPI::OutboxListDraftDocumentsParams::SortBy::TaggedSymbol
+          )
+        INVOICE_ID =
+          T.let(
+            :invoice_id,
+            EInvoiceAPI::OutboxListDraftDocumentsParams::SortBy::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              EInvoiceAPI::OutboxListDraftDocumentsParams::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::OutboxListDraftDocumentsParams::SortOrder
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ASC =
+          T.let(
+            :asc,
+            EInvoiceAPI::OutboxListDraftDocumentsParams::SortOrder::TaggedSymbol
+          )
+        DESC =
+          T.let(
+            :desc,
+            EInvoiceAPI::OutboxListDraftDocumentsParams::SortOrder::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              EInvoiceAPI::OutboxListDraftDocumentsParams::SortOrder::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/e_invoice_api/models/outbox_list_received_documents_params.rbi

@@ -36,19 +36,56 @@ module EInvoiceAPI
       sig { params(page_size: Integer).void }
       attr_writer :page_size
 
+      # Filter by receiver (customer_name, customer_email, customer_tax_id,
+      # customer_company_id, customer_id)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :receiver
+
       # Search in invoice number, seller/buyer names
       sig { returns(T.nilable(String)) }
       attr_accessor :search
 
-      # Filter by sender ID
+      # (Deprecated) Filter by sender ID
       sig { returns(T.nilable(String)) }
       attr_accessor :sender
 
-      # Filter by document state
-      sig { returns(T.nilable(EInvoiceAPI::DocumentState::OrSymbol)) }
-      attr_accessor :state
+      # Field to sort by
+      sig do
+        returns(
+          T.nilable(
+            EInvoiceAPI::OutboxListReceivedDocumentsParams::SortBy::OrSymbol
+          )
+        )
+      end
+      attr_reader :sort_by
+
+      sig do
+        params(
+          sort_by:
+            EInvoiceAPI::OutboxListReceivedDocumentsParams::SortBy::OrSymbol
+        ).void
+      end
+      attr_writer :sort_by
+
+      # Sort direction (asc/desc)
+      sig do
+        returns(
+          T.nilable(
+            EInvoiceAPI::OutboxListReceivedDocumentsParams::SortOrder::OrSymbol
+          )
+        )
+      end
+      attr_reader :sort_order
 
-      # Filter by document type
+      sig do
+        params(
+          sort_order:
+            EInvoiceAPI::OutboxListReceivedDocumentsParams::SortOrder::OrSymbol
+        ).void
+      end
+      attr_writer :sort_order
+
+      # Filter by document type. If not provided, returns all types.
       sig { returns(T.nilable(EInvoiceAPI::DocumentType::OrSymbol)) }
       attr_accessor :type
 
@@ -58,9 +95,13 @@ module EInvoiceAPI
           date_to: T.nilable(Time),
           page: Integer,
           page_size: Integer,
+          receiver: T.nilable(String),
           search: T.nilable(String),
           sender: T.nilable(String),
-          state: T.nilable(EInvoiceAPI::DocumentState::OrSymbol),
+          sort_by:
+            EInvoiceAPI::OutboxListReceivedDocumentsParams::SortBy::OrSymbol,
+          sort_order:
+            EInvoiceAPI::OutboxListReceivedDocumentsParams::SortOrder::OrSymbol,
           type: T.nilable(EInvoiceAPI::DocumentType::OrSymbol),
           request_options: EInvoiceAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -74,13 +115,18 @@ module EInvoiceAPI
         page: nil,
         # Number of items per page
         page_size: nil,
+        # Filter by receiver (customer_name, customer_email, customer_tax_id,
+        # customer_company_id, customer_id)
+        receiver: nil,
         # Search in invoice number, seller/buyer names
         search: nil,
-        # Filter by sender ID
+        # (Deprecated) Filter by sender ID
         sender: nil,
-        # Filter by document state
-        state: nil,
-        # Filter by document type
+        # Field to sort by
+        sort_by: nil,
+        # Sort direction (asc/desc)
+        sort_order: nil,
+        # Filter by document type. If not provided, returns all types.
         type: nil,
         request_options: {}
       )
@@ -93,9 +139,13 @@ module EInvoiceAPI
             date_to: T.nilable(Time),
             page: Integer,
             page_size: Integer,
+            receiver: T.nilable(String),
             search: T.nilable(String),
             sender: T.nilable(String),
-            state: T.nilable(EInvoiceAPI::DocumentState::OrSymbol),
+            sort_by:
+              EInvoiceAPI::OutboxListReceivedDocumentsParams::SortBy::OrSymbol,
+            sort_order:
+              EInvoiceAPI::OutboxListReceivedDocumentsParams::SortOrder::OrSymbol,
             type: T.nilable(EInvoiceAPI::DocumentType::OrSymbol),
             request_options: EInvoiceAPI::RequestOptions
           }
@@ -103,6 +153,101 @@ module EInvoiceAPI
       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::OutboxListReceivedDocumentsParams::SortBy
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CREATED_AT =
+          T.let(
+            :created_at,
+            EInvoiceAPI::OutboxListReceivedDocumentsParams::SortBy::TaggedSymbol
+          )
+        INVOICE_DATE =
+          T.let(
+            :invoice_date,
+            EInvoiceAPI::OutboxListReceivedDocumentsParams::SortBy::TaggedSymbol
+          )
+        DUE_DATE =
+          T.let(
+            :due_date,
+            EInvoiceAPI::OutboxListReceivedDocumentsParams::SortBy::TaggedSymbol
+          )
+        INVOICE_TOTAL =
+          T.let(
+            :invoice_total,
+            EInvoiceAPI::OutboxListReceivedDocumentsParams::SortBy::TaggedSymbol
+          )
+        CUSTOMER_NAME =
+          T.let(
+            :customer_name,
+            EInvoiceAPI::OutboxListReceivedDocumentsParams::SortBy::TaggedSymbol
+          )
+        VENDOR_NAME =
+          T.let(
+            :vendor_name,
+            EInvoiceAPI::OutboxListReceivedDocumentsParams::SortBy::TaggedSymbol
+          )
+        INVOICE_ID =
+          T.let(
+            :invoice_id,
+            EInvoiceAPI::OutboxListReceivedDocumentsParams::SortBy::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              EInvoiceAPI::OutboxListReceivedDocumentsParams::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::OutboxListReceivedDocumentsParams::SortOrder
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ASC =
+          T.let(
+            :asc,
+            EInvoiceAPI::OutboxListReceivedDocumentsParams::SortOrder::TaggedSymbol
+          )
+        DESC =
+          T.let(
+            :desc,
+            EInvoiceAPI::OutboxListReceivedDocumentsParams::SortOrder::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              EInvoiceAPI::OutboxListReceivedDocumentsParams::SortOrder::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/e_invoice_api/models/paginated_document_response.rbi

@@ -11,6 +11,9 @@ module EInvoiceAPI
           )
         end
 
+      sig { returns(T::Boolean) }
+      attr_accessor :has_next_page
+
       sig { returns(T::Array[EInvoiceAPI::DocumentResponse]) }
       attr_accessor :items
 
@@ -28,6 +31,7 @@ module EInvoiceAPI
 
       sig do
         params(
+          has_next_page: T::Boolean,
           items: T::Array[EInvoiceAPI::DocumentResponse::OrHash],
           page: Integer,
           page_size: Integer,
@@ -35,12 +39,13 @@ module EInvoiceAPI
           total: Integer
         ).returns(T.attached_class)
       end
-      def self.new(items:, page:, page_size:, pages:, total:)
+      def self.new(has_next_page:, items:, page:, page_size:, pages:, total:)
       end
 
       sig do
         override.returns(
           {
+            has_next_page: T::Boolean,
             items: T::Array[EInvoiceAPI::DocumentResponse],
             page: Integer,
             page_size: Integer,

data/rbi/e_invoice_api/resources/documents/attachments.rbi

@@ -37,8 +37,10 @@ module EInvoiceAPI
         def delete(attachment_id, document_id:, request_options: {})
         end
 
-        # Add one or more attachments when creating a new invoice or credit note via POST
-        # /api/documents/
+        # Add one or more attachments to an invoice. Be careful: the attachments ARE NOT
+        # ADDED to the UBL! They are only stored in our database and can be downloaded
+        # later. To add attachments to the UBL, you need to add the attachment(s) via POST
+        # /api/documents
         sig do
           params(
             document_id: String,