e-invoice-api 0.33.0 → 0.34.0

data/lib/e_invoice_api/models/stats_retrieve_response.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Models
+    # @see EInvoiceAPI::Resources::Stats#retrieve
+    class StatsRetrieveResponse < EInvoiceAPI::Internal::Type::BaseModel
+      # @!attribute actions
+      #   List of action statistics, one entry per aggregation period per action
+      #
+      #   @return [Array<EInvoiceAPI::Models::StatsRetrieveResponse::Action>]
+      required :actions,
+               -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Models::StatsRetrieveResponse::Action] }
+
+      # @!attribute aggregation
+      #   Aggregation type used
+      #
+      #   @return [Symbol, EInvoiceAPI::Models::StatsRetrieveResponse::Aggregation]
+      required :aggregation, enum: -> { EInvoiceAPI::Models::StatsRetrieveResponse::Aggregation }
+
+      # @!attribute average_daily_usage
+      #   Average daily usage (total actions / total days)
+      #
+      #   @return [Float]
+      required :average_daily_usage, Float
+
+      # @!attribute period_end
+      #   End date of the period
+      #
+      #   @return [Date]
+      required :period_end, Date
+
+      # @!attribute period_start
+      #   Start date of the period
+      #
+      #   @return [Date]
+      required :period_start, Date
+
+      # @!attribute tenant_id
+      #   Tenant ID
+      #
+      #   @return [String]
+      required :tenant_id, String
+
+      # @!attribute total_days
+      #   Number of days in the period
+      #
+      #   @return [Integer]
+      required :total_days, Integer
+
+      # @!attribute budget_estimation_days
+      #   Estimated days until credits run out (credit_balance / average_daily_usage). 0.0
+      #   if average_daily_usage is 0 or credit_balance is None
+      #
+      #   @return [Float, nil]
+      optional :budget_estimation_days, Float
+
+      # @!method initialize(actions:, aggregation:, average_daily_usage:, period_end:, period_start:, tenant_id:, total_days:, budget_estimation_days: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {EInvoiceAPI::Models::StatsRetrieveResponse} for more details.
+      #
+      #   Statistics response for a tenant.
+      #
+      #   @param actions [Array<EInvoiceAPI::Models::StatsRetrieveResponse::Action>] List of action statistics, one entry per aggregation period per action
+      #
+      #   @param aggregation [Symbol, EInvoiceAPI::Models::StatsRetrieveResponse::Aggregation] Aggregation type used
+      #
+      #   @param average_daily_usage [Float] Average daily usage (total actions / total days)
+      #
+      #   @param period_end [Date] End date of the period
+      #
+      #   @param period_start [Date] Start date of the period
+      #
+      #   @param tenant_id [String] Tenant ID
+      #
+      #   @param total_days [Integer] Number of days in the period
+      #
+      #   @param budget_estimation_days [Float] Estimated days until credits run out (credit_balance / average_daily_usage). 0.0
+
+      class Action < EInvoiceAPI::Internal::Type::BaseModel
+        # @!attribute action
+        #   Type of action
+        #
+        #   @return [Symbol, EInvoiceAPI::Models::StatsRetrieveResponse::Action::Action]
+        required :action, enum: -> { EInvoiceAPI::Models::StatsRetrieveResponse::Action::Action }
+
+        # @!attribute count
+        #   Number of occurrences of this action in this period
+        #
+        #   @return [Integer]
+        required :count, Integer
+
+        # @!attribute stat_date
+        #   The date/period this stat represents. For DAY aggregation this is the specific
+        #   day, for WEEK it's the start of the week, for MONTH it's the first day of the
+        #   month
+        #
+        #   @return [Date]
+        required :stat_date, Date
+
+        # @!method initialize(action:, count:, stat_date:)
+        #   Some parameter documentations has been truncated, see
+        #   {EInvoiceAPI::Models::StatsRetrieveResponse::Action} for more details.
+        #
+        #   Statistics for a specific action in a specific time period.
+        #
+        #   @param action [Symbol, EInvoiceAPI::Models::StatsRetrieveResponse::Action::Action] Type of action
+        #
+        #   @param count [Integer] Number of occurrences of this action in this period
+        #
+        #   @param stat_date [Date] The date/period this stat represents. For DAY aggregation this is the specific d
+
+        # Type of action
+        #
+        # @see EInvoiceAPI::Models::StatsRetrieveResponse::Action#action
+        module Action
+          extend EInvoiceAPI::Internal::Type::Enum
+
+          DOCUMENT_SENT = :DOCUMENT_SENT
+          DOCUMENT_RECEIVED = :DOCUMENT_RECEIVED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # Aggregation type used
+      #
+      # @see EInvoiceAPI::Models::StatsRetrieveResponse#aggregation
+      module Aggregation
+        extend EInvoiceAPI::Internal::Type::Enum
+
+        DAY = :DAY
+        WEEK = :WEEK
+        MONTH = :MONTH
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/e_invoice_api/models/ubl_document_validation.rb

