e-invoice-api 0.33.0 → 0.34.0

data/rbi/e_invoice_api/models/mailbox_retrieve_params.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Models
+    class MailboxRetrieveParams < EInvoiceAPI::Internal::Type::BaseModel
+      extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
+      include EInvoiceAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            EInvoiceAPI::MailboxRetrieveParams,
+            EInvoiceAPI::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :inbound_email_id
+
+      sig do
+        params(
+          inbound_email_id: String,
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(inbound_email_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          {
+            inbound_email_id: String,
+            request_options: EInvoiceAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/models/me_retrieve_response.rbi

@@ -44,8 +44,8 @@ module EInvoiceAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :company_number
 
-      # Company tax ID. For Belgium this is the VAT number. Must include the country
-      # prefix
+      # Company tax ID (VAT number), including the country prefix. Stored in compact
+      # form: uppercased with separators removed, e.g. `BE0123456789`.
       sig { returns(T.nilable(String)) }
       attr_accessor :company_tax_id
 
@@ -86,11 +86,12 @@ module EInvoiceAPI
       end
       attr_writer :plan
 
-      # Whether the tenant is registered on our SMP
+      # Legacy field. Does not show whether a Peppol ID is published: it is usually
+      # `false`, also for a tenant whose Peppol IDs are published.
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :smp_registration
 
-      # Date when the tenant was registered on SMP
+      # Legacy field. Does not show whether or when a Peppol ID was published.
       sig { returns(T.nilable(Time)) }
       attr_accessor :smp_registration_date
 
@@ -133,8 +134,8 @@ module EInvoiceAPI
         # Company number. For Belgium this is the CBE number or their EUID (European
         # Unique Identifier) number
         company_number: nil,
-        # Company tax ID. For Belgium this is the VAT number. Must include the country
-        # prefix
+        # Company tax ID (VAT number), including the country prefix. Stored in compact
+        # form: uppercased with separators removed, e.g. `BE0123456789`.
         company_tax_id: nil,
         # Zip code of the company
         company_zip: nil,
@@ -147,9 +148,10 @@ module EInvoiceAPI
         peppol_ids: nil,
         # Plan of the tenant
         plan: nil,
-        # Whether the tenant is registered on our SMP
+        # Legacy field. Does not show whether a Peppol ID is published: it is usually
+        # `false`, also for a tenant whose Peppol IDs are published.
         smp_registration: nil,
-        # Date when the tenant was registered on SMP
+        # Legacy field. Does not show whether or when a Peppol ID was published.
         smp_registration_date: nil
       )
       end

data/rbi/e_invoice_api/models/payment_detail_create.rbi

@@ -24,7 +24,9 @@ module EInvoiceAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :payment_reference
 
-      # SWIFT/BIC code of the bank
+      # The payment service provider identifier (BT-86): the BIC of the payee's bank, or
+      # `SE:BANKGIRO` / `SE:PLUSGIRO` when `bank_account_number` is a Swedish bankgiro
+      # or plusgiro number.
       sig { returns(T.nilable(String)) }
       attr_accessor :swift
 
@@ -44,7 +46,9 @@ module EInvoiceAPI
         # Structured payment reference or communication (e.g., structured communication
         # for Belgian bank transfers)
         payment_reference: nil,
-        # SWIFT/BIC code of the bank
+        # The payment service provider identifier (BT-86): the BIC of the payee's bank, or
+        # `SE:BANKGIRO` / `SE:PLUSGIRO` when `bank_account_number` is a Swedish bankgiro
+        # or plusgiro number.
         swift: nil
       )
       end

data/rbi/e_invoice_api/models/stats_retrieve_params.rbi

@@ -0,0 +1,111 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Models
+    class StatsRetrieveParams < EInvoiceAPI::Internal::Type::BaseModel
+      extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
+      include EInvoiceAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            EInvoiceAPI::StatsRetrieveParams,
+            EInvoiceAPI::Internal::AnyHash
+          )
+        end
+
+      # Aggregation type: DAY, WEEK, or MONTH. Defaults to DAY.
+      sig do
+        returns(
+          T.nilable(EInvoiceAPI::StatsRetrieveParams::Aggregation::OrSymbol)
+        )
+      end
+      attr_accessor :aggregation
+
+      # End date in yyyy-mm-dd format. If not provided, queries to latest available
+      # data.
+      sig { returns(T.nilable(Date)) }
+      attr_accessor :end_date
+
+      # Start date in yyyy-mm-dd format. If not provided, queries from earliest
+      # available data.
+      sig { returns(T.nilable(Date)) }
+      attr_accessor :start_date
+
+      sig do
+        params(
+          aggregation:
+            T.nilable(EInvoiceAPI::StatsRetrieveParams::Aggregation::OrSymbol),
+          end_date: T.nilable(Date),
+          start_date: T.nilable(Date),
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Aggregation type: DAY, WEEK, or MONTH. Defaults to DAY.
+        aggregation: nil,
+        # End date in yyyy-mm-dd format. If not provided, queries to latest available
+        # data.
+        end_date: nil,
+        # Start date in yyyy-mm-dd format. If not provided, queries from earliest
+        # available data.
+        start_date: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            aggregation:
+              T.nilable(
+                EInvoiceAPI::StatsRetrieveParams::Aggregation::OrSymbol
+              ),
+            end_date: T.nilable(Date),
+            start_date: T.nilable(Date),
+            request_options: EInvoiceAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Aggregation type: DAY, WEEK, or MONTH. Defaults to DAY.
+      module Aggregation
+        extend EInvoiceAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, EInvoiceAPI::StatsRetrieveParams::Aggregation)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DAY =
+          T.let(
+            :DAY,
+            EInvoiceAPI::StatsRetrieveParams::Aggregation::TaggedSymbol
+          )
+        WEEK =
+          T.let(
+            :WEEK,
+            EInvoiceAPI::StatsRetrieveParams::Aggregation::TaggedSymbol
+          )
+        MONTH =
+          T.let(
+            :MONTH,
+            EInvoiceAPI::StatsRetrieveParams::Aggregation::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              EInvoiceAPI::StatsRetrieveParams::Aggregation::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/models/stats_retrieve_response.rbi

@@ -0,0 +1,251 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Models
+    class StatsRetrieveResponse < EInvoiceAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            EInvoiceAPI::Models::StatsRetrieveResponse,
+            EInvoiceAPI::Internal::AnyHash
+          )
+        end
+
+      # List of action statistics, one entry per aggregation period per action
+      sig do
+        returns(T::Array[EInvoiceAPI::Models::StatsRetrieveResponse::Action])
+      end
+      attr_accessor :actions
+
+      # Aggregation type used
+      sig do
+        returns(
+          EInvoiceAPI::Models::StatsRetrieveResponse::Aggregation::TaggedSymbol
+        )
+      end
+      attr_accessor :aggregation
+
+      # Average daily usage (total actions / total days)
+      sig { returns(Float) }
+      attr_accessor :average_daily_usage
+
+      # End date of the period
+      sig { returns(Date) }
+      attr_accessor :period_end
+
+      # Start date of the period
+      sig { returns(Date) }
+      attr_accessor :period_start
+
+      # Tenant ID
+      sig { returns(String) }
+      attr_accessor :tenant_id
+
+      # Number of days in the period
+      sig { returns(Integer) }
+      attr_accessor :total_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
+      sig { returns(T.nilable(Float)) }
+      attr_reader :budget_estimation_days
+
+      sig { params(budget_estimation_days: Float).void }
+      attr_writer :budget_estimation_days
+
+      # Statistics response for a tenant.
+      sig do
+        params(
+          actions:
+            T::Array[
+              EInvoiceAPI::Models::StatsRetrieveResponse::Action::OrHash
+            ],
+          aggregation:
+            EInvoiceAPI::Models::StatsRetrieveResponse::Aggregation::OrSymbol,
+          average_daily_usage: Float,
+          period_end: Date,
+          period_start: Date,
+          tenant_id: String,
+          total_days: Integer,
+          budget_estimation_days: Float
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # List of action statistics, one entry per aggregation period per action
+        actions:,
+        # Aggregation type used
+        aggregation:,
+        # Average daily usage (total actions / total days)
+        average_daily_usage:,
+        # End date of the period
+        period_end:,
+        # Start date of the period
+        period_start:,
+        # Tenant ID
+        tenant_id:,
+        # Number of days in the period
+        total_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
+        budget_estimation_days: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            actions:
+              T::Array[EInvoiceAPI::Models::StatsRetrieveResponse::Action],
+            aggregation:
+              EInvoiceAPI::Models::StatsRetrieveResponse::Aggregation::TaggedSymbol,
+            average_daily_usage: Float,
+            period_end: Date,
+            period_start: Date,
+            tenant_id: String,
+            total_days: Integer,
+            budget_estimation_days: Float
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Action < EInvoiceAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              EInvoiceAPI::Models::StatsRetrieveResponse::Action,
+              EInvoiceAPI::Internal::AnyHash
+            )
+          end
+
+        # Type of action
+        sig do
+          returns(
+            EInvoiceAPI::Models::StatsRetrieveResponse::Action::Action::TaggedSymbol
+          )
+        end
+        attr_accessor :action
+
+        # Number of occurrences of this action in this period
+        sig { returns(Integer) }
+        attr_accessor :count
+
+        # 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
+        sig { returns(Date) }
+        attr_accessor :stat_date
+
+        # Statistics for a specific action in a specific time period.
+        sig do
+          params(
+            action:
+              EInvoiceAPI::Models::StatsRetrieveResponse::Action::Action::OrSymbol,
+            count: Integer,
+            stat_date: Date
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Type of action
+          action:,
+          # Number of occurrences of this action in this period
+          count:,
+          # 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
+          stat_date:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              action:
+                EInvoiceAPI::Models::StatsRetrieveResponse::Action::Action::TaggedSymbol,
+              count: Integer,
+              stat_date: Date
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Type of action
+        module Action
+          extend EInvoiceAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                EInvoiceAPI::Models::StatsRetrieveResponse::Action::Action
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          DOCUMENT_SENT =
+            T.let(
+              :DOCUMENT_SENT,
+              EInvoiceAPI::Models::StatsRetrieveResponse::Action::Action::TaggedSymbol
+            )
+          DOCUMENT_RECEIVED =
+            T.let(
+              :DOCUMENT_RECEIVED,
+              EInvoiceAPI::Models::StatsRetrieveResponse::Action::Action::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                EInvoiceAPI::Models::StatsRetrieveResponse::Action::Action::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      # Aggregation type used
+      module Aggregation
+        extend EInvoiceAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              EInvoiceAPI::Models::StatsRetrieveResponse::Aggregation
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DAY =
+          T.let(
+            :DAY,
+            EInvoiceAPI::Models::StatsRetrieveResponse::Aggregation::TaggedSymbol
+          )
+        WEEK =
+          T.let(
+            :WEEK,
+            EInvoiceAPI::Models::StatsRetrieveResponse::Aggregation::TaggedSymbol
+          )
+        MONTH =
+          T.let(
+            :MONTH,
+            EInvoiceAPI::Models::StatsRetrieveResponse::Aggregation::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              EInvoiceAPI::Models::StatsRetrieveResponse::Aggregation::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/models/ubl_document_validation.rbi

@@ -23,6 +23,8 @@ module EInvoiceAPI
       sig { returns(T::Array[EInvoiceAPI::UblDocumentValidation::Issue]) }
       attr_accessor :issues
 
+      # 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.
       sig { returns(T.nilable(String)) }
       attr_accessor :ubl_document
 
@@ -35,7 +37,15 @@ module EInvoiceAPI
           ubl_document: T.nilable(String)
         ).returns(T.attached_class)
       end
-      def self.new(id:, file_name:, is_valid:, issues:, ubl_document: nil)
+      def self.new(
+        id:,
+        file_name:,
+        is_valid:,
+        issues:,
+        # 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.
+        ubl_document: nil
+      )
       end
 
       sig do

data/rbi/e_invoice_api/models/webhook_history_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Models
+    class WebhookHistoryParams < EInvoiceAPI::Internal::Type::BaseModel
+      extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
+      include EInvoiceAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            EInvoiceAPI::WebhookHistoryParams,
+            EInvoiceAPI::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :webhook_id
+
+      sig do
+        params(
+          webhook_id: String,
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(webhook_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { webhook_id: String, request_options: EInvoiceAPI::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/models/webhook_history_response.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Models
+    class WebhookHistoryResponse < EInvoiceAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            EInvoiceAPI::Models::WebhookHistoryResponse,
+            EInvoiceAPI::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Array[T::Hash[Symbol, T.anything]]) }
+      attr_accessor :history
+
+      sig do
+        params(history: T::Array[T::Hash[Symbol, T.anything]]).returns(
+          T.attached_class
+        )
+      end
+      def self.new(history:)
+      end
+
+      sig do
+        override.returns({ history: T::Array[T::Hash[Symbol, T.anything]] })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/models/webhook_test_params.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Models
+    class WebhookTestParams < EInvoiceAPI::Internal::Type::BaseModel
+      extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
+      include EInvoiceAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(EInvoiceAPI::WebhookTestParams, EInvoiceAPI::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :webhook_id
+
+      # Custom event data payload
+      sig { returns(T::Hash[Symbol, T.anything]) }
+      attr_accessor :data
+
+      # Must be valid WebhookEventType
+      sig { returns(String) }
+      attr_accessor :event_type
+
+      sig do
+        params(
+          webhook_id: String,
+          data: T::Hash[Symbol, T.anything],
+          event_type: String,
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        webhook_id:,
+        # Custom event data payload
+        data:,
+        # Must be valid WebhookEventType
+        event_type:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            webhook_id: String,
+            data: T::Hash[Symbol, T.anything],
+            event_type: String,
+            request_options: EInvoiceAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/models/webhook_test_response.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Models
+    class WebhookTestResponse < EInvoiceAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            EInvoiceAPI::Models::WebhookTestResponse,
+            EInvoiceAPI::Internal::AnyHash
+          )
+        end
+
+      # Descriptive message about the test result
+      sig { returns(String) }
+      attr_accessor :message
+
+      # Whether the test completed successfully
+      sig { returns(T::Boolean) }
+      attr_accessor :success
+
+      # Result from process_webhook_task
+      sig { returns(T::Hash[Symbol, T.anything]) }
+      attr_accessor :webhook_delivery_result
+
+      # Schema for webhook test response.
+      sig do
+        params(
+          message: String,
+          success: T::Boolean,
+          webhook_delivery_result: T::Hash[Symbol, T.anything]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Descriptive message about the test result
+        message:,
+        # Whether the test completed successfully
+        success:,
+        # Result from process_webhook_task
+        webhook_delivery_result:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            message: String,
+            success: T::Boolean,
+            webhook_delivery_result: T::Hash[Symbol, T.anything]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end