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

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 442bea54ce502931e88fe322f63412115cdc8cbd69b523d06ff60c1f68589e41
+  data.tar.gz: d835eab08bd5e1d8aeb233d32c44f682c6b0459c00b6f5205525da28810ed319
+SHA512:
+  metadata.gz: babc76b3861ef91d079be95e64358ad5337e239cbe9e7177d75b70cd0ba7e354e1aa470fd226432fcb2e1fbe4b4d30776e1946673cae4d8366c606b10a0a7e90
+  data.tar.gz: 95a2f5df2995834b95651843d75012e81657ab69d10caa3a809d22782e84054ec96b2a2f1d2f37b593be8aeb789c27f40b07c028c55a4cd69321d16ccce4ce99

data/.ignore

@@ -0,0 +1,2 @@
+rbi/*
+sig/*

data/CHANGELOG.md

@@ -0,0 +1,57 @@
+# Changelog
+
+## 0.1.0-alpha.5 (2025-06-17)
+
+Full Changelog: [v0.1.0-alpha.4...v0.1.0-alpha.5](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.1.0-alpha.4...v0.1.0-alpha.5)
+
+### Bug Fixes
+
+* feat(api): manual updates ([fa6a501](https://github.com/e-invoice-be/e-invoice-rb/commit/fa6a501d6552c90798a3b8a4523d020e7f8ffc23))
+
+
+### Chores
+
+* **internal:** version bump ([f9d9dd9](https://github.com/e-invoice-be/e-invoice-rb/commit/f9d9dd9f56b088ba2181e9abd4ad009a3d53eff9))
+
+## 0.1.0-alpha.4 (2025-06-17)
+
+Full Changelog: [v0.1.0-alpha.3...v0.1.0-alpha.4](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.1.0-alpha.3...v0.1.0-alpha.4)
+
+### Chores
+
+* **internal:** version bump ([6e89b42](https://github.com/e-invoice-be/e-invoice-rb/commit/6e89b4255d882486ca49aaaa175948d253c4e551))
+
+## 0.1.0-alpha.3 (2025-06-17)
+
+Full Changelog: [v0.1.0-alpha.2...v0.1.0-alpha.3](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.1.0-alpha.2...v0.1.0-alpha.3)
+
+### Chores
+
+* **internal:** version bump ([e058e23](https://github.com/e-invoice-be/e-invoice-rb/commit/e058e233d27cf29446c458a3abe3885e6ebedd6c))
+
+
+### Documentation
+
+* Update README.md ([f2ab975](https://github.com/e-invoice-be/e-invoice-rb/commit/f2ab975d57c9556626f481766759173f9362a34d))
+
+## 0.1.0-alpha.2 (2025-06-17)
+
+Full Changelog: [v0.1.0-alpha.1...v0.1.0-alpha.2](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.1.0-alpha.1...v0.1.0-alpha.2)
+
+### Features
+
+* **api:** manual updates ([855202f](https://github.com/e-invoice-be/e-invoice-rb/commit/855202f9724b6f846d24b36508863e22b72d215f))
+
+## 0.1.0-alpha.1 (2025-06-17)
+
+Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)
+
+### Features
+
+* **api:** manual updates ([9052941](https://github.com/e-invoice-be/e-invoice-rb/commit/9052941355822aac188a540fd9f77fd05556d143))
+
+
+### Chores
+
+* configure new SDK language ([3a0decc](https://github.com/e-invoice-be/e-invoice-rb/commit/3a0deccb4ae72d7e212264c4db4e1cc60582ae21))
+* update SDK settings ([3a8c815](https://github.com/e-invoice-be/e-invoice-rb/commit/3a8c8157b713da215c8b0853ad78f726d3b81ba4))

data/README.md

@@ -0,0 +1,285 @@
+# e-invoice.be Peppol API library
+
+The e-invoice.be Peppol library provides convenient access to the E Invoice REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/e-invoice-be/e-invoice-rb#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
+
+To get an API key, [make a free account](https://app.e-invoice.be/register?ref=ruby) and register your company.
+
+## Documentation
+
+Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/e-invoice-api).
+
+The full REST API documentation can be found on [api.e-invoice.be](https://api.e-invoice.be/api/redoc).
+
+## Installation
+
+To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
+
+<!-- x-release-please-start-version -->
+
+```ruby
+gem "e-invoice-api", "~> 0.1.0.pre.alpha.5"
+```
+
+<!-- x-release-please-end -->
+
+## Usage
+
+```ruby
+require "bundler/setup"
+require "e_invoice_api"
+
+e_invoice = EInvoiceAPI::Client.new(
+  api_key: ENV["E_INVOICE_API_KEY"] # This is the default and can be omitted
+)
+
+document_response = e_invoice.documents.create
+
+puts(document_response.id)
+```
+
+### Pagination
+
+List methods in the E Invoice API are paginated.
+
+This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:
+
+```ruby
+page = e_invoice.inbox.list
+
+# Fetch single item from page.
+inbox = page.items[0]
+puts(inbox.id)
+
+# Automatically fetches more pages as needed.
+page.auto_paging_each do |inbox|
+  puts(inbox.id)
+end
+```
+
+Alternatively, you can use the `#next_page?` and `#next_page` methods for more granular control working with pages.
+
+```ruby
+if page.next_page?
+  new_page = page.next_page
+  puts(new_page.items[0].id)
+end
+```
+
+### File uploads
+
+Request parameters that correspond to file uploads can be passed as raw contents, a [`Pathname`](https://rubyapi.org/3.2/o/pathname) instance, [`StringIO`](https://rubyapi.org/3.2/o/stringio), or more.
+
+```ruby
+require "pathname"
+
+# Use `Pathname` to send the filename and/or avoid paging a large file into memory:
+document_attachment = e_invoice.documents.attachments.add(file: Pathname("/path/to/file"))
+
+# Alternatively, pass file contents or a `StringIO` directly:
+document_attachment = e_invoice.documents.attachments.add(file: File.read("/path/to/file"))
+
+# Or, to control the filename and/or content type:
+file =
+  EInvoiceAPI::FilePart.new(File.read("/path/to/file"), filename: "/path/to/file", content_type: "…")
+document_attachment = e_invoice.documents.attachments.add(file: file)
+
+puts(document_attachment.id)
+```
+
+Note that you can also pass a raw `IO` descriptor, but this disables retries, as the library can't be sure if the descriptor is a file or pipe (which cannot be rewound).
+
+### Handling errors
+
+When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `EInvoiceAPI::Errors::APIError` will be thrown:
+
+```ruby
+begin
+  document = e_invoice.documents.create
+rescue EInvoiceAPI::Errors::APIConnectionError => e
+  puts("The server could not be reached")
+  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
+rescue EInvoiceAPI::Errors::RateLimitError => e
+  puts("A 429 status code was received; we should back off a bit.")
+rescue EInvoiceAPI::Errors::APIStatusError => e
+  puts("Another non-200-range status code was received")
+  puts(e.status)
+end
+```
+
+Error codes are as follows:
+
+| Cause            | Error Type                 |
+| ---------------- | -------------------------- |
+| HTTP 400         | `BadRequestError`          |
+| HTTP 401         | `AuthenticationError`      |
+| HTTP 403         | `PermissionDeniedError`    |
+| HTTP 404         | `NotFoundError`            |
+| HTTP 409         | `ConflictError`            |
+| HTTP 422         | `UnprocessableEntityError` |
+| HTTP 429         | `RateLimitError`           |
+| HTTP >= 500      | `InternalServerError`      |
+| Other HTTP error | `APIStatusError`           |
+| Timeout          | `APITimeoutError`          |
+| Network error    | `APIConnectionError`       |
+
+### Retries
+
+Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
+
+Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.
+
+You can use the `max_retries` option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+e_invoice = EInvoiceAPI::Client.new(
+  max_retries: 0 # default is 2
+)
+
+# Or, configure per-request:
+e_invoice.documents.create(request_options: {max_retries: 5})
+```
+
+### Timeouts
+
+By default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+e_invoice = EInvoiceAPI::Client.new(
+  timeout: nil # default is 60
+)
+
+# Or, configure per-request:
+e_invoice.documents.create(request_options: {timeout: 5})
+```
+
+On timeout, `EInvoiceAPI::Errors::APITimeoutError` is raised.
+
+Note that requests that time out are retried by default.
+
+## Advanced concepts
+
+### BaseModel
+
+All parameter and response objects inherit from `EInvoiceAPI::Internal::Type::BaseModel`, which provides several conveniences, including:
+
+1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
+
+2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.
+
+3. Both instances and the classes themselves can be pretty-printed.
+
+4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.
+
+### Making custom or undocumented requests
+
+#### Undocumented properties
+
+You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
+
+Note: the `extra_` parameters of the same name overrides the documented parameters.
+
+```ruby
+document_response =
+  e_invoice.documents.create(
+    request_options: {
+      extra_query: {my_query_parameter: value},
+      extra_body: {my_body_parameter: value},
+      extra_headers: {"my-header": value}
+    }
+  )
+
+puts(document_response[:my_undocumented_property])
+```
+
+#### Undocumented request params
+
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:
+
+```ruby
+response = client.request(
+  method: :post,
+  path: '/undocumented/endpoint',
+  query: {"dog": "woof"},
+  headers: {"useful-header": "interesting-value"},
+  body: {"hello": "world"}
+)
+```
+
+### Concurrency & connection pooling
+
+The `EInvoiceAPI::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
+
+Each instance of `EInvoiceAPI::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
+
+When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.
+
+Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
+
+## Sorbet
+
+This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
+
+You can provide typesafe request parameters like so:
+
+```ruby
+e_invoice.documents.create
+```
+
+Or, equivalently:
+
+```ruby
+# Hashes work, but are not typesafe:
+e_invoice.documents.create
+
+# You can also splat a full Params class:
+params = EInvoiceAPI::DocumentCreateParams.new
+e_invoice.documents.create(**params)
+```
+
+### Enums
+
+Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
+
+```ruby
+# :EUR
+puts(EInvoiceAPI::CurrencyCode::EUR)
+
+# Revealed type: `T.all(EInvoiceAPI::CurrencyCode, Symbol)`
+T.reveal_type(EInvoiceAPI::CurrencyCode::EUR)
+```
+
+Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
+
+```ruby
+# Using the enum constants preserves the tagged type information:
+e_invoice.documents.create(
+  currency: EInvoiceAPI::CurrencyCode::EUR,
+  # …
+)
+
+# Literal values are also permissible:
+e_invoice.documents.create(
+  currency: :EUR,
+  # …
+)
+```
+
+## Versioning
+
+This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.
+
+This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.
+
+## Requirements
+
+Ruby 3.2.0 or higher.
+
+## Contributing
+
+See [the contributing documentation](https://github.com/e-invoice-be/e-invoice-rb/tree/main/CONTRIBUTING.md).

data/SECURITY.md

@@ -0,0 +1,27 @@
+# Security Policy
+
+## Reporting Security Issues
+
+This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
+
+To report a security issue, please contact the Stainless team at security@stainless.com.
+
+## Responsible Disclosure
+
+We appreciate the efforts of security researchers and individuals who help us maintain the security of
+SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
+disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
+before making any information public.
+
+## Reporting Non-SDK Related Security Issues
+
+If you encounter security issues that are not directly related to SDKs but pertain to the services
+or products provided by E Invoice, please follow the respective company's security reporting guidelines.
+
+### E Invoice Terms and Policies
+
+Please contact security@e-invoice.be for any questions or concerns regarding the security of our services.
+
+---
+
+Thank you for helping us keep the SDKs and systems they interact with secure.

data/lib/e_invoice_api/client.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  class Client < EInvoiceAPI::Internal::Transport::BaseClient
+    # Default max number of retries to attempt after a failed retryable request.
+    DEFAULT_MAX_RETRIES = 2
+
+    # Default per-request timeout.
+    DEFAULT_TIMEOUT_IN_SECONDS = 60.0
+
+    # Default initial retry delay in seconds.
+    # Overall delay is calculated using exponential backoff + jitter.
+    DEFAULT_INITIAL_RETRY_DELAY = 0.5
+
+    # Default max retry delay in seconds.
+    DEFAULT_MAX_RETRY_DELAY = 8.0
+
+    # @return [String]
+    attr_reader :api_key
+
+    # @return [EInvoiceAPI::Resources::Documents]
+    attr_reader :documents
+
+    # @return [EInvoiceAPI::Resources::Inbox]
+    attr_reader :inbox
+
+    # @return [EInvoiceAPI::Resources::Outbox]
+    attr_reader :outbox
+
+    # @return [EInvoiceAPI::Resources::Validate]
+    attr_reader :validate
+
+    # @return [EInvoiceAPI::Resources::Lookup]
+    attr_reader :lookup
+
+    # @return [EInvoiceAPI::Resources::Webhooks]
+    attr_reader :webhooks
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      return {} if @api_key.nil?
+
+      {"authorization" => "Bearer #{@api_key}"}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param api_key [String, nil] Defaults to `ENV["E_INVOICE_API_KEY"]`
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["E_INVOICE_BASE_URL"]`
+    #
+    # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
+    #
+    # @param timeout [Float]
+    #
+    # @param initial_retry_delay [Float]
+    #
+    # @param max_retry_delay [Float]
+    def initialize(
+      api_key: ENV["E_INVOICE_API_KEY"],
+      base_url: ENV["E_INVOICE_BASE_URL"],
+      max_retries: self.class::DEFAULT_MAX_RETRIES,
+      timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
+    )
+      base_url ||= "https://api.e-invoice.be"
+
+      if api_key.nil?
+        raise ArgumentError.new("api_key is required, and can be set via environ: \"E_INVOICE_API_KEY\"")
+      end
+
+      @api_key = api_key.to_s
+
+      super(
+        base_url: base_url,
+        timeout: timeout,
+        max_retries: max_retries,
+        initial_retry_delay: initial_retry_delay,
+        max_retry_delay: max_retry_delay
+      )
+
+      @documents = EInvoiceAPI::Resources::Documents.new(client: self)
+      @inbox = EInvoiceAPI::Resources::Inbox.new(client: self)
+      @outbox = EInvoiceAPI::Resources::Outbox.new(client: self)
+      @validate = EInvoiceAPI::Resources::Validate.new(client: self)
+      @lookup = EInvoiceAPI::Resources::Lookup.new(client: self)
+      @webhooks = EInvoiceAPI::Resources::Webhooks.new(client: self)
+    end
+  end
+end

data/lib/e_invoice_api/errors.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Errors
+    class Error < StandardError
+      # @!attribute cause
+      #
+      #   @return [StandardError, nil]
+    end
+
+    class ConversionError < EInvoiceAPI::Errors::Error
+    end
+
+    class APIError < EInvoiceAPI::Errors::Error
+      # @return [URI::Generic]
+      attr_accessor :url
+
+      # @return [Integer, nil]
+      attr_accessor :status
+
+      # @return [Object, nil]
+      attr_accessor :body
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer, nil]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
+        @url = url
+        @status = status
+        @body = body
+        @request = request
+        @response = response
+        super(message)
+      end
+    end
+
+    class APIConnectionError < EInvoiceAPI::Errors::APIError
+      # @!attribute status
+      #
+      #   @return [nil]
+
+      # @!attribute body
+      #
+      #   @return [nil]
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+        super
+      end
+    end
+
+    class APITimeoutError < EInvoiceAPI::Errors::APIConnectionError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
+        super
+      end
+    end
+
+    class APIStatusError < EInvoiceAPI::Errors::APIError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      #
+      # @return [self]
+      def self.for(url:, status:, body:, request:, response:, message: nil)
+        kwargs = {
+          url: url,
+          status: status,
+          body: body,
+          request: request,
+          response: response,
+          message: message
+        }
+
+        case status
+        in 400
+          EInvoiceAPI::Errors::BadRequestError.new(**kwargs)
+        in 401
+          EInvoiceAPI::Errors::AuthenticationError.new(**kwargs)
+        in 403
+          EInvoiceAPI::Errors::PermissionDeniedError.new(**kwargs)
+        in 404
+          EInvoiceAPI::Errors::NotFoundError.new(**kwargs)
+        in 409
+          EInvoiceAPI::Errors::ConflictError.new(**kwargs)
+        in 422
+          EInvoiceAPI::Errors::UnprocessableEntityError.new(**kwargs)
+        in 429
+          EInvoiceAPI::Errors::RateLimitError.new(**kwargs)
+        in (500..)
+          EInvoiceAPI::Errors::InternalServerError.new(**kwargs)
+        else
+          EInvoiceAPI::Errors::APIStatusError.new(**kwargs)
+        end
+      end
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_accessor :status
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status:, body:, request:, response:, message: nil)
+        message ||= {url: url.to_s, status: status, body: body}
+        super(
+          url: url,
+          status: status,
+          body: body,
+          request: request,
+          response: response,
+          message: message&.to_s
+        )
+      end
+    end
+
+    class BadRequestError < EInvoiceAPI::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < EInvoiceAPI::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < EInvoiceAPI::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < EInvoiceAPI::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < EInvoiceAPI::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < EInvoiceAPI::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < EInvoiceAPI::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < EInvoiceAPI::Errors::APIStatusError
+      HTTP_STATUS = (500..)
+    end
+  end
+end