@@ -25,16 +25,25 @@ module EInvoiceAPI
       required :issues, -> { EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::UblDocumentValidation::Issue] }
 
       # @!attribute ubl_document
+      #   The UBL document as an XML string, returned whenever it could be generated, also
+      #   when the document is not valid. Only is_valid tells whether it is valid.
       #
       #   @return [String, nil]
       optional :ubl_document, String, nil?: true
 
       # @!method initialize(id:, file_name:, is_valid:, issues:, ubl_document: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {EInvoiceAPI::Models::UblDocumentValidation} for more details.
+      #
       #   @param id [String]
+      #
       #   @param file_name [String, nil]
+      #
       #   @param is_valid [Boolean]
+      #
       #   @param issues [Array<EInvoiceAPI::Models::UblDocumentValidation::Issue>]
-      #   @param ubl_document [String, nil]
+      #
+      #   @param ubl_document [String, nil] The UBL document as an XML string, returned whenever it could be generated, also
 
       class Issue < EInvoiceAPI::Internal::Type::BaseModel
         # @!attribute message

data/lib/e_invoice_api/models/webhook_history_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Models
+    # @see EInvoiceAPI::Resources::Webhooks#history
+    class WebhookHistoryParams < EInvoiceAPI::Internal::Type::BaseModel
+      extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
+      include EInvoiceAPI::Internal::Type::RequestParameters
+
+      # @!attribute webhook_id
+      #
+      #   @return [String]
+      required :webhook_id, String
+
+      # @!method initialize(webhook_id:, request_options: {})
+      #   @param webhook_id [String]
+      #   @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/e_invoice_api/models/webhook_history_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Models
+    # @see EInvoiceAPI::Resources::Webhooks#history
+    class WebhookHistoryResponse < EInvoiceAPI::Internal::Type::BaseModel
+      # @!attribute history
+      #
+      #   @return [Array<Hash{Symbol=>Object}>]
+      required :history,
+               EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Internal::Type::HashOf[EInvoiceAPI::Internal::Type::Unknown]]
+
+      # @!method initialize(history:)
+      #   @param history [Array<Hash{Symbol=>Object}>]
+    end
+  end
+end

data/lib/e_invoice_api/models/webhook_test_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Models
+    # @see EInvoiceAPI::Resources::Webhooks#test_
+    class WebhookTestParams < EInvoiceAPI::Internal::Type::BaseModel
+      extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
+      include EInvoiceAPI::Internal::Type::RequestParameters
+
+      # @!attribute webhook_id
+      #
+      #   @return [String]
+      required :webhook_id, String
+
+      # @!attribute data
+      #   Custom event data payload
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :data, EInvoiceAPI::Internal::Type::HashOf[EInvoiceAPI::Internal::Type::Unknown]
+
+      # @!attribute event_type
+      #   Must be valid WebhookEventType
+      #
+      #   @return [String]
+      required :event_type, String
+
+      # @!method initialize(webhook_id:, data:, event_type:, request_options: {})
+      #   @param webhook_id [String]
+      #
+      #   @param data [Hash{Symbol=>Object}] Custom event data payload
+      #
+      #   @param event_type [String] Must be valid WebhookEventType
+      #
+      #   @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/e_invoice_api/models/webhook_test_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Models
+    # @see EInvoiceAPI::Resources::Webhooks#test_
+    class WebhookTestResponse < EInvoiceAPI::Internal::Type::BaseModel
+      # @!attribute message
+      #   Descriptive message about the test result
+      #
+      #   @return [String]
+      required :message, String
+
+      # @!attribute success
+      #   Whether the test completed successfully
+      #
+      #   @return [Boolean]
+      required :success, EInvoiceAPI::Internal::Type::Boolean
+
+      # @!attribute webhook_delivery_result
+      #   Result from process_webhook_task
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :webhook_delivery_result, EInvoiceAPI::Internal::Type::HashOf[EInvoiceAPI::Internal::Type::Unknown]
+
+      # @!method initialize(message:, success:, webhook_delivery_result:)
+      #   Schema for webhook test response.
+      #
+      #   @param message [String] Descriptive message about the test result
+      #
+      #   @param success [Boolean] Whether the test completed successfully
+      #
+      #   @param webhook_delivery_result [Hash{Symbol=>Object}] Result from process_webhook_task
+    end
+  end
+end

