e-invoice-api 0.1.0.pre.alpha.5

data/rbi/e_invoice_api/resources/documents.rbi

@@ -0,0 +1,164 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Resources
+    class Documents
+      sig { returns(EInvoiceAPI::Resources::Documents::Attachments) }
+      attr_reader :attachments
+
+      sig { returns(EInvoiceAPI::Resources::Documents::Ubl) }
+      attr_reader :ubl
+
+      # Create a new invoice or credit note
+      sig do
+        params(
+          amount_due:
+            T.nilable(EInvoiceAPI::DocumentCreate::AmountDue::Variants),
+          attachments:
+            T.nilable(T::Array[EInvoiceAPI::DocumentAttachmentCreate::OrHash]),
+          billing_address: T.nilable(String),
+          billing_address_recipient: T.nilable(String),
+          currency: EInvoiceAPI::CurrencyCode::OrSymbol,
+          customer_address: T.nilable(String),
+          customer_address_recipient: T.nilable(String),
+          customer_email: T.nilable(String),
+          customer_id: T.nilable(String),
+          customer_name: T.nilable(String),
+          customer_tax_id: T.nilable(String),
+          direction: EInvoiceAPI::DocumentDirection::OrSymbol,
+          document_type: EInvoiceAPI::DocumentType::OrSymbol,
+          due_date: T.nilable(Date),
+          invoice_date: T.nilable(Date),
+          invoice_id: T.nilable(String),
+          invoice_total:
+            T.nilable(EInvoiceAPI::DocumentCreate::InvoiceTotal::Variants),
+          items: T.nilable(T::Array[EInvoiceAPI::DocumentCreate::Item::OrHash]),
+          note: T.nilable(String),
+          payment_details:
+            T.nilable(T::Array[EInvoiceAPI::PaymentDetailCreate::OrHash]),
+          payment_term: T.nilable(String),
+          previous_unpaid_balance:
+            T.nilable(
+              EInvoiceAPI::DocumentCreate::PreviousUnpaidBalance::Variants
+            ),
+          purchase_order: T.nilable(String),
+          remittance_address: T.nilable(String),
+          remittance_address_recipient: T.nilable(String),
+          service_address: T.nilable(String),
+          service_address_recipient: T.nilable(String),
+          service_end_date: T.nilable(Date),
+          service_start_date: T.nilable(Date),
+          shipping_address: T.nilable(String),
+          shipping_address_recipient: T.nilable(String),
+          state: EInvoiceAPI::DocumentState::OrSymbol,
+          subtotal: T.nilable(EInvoiceAPI::DocumentCreate::Subtotal::Variants),
+          tax_details:
+            T.nilable(T::Array[EInvoiceAPI::DocumentCreate::TaxDetail::OrHash]),
+          total_discount:
+            T.nilable(EInvoiceAPI::DocumentCreate::TotalDiscount::Variants),
+          total_tax: T.nilable(EInvoiceAPI::DocumentCreate::TotalTax::Variants),
+          vendor_address: T.nilable(String),
+          vendor_address_recipient: T.nilable(String),
+          vendor_email: T.nilable(String),
+          vendor_name: T.nilable(String),
+          vendor_tax_id: T.nilable(String),
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(EInvoiceAPI::DocumentResponse)
+      end
+      def create(
+        amount_due: nil,
+        attachments: nil,
+        billing_address: nil,
+        billing_address_recipient: nil,
+        # Currency of the invoice
+        currency: nil,
+        customer_address: nil,
+        customer_address_recipient: nil,
+        customer_email: nil,
+        customer_id: nil,
+        customer_name: 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_details: nil,
+        total_discount: nil,
+        total_tax: nil,
+        vendor_address: nil,
+        vendor_address_recipient: nil,
+        vendor_email: nil,
+        vendor_name: nil,
+        vendor_tax_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Get an invoice or credit note by ID
+      sig do
+        params(
+          document_id: String,
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(EInvoiceAPI::DocumentResponse)
+      end
+      def retrieve(document_id, request_options: {})
+      end
+
+      # Delete an invoice or credit note
+      sig do
+        params(
+          document_id: String,
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(EInvoiceAPI::Models::DocumentDeleteResponse)
+      end
+      def delete(document_id, request_options: {})
+      end
+
+      # Send an invoice or credit note via Peppol
+      sig do
+        params(
+          document_id: String,
+          email: T.nilable(String),
+          receiver_peppol_id: T.nilable(String),
+          receiver_peppol_scheme: T.nilable(String),
+          sender_peppol_id: T.nilable(String),
+          sender_peppol_scheme: T.nilable(String),
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(EInvoiceAPI::DocumentResponse)
+      end
+      def send_(
+        document_id,
+        email: nil,
+        receiver_peppol_id: nil,
+        receiver_peppol_scheme: nil,
+        sender_peppol_id: nil,
+        sender_peppol_scheme: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: EInvoiceAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/resources/inbox.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Resources
+    class Inbox
+      # Retrieve a paginated list of received documents with filtering options.
+      sig do
+        params(
+          date_from: T.nilable(Time),
+          date_to: T.nilable(Time),
+          page: Integer,
+          page_size: Integer,
+          search: T.nilable(String),
+          sender: T.nilable(String),
+          state: T.nilable(EInvoiceAPI::DocumentState::OrSymbol),
+          type: T.nilable(EInvoiceAPI::DocumentType::OrSymbol),
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(
+          EInvoiceAPI::Internal::DocumentsNumberPage[
+            EInvoiceAPI::DocumentResponse
+          ]
+        )
+      end
+      def list(
+        # Filter by issue date (from)
+        date_from: nil,
+        # Filter by issue date (to)
+        date_to: nil,
+        # Page number
+        page: nil,
+        # Number of items per page
+        page_size: nil,
+        # Search in invoice number, seller/buyer names
+        search: nil,
+        # Filter by sender ID
+        sender: nil,
+        # Filter by document state
+        state: nil,
+        # Filter by document type
+        type: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a paginated list of received credit notes with filtering options.
+      sig do
+        params(
+          page: Integer,
+          page_size: Integer,
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(
+          EInvoiceAPI::Internal::DocumentsNumberPage[
+            EInvoiceAPI::DocumentResponse
+          ]
+        )
+      end
+      def list_credit_notes(
+        # Page number
+        page: nil,
+        # Number of items per page
+        page_size: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a paginated list of received invoices with filtering options.
+      sig do
+        params(
+          page: Integer,
+          page_size: Integer,
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(
+          EInvoiceAPI::Internal::DocumentsNumberPage[
+            EInvoiceAPI::DocumentResponse
+          ]
+        )
+      end
+      def list_invoices(
+        # Page number
+        page: nil,
+        # Number of items per page
+        page_size: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: EInvoiceAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/resources/lookup.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Resources
+    class Lookup
+      # Lookup Peppol ID. The peppol_id must be in the form of `<scheme>:<id>`. The
+      # scheme is a 4-digit code representing the identifier scheme, and the id is the
+      # actual identifier value. For example, for a Belgian company it is
+      # `0208:0123456789` (where 0208 is the scheme for Belgian enterprises, followed by
+      # the 10 digits of the official BTW / KBO number).
+      sig do
+        params(
+          peppol_id: String,
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(EInvoiceAPI::Models::LookupRetrieveResponse)
+      end
+      def retrieve(
+        # Peppol ID in the format `<scheme>:<id>`. Example: `0208:1018265814` for a
+        # Belgian company.
+        peppol_id:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: EInvoiceAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/resources/outbox.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Resources
+    class Outbox
+      # Retrieve a paginated list of draft documents with filtering options.
+      sig do
+        params(
+          page: Integer,
+          page_size: Integer,
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(
+          EInvoiceAPI::Internal::DocumentsNumberPage[
+            EInvoiceAPI::DocumentResponse
+          ]
+        )
+      end
+      def list_draft_documents(
+        # Page number
+        page: nil,
+        # Number of items per page
+        page_size: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a paginated list of received documents with filtering options.
+      sig do
+        params(
+          date_from: T.nilable(Time),
+          date_to: T.nilable(Time),
+          page: Integer,
+          page_size: Integer,
+          search: T.nilable(String),
+          sender: T.nilable(String),
+          state: T.nilable(EInvoiceAPI::DocumentState::OrSymbol),
+          type: T.nilable(EInvoiceAPI::DocumentType::OrSymbol),
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(
+          EInvoiceAPI::Internal::DocumentsNumberPage[
+            EInvoiceAPI::DocumentResponse
+          ]
+        )
+      end
+      def list_received_documents(
+        # Filter by issue date (from)
+        date_from: nil,
+        # Filter by issue date (to)
+        date_to: nil,
+        # Page number
+        page: nil,
+        # Number of items per page
+        page_size: nil,
+        # Search in invoice number, seller/buyer names
+        search: nil,
+        # Filter by sender ID
+        sender: nil,
+        # Filter by document state
+        state: nil,
+        # Filter by document type
+        type: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: EInvoiceAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/resources/validate.rbi

@@ -0,0 +1,145 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Resources
+    class Validate
+      # Validate if the JSON document can be converted to a valid UBL document
+      sig do
+        params(
+          amount_due:
+            T.nilable(EInvoiceAPI::DocumentCreate::AmountDue::Variants),
+          attachments:
+            T.nilable(T::Array[EInvoiceAPI::DocumentAttachmentCreate::OrHash]),
+          billing_address: T.nilable(String),
+          billing_address_recipient: T.nilable(String),
+          currency: EInvoiceAPI::CurrencyCode::OrSymbol,
+          customer_address: T.nilable(String),
+          customer_address_recipient: T.nilable(String),
+          customer_email: T.nilable(String),
+          customer_id: T.nilable(String),
+          customer_name: T.nilable(String),
+          customer_tax_id: T.nilable(String),
+          direction: EInvoiceAPI::DocumentDirection::OrSymbol,
+          document_type: EInvoiceAPI::DocumentType::OrSymbol,
+          due_date: T.nilable(Date),
+          invoice_date: T.nilable(Date),
+          invoice_id: T.nilable(String),
+          invoice_total:
+            T.nilable(EInvoiceAPI::DocumentCreate::InvoiceTotal::Variants),
+          items: T.nilable(T::Array[EInvoiceAPI::DocumentCreate::Item::OrHash]),
+          note: T.nilable(String),
+          payment_details:
+            T.nilable(T::Array[EInvoiceAPI::PaymentDetailCreate::OrHash]),
+          payment_term: T.nilable(String),
+          previous_unpaid_balance:
+            T.nilable(
+              EInvoiceAPI::DocumentCreate::PreviousUnpaidBalance::Variants
+            ),
+          purchase_order: T.nilable(String),
+          remittance_address: T.nilable(String),
+          remittance_address_recipient: T.nilable(String),
+          service_address: T.nilable(String),
+          service_address_recipient: T.nilable(String),
+          service_end_date: T.nilable(Date),
+          service_start_date: T.nilable(Date),
+          shipping_address: T.nilable(String),
+          shipping_address_recipient: T.nilable(String),
+          state: EInvoiceAPI::DocumentState::OrSymbol,
+          subtotal: T.nilable(EInvoiceAPI::DocumentCreate::Subtotal::Variants),
+          tax_details:
+            T.nilable(T::Array[EInvoiceAPI::DocumentCreate::TaxDetail::OrHash]),
+          total_discount:
+            T.nilable(EInvoiceAPI::DocumentCreate::TotalDiscount::Variants),
+          total_tax: T.nilable(EInvoiceAPI::DocumentCreate::TotalTax::Variants),
+          vendor_address: T.nilable(String),
+          vendor_address_recipient: T.nilable(String),
+          vendor_email: T.nilable(String),
+          vendor_name: T.nilable(String),
+          vendor_tax_id: T.nilable(String),
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(EInvoiceAPI::UblDocumentValidation)
+      end
+      def validate_json(
+        amount_due: nil,
+        attachments: nil,
+        billing_address: nil,
+        billing_address_recipient: nil,
+        # Currency of the invoice
+        currency: nil,
+        customer_address: nil,
+        customer_address_recipient: nil,
+        customer_email: nil,
+        customer_id: nil,
+        customer_name: 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_details: nil,
+        total_discount: nil,
+        total_tax: nil,
+        vendor_address: nil,
+        vendor_address_recipient: nil,
+        vendor_email: nil,
+        vendor_name: nil,
+        vendor_tax_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Validate if a Peppol ID exists in the Peppol network and retrieve supported
+      # document types. The peppol_id must be in the form of `<scheme>:<id>`. The scheme
+      # is a 4-digit code representing the identifier scheme, and the id is the actual
+      # identifier value. For example, for a Belgian company it is `0208:0123456789`
+      # (where 0208 is the scheme for Belgian enterprises, followed by the 10 digits of
+      # the official BTW / KBO number).
+      sig do
+        params(
+          peppol_id: String,
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(EInvoiceAPI::Models::ValidateValidatePeppolIDResponse)
+      end
+      def validate_peppol_id(
+        # Peppol ID in the format `<scheme>:<id>`. Example: `0208:1018265814` for a
+        # Belgian company.
+        peppol_id:,
+        request_options: {}
+      )
+      end
+
+      # Validate the correctness of a UBL document
+      sig do
+        params(
+          file: EInvoiceAPI::Internal::FileInput,
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(EInvoiceAPI::UblDocumentValidation)
+      end
+      def validate_ubl(file:, request_options: {})
+      end
+
+      # @api private
+      sig { params(client: EInvoiceAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/resources/webhooks.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Resources
+    class Webhooks
+      # Create a new webhook
+      sig do
+        params(
+          events: T::Array[String],
+          url: String,
+          enabled: T::Boolean,
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(EInvoiceAPI::WebhookResponse)
+      end
+      def create(events:, url:, enabled: nil, request_options: {})
+      end
+
+      # Get a webhook by ID
+      sig do
+        params(
+          webhook_id: String,
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(EInvoiceAPI::WebhookResponse)
+      end
+      def retrieve(webhook_id, request_options: {})
+      end
+
+      # Update a webhook by ID
+      sig do
+        params(
+          webhook_id: String,
+          enabled: T.nilable(T::Boolean),
+          events: T.nilable(T::Array[String]),
+          url: T.nilable(String),
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(EInvoiceAPI::WebhookResponse)
+      end
+      def update(
+        webhook_id,
+        enabled: nil,
+        events: nil,
+        url: nil,
+        request_options: {}
+      )
+      end
+
+      # Get all webhooks for the current tenant
+      sig do
+        params(request_options: EInvoiceAPI::RequestOptions::OrHash).returns(
+          T::Array[EInvoiceAPI::WebhookResponse]
+        )
+      end
+      def list(request_options: {})
+      end
+
+      # Delete a webhook
+      sig do
+        params(
+          webhook_id: String,
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(EInvoiceAPI::Models::WebhookDeleteResponse)
+      end
+      def delete(webhook_id, request_options: {})
+      end
+
+      # @api private
+      sig { params(client: EInvoiceAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module EInvoiceAPI
+  VERSION = T.let(T.unsafe(nil), String)
+end

data/sig/e_invoice_api/client.rbs

@@ -0,0 +1,36 @@
+module EInvoiceAPI
+  class Client < EInvoiceAPI::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    attr_reader api_key: String
+
+    attr_reader documents: EInvoiceAPI::Resources::Documents
+
+    attr_reader inbox: EInvoiceAPI::Resources::Inbox
+
+    attr_reader outbox: EInvoiceAPI::Resources::Outbox
+
+    attr_reader validate: EInvoiceAPI::Resources::Validate
+
+    attr_reader lookup: EInvoiceAPI::Resources::Lookup
+
+    attr_reader webhooks: EInvoiceAPI::Resources::Webhooks
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    def initialize: (
+      ?api_key: String?,
+      ?base_url: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float
+    ) -> void
+  end
+end