data/lib/e_invoice_api/models.rb

@@ -45,6 +45,8 @@ module EInvoiceAPI
 
   Charge = EInvoiceAPI::Models::Charge
 
+  Conversion = EInvoiceAPI::Models::Conversion
+
   CurrencyCode = EInvoiceAPI::Models::CurrencyCode
 
   DocumentAttachmentCreate = EInvoiceAPI::Models::DocumentAttachmentCreate
@@ -59,6 +61,8 @@ module EInvoiceAPI
 
   DocumentDirection = EInvoiceAPI::Models::DocumentDirection
 
+  DocumentLifecycleParams = EInvoiceAPI::Models::DocumentLifecycleParams
+
   DocumentResponse = EInvoiceAPI::Models::DocumentResponse
 
   DocumentRetrieveParams = EInvoiceAPI::Models::DocumentRetrieveParams
@@ -69,10 +73,16 @@ module EInvoiceAPI
 
   DocumentState = EInvoiceAPI::Models::DocumentState
 
+  DocumentTimelineParams = EInvoiceAPI::Models::DocumentTimelineParams
+
   DocumentType = EInvoiceAPI::Models::DocumentType
 
   DocumentValidateParams = EInvoiceAPI::Models::DocumentValidateParams
 
+  DraftListParams = EInvoiceAPI::Models::DraftListParams
+
+  InboundEmailResponse = EInvoiceAPI::Models::InboundEmailResponse
+
   InboxListCreditNotesParams = EInvoiceAPI::Models::InboxListCreditNotesParams
 
   InboxListInvoicesParams = EInvoiceAPI::Models::InboxListInvoicesParams
@@ -83,6 +93,14 @@ module EInvoiceAPI
 
   LookupRetrieveParticipantsParams = EInvoiceAPI::Models::LookupRetrieveParticipantsParams
 
+  MailboxDownloadAttachmentParams = EInvoiceAPI::Models::MailboxDownloadAttachmentParams
+
+  MailboxListParams = EInvoiceAPI::Models::MailboxListParams
+
+  MailboxReprocessParams = EInvoiceAPI::Models::MailboxReprocessParams
+
+  MailboxRetrieveParams = EInvoiceAPI::Models::MailboxRetrieveParams
+
   MeRetrieveParams = EInvoiceAPI::Models::MeRetrieveParams
 
   OutboxListDraftDocumentsParams = EInvoiceAPI::Models::OutboxListDraftDocumentsParams
@@ -93,6 +111,8 @@ module EInvoiceAPI
 
   PaymentDetailCreate = EInvoiceAPI::Models::PaymentDetailCreate
 
+  StatsRetrieveParams = EInvoiceAPI::Models::StatsRetrieveParams
+
   UblDocumentValidation = EInvoiceAPI::Models::UblDocumentValidation
 
   UnitOfMeasureCode = EInvoiceAPI::Models::UnitOfMeasureCode
@@ -107,11 +127,15 @@ module EInvoiceAPI
 
   WebhookDeleteParams = EInvoiceAPI::Models::WebhookDeleteParams
 
+  WebhookHistoryParams = EInvoiceAPI::Models::WebhookHistoryParams
+
   WebhookListParams = EInvoiceAPI::Models::WebhookListParams
 
   WebhookResponse = EInvoiceAPI::Models::WebhookResponse
 
   WebhookRetrieveParams = EInvoiceAPI::Models::WebhookRetrieveParams
 
+  WebhookTestParams = EInvoiceAPI::Models::WebhookTestParams
+
   WebhookUpdateParams = EInvoiceAPI::Models::WebhookUpdateParams
 end

data/lib/e_invoice_api/resources/conversion/pdf.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Resources
+    class Conversion
+      class Pdf
+        # Convert a PDF to a document
+        #
+        # @overload create(file:, request_options: {})
+        #
+        # @param file [Pathname, StringIO, IO, String, EInvoiceAPI::FilePart]
+        # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [EInvoiceAPI::Models::Conversion::DocumentCreateFromPdfTask]
+        #
+        # @see EInvoiceAPI::Models::Conversion::PdfCreateParams
+        def create(params)
+          parsed, options = EInvoiceAPI::Conversion::PdfCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "api/conversion/pdf",
+            headers: {"content-type" => "multipart/form-data"},
+            body: parsed,
+            model: EInvoiceAPI::Conversion::DocumentCreateFromPdfTask,
+            options: options
+          )
+        end
+
+        # Get the status of a PDF conversion task
+        #
+        # @overload retrieve(task_id, request_options: {})
+        #
+        # @param task_id [String]
+        # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [EInvoiceAPI::Models::Conversion::DocumentCreateFromPdfTask]
+        #
+        # @see EInvoiceAPI::Models::Conversion::PdfRetrieveParams
+        def retrieve(task_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["api/conversion/pdf/%1$s", task_id],
+            model: EInvoiceAPI::Conversion::DocumentCreateFromPdfTask,
+            options: params[:request_options]
+          )
+        end
+
+        # Get the result of a PDF conversion task
+        #
+        # @overload result(task_id, request_options: {})
+        #
+        # @param task_id [String]
+        # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [EInvoiceAPI::Models::DocumentCreateFromPdfResponse]
+        #
+        # @see EInvoiceAPI::Models::Conversion::PdfResultParams
+        def result(task_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["api/conversion/pdf/%1$s/result", task_id],
+            model: EInvoiceAPI::Models::DocumentCreateFromPdfResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [EInvoiceAPI::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/e_invoice_api/resources/conversion.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Resources
+    class Conversion
+      # @return [EInvoiceAPI::Resources::Conversion::Pdf]
+      attr_reader :pdf
+
+      # @api private
+      #
+      # @param client [EInvoiceAPI::Client]
+      def initialize(client:)
+        @client = client
+        @pdf = EInvoiceAPI::Resources::Conversion::Pdf.new(client: client)
+      end
+    end
+  end
+end

data/lib/e_invoice_api/resources/documents.rb

@@ -14,7 +14,7 @@ module EInvoiceAPI
       #
       # Create a new invoice or credit note
       #
-      # @overload create(construct_pdf: nil, allowances: nil, amount_due: nil, attachments: nil, billing_address: nil, billing_address_recipient: nil, charges: nil, currency: nil, customer_address: nil, customer_address_recipient: nil, customer_company_id: nil, customer_email: nil, customer_id: nil, customer_name: nil, customer_peppol_id: nil, customer_tax_id: nil, direction: nil, document_type: nil, due_date: nil, invoice_date: nil, invoice_id: nil, invoice_total: nil, items: nil, note: nil, payment_details: nil, payment_term: nil, previous_unpaid_balance: nil, purchase_order: nil, remittance_address: nil, remittance_address_recipient: nil, service_address: nil, service_address_recipient: nil, service_end_date: nil, service_start_date: nil, shipping_address: nil, shipping_address_recipient: nil, state: nil, subtotal: nil, tax_code: nil, tax_details: nil, total_discount: nil, total_tax: nil, vatex: nil, vatex_note: nil, vendor_address: nil, vendor_address_recipient: nil, vendor_company_id: nil, vendor_email: nil, vendor_name: nil, vendor_tax_id: nil, request_options: {})
+      # @overload create(construct_pdf: nil, allowances: nil, amount_due: nil, attachments: nil, billing_address: nil, billing_address_recipient: nil, buyer_reference: nil, charges: nil, currency: nil, customer_address: nil, customer_address_recipient: nil, customer_company_id: nil, customer_email: nil, customer_id: nil, customer_name: nil, customer_peppol_id: nil, customer_phone: nil, customer_tax_id: nil, direction: nil, document_type: nil, due_date: nil, invoice_date: nil, invoice_id: nil, invoice_total: nil, items: nil, note: nil, payment_details: nil, payment_term: nil, preceding_invoice_date: nil, preceding_invoice_id: nil, previous_unpaid_balance: nil, purchase_order: nil, remittance_address: nil, remittance_address_recipient: nil, rounding_amount: nil, sales_order: nil, service_address: nil, service_address_recipient: nil, service_end_date: nil, service_start_date: nil, shipping_address: nil, shipping_address_recipient: nil, state: nil, subtotal: nil, tax_code: nil, tax_currency: nil, tax_details: nil, total_discount: nil, total_tax: nil, total_tax_in_tax_currency: nil, vatex: nil, vatex_note: nil, vendor_address: nil, vendor_address_recipient: nil, vendor_company_id: nil, vendor_email: nil, vendor_name: nil, vendor_phone: nil, vendor_tax_id: nil, request_options: {})
       #
       # @param construct_pdf [Boolean] Query param: If true, generate a constructed PDF from the document and include i
       #
@@ -28,6 +28,8 @@ module EInvoiceAPI
       #
       # @param billing_address_recipient [String, nil] Body param: The recipient name at the billing address
       #
+      # @param buyer_reference [String, nil] Body param: The buyer reference (BT-10), e.g. a cost centre or accounting refere
+      #
       # @param charges [Array<EInvoiceAPI::Models::DocumentCreate::Charge>, nil] Body param
       #
       # @param currency [Symbol, EInvoiceAPI::Models::CurrencyCode] Body param: Currency of the invoice (ISO 4217 currency code)
@@ -46,6 +48,8 @@ module EInvoiceAPI
       #
       # @param customer_peppol_id [String, nil] Body param: Customer Peppol ID
       #
+      # @param customer_phone [String, nil] Body param: The telephone number of the customer contact (BT-57)
+      #
       # @param customer_tax_id [String, nil] Body param: Customer tax ID. For Belgium this is the VAT number. Must include th
       #
       # @param direction [Symbol, EInvoiceAPI::Models::DocumentDirection] Body param: The direction of the document: INBOUND (purchases) or OUTBOUND (sale
@@ -68,6 +72,10 @@ module EInvoiceAPI
       #
       # @param payment_term [String, nil] Body param: The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')
       #
+      # @param preceding_invoice_date [Date, nil] Body param: The preceding invoice issue date (BT-26)
+      #
+      # @param preceding_invoice_id [String, nil] Body param: The preceding invoice reference (BT-25): the number of the invoice t
+      #
       # @param previous_unpaid_balance [Float, String, nil] Body param: The previous unpaid balance from prior invoices, if any. Must be pos
       #
       # @param purchase_order [String, nil] Body param: The purchase order reference number
@@ -76,6 +84,10 @@ module EInvoiceAPI
       #
       # @param remittance_address_recipient [String, nil] Body param: The recipient name at the remittance address
       #
+      # @param rounding_amount [Float, String, nil] Body param: The amount added to the invoice total to round the amount for paymen
+      #
+      # @param sales_order [String, nil] Body param: The sales order reference (BT-14) assigned by the seller
+      #
       # @param service_address [String, nil] Body param: The address where services were performed or goods were delivered
       #
       # @param service_address_recipient [String, nil] Body param: The recipient name at the service address
@@ -94,12 +106,16 @@ module EInvoiceAPI
       #
       # @param tax_code [Symbol, EInvoiceAPI::Models::DocumentCreate::TaxCode] Body param: Tax category code of the invoice (e.g., S for standard rate, Z for z
       #
+      # @param tax_currency [String, nil] Body param: The VAT accounting currency (BT-6, ISO 4217 currency code), when VAT
+      #
       # @param tax_details [Array<EInvoiceAPI::Models::DocumentCreate::TaxDetail>, nil] Body param
       #
       # @param total_discount [Float, String, nil] Body param: The net financial discount/charge of the invoice (non-VAT charges mi
       #
       # @param total_tax [Float, String, nil] Body param: The total tax amount of the invoice. Must be positive and rounded to
       #
+      # @param total_tax_in_tax_currency [Float, String, nil] Body param: The total VAT amount in the VAT accounting currency tax_currency (BT
+      #
       # @param vatex [Symbol, EInvoiceAPI::Models::DocumentCreate::Vatex, nil] Body param: VATEX code list for VAT exemption reasons
       #
       # @param vatex_note [String, nil] Body param: Textual explanation for VAT exemption
@@ -114,6 +130,8 @@ module EInvoiceAPI
       #
       # @param vendor_name [String, nil] Body param: The name of the vendor/seller/supplier
       #
+      # @param vendor_phone [String, nil] Body param: The telephone number of the vendor contact (BT-42). Required when ve
+      #
       # @param vendor_tax_id [String, nil] Body param: Vendor tax ID. For Belgium this is the VAT number. Must include the
       #
       # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -258,6 +276,49 @@ module EInvoiceAPI
         )
       end
 
+      # Get the timeline of events for an invoice or credit note, including creation,
+      # validation, transmission, and delivery events
+      #
+      # @overload timeline(document_id, request_options: {})
+      #
+      # @param document_id [String]
+      # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [EInvoiceAPI::Models::DocumentTimelineResponse]
+      #
+      # @see EInvoiceAPI::Models::DocumentTimelineParams
+      def timeline(document_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/documents/%1$s/timeline", document_id],
+          model: EInvoiceAPI::Models::DocumentTimelineResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Get the lifecycle events stated about an invoice or credit note after creation
+      # (Peppol Message Level and Invoice Responses, partner status events), oldest
+      # first. Each event carries a route-agnostic canonical status next to the
+      # untouched native code of its source; native codes without a canonical equivalent
+      # have canonical_status null.
+      #
+      # @overload lifecycle(document_id, request_options: {})
+      #
+      # @param document_id [String]
+      # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [EInvoiceAPI::Models::DocumentLifecycleResponse]
+      #
+      # @see EInvoiceAPI::Models::DocumentLifecycleParams
+      def lifecycle(document_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/documents/%1$s/lifecycle", document_id],
+          model: EInvoiceAPI::Models::DocumentLifecycleResponse,
+          options: params[:request_options]
+        )
+      end
+
       # @api private
       #
       # @param client [EInvoiceAPI::Client]

data/lib/e_invoice_api/resources/drafts.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Resources
+    class Drafts
+      # Retrieve a paginated list of draft documents with filtering options including
+      # state and text search.
+      #
+      # @overload list(date_from: nil, date_to: nil, page: nil, page_size: nil, search: nil, sort_by: nil, sort_order: nil, state: nil, type: nil, request_options: {})
+      #
+      # @param date_from [Time, nil] Filter by issue date (from)
+      #
+      # @param date_to [Time, nil] Filter by issue date (to)
+      #
+      # @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::DraftListParams::SortBy] Field to sort by
+      #
+      # @param sort_order [Symbol, EInvoiceAPI::Models::DraftListParams::SortOrder] Sort direction (asc/desc)
+      #
+      # @param state [Symbol, EInvoiceAPI::Models::DocumentState, nil] Filter by document state. By default return all states (DRAFT, TRANSIT, FAILED).
+      #
+      # @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>]
+      #
+      # @see EInvoiceAPI::Models::DraftListParams
+      def list(params = {})
+        parsed, options = EInvoiceAPI::DraftListParams.dump_request(params)
+        query = EInvoiceAPI::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "api/drafts/",
+          query: query,
+          page: EInvoiceAPI::Internal::DocumentsNumberPage,
+          model: EInvoiceAPI::DocumentResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [EInvoiceAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end