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

data/lib/e_invoice_api/resources/validate.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Resources
+    class Validate
+      # Validate if the JSON document can be converted to a valid UBL document
+      #
+      # @overload validate_json(amount_due: nil, attachments: nil, billing_address: nil, billing_address_recipient: nil, 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: {})
+      #
+      # @param amount_due [Float, String, nil]
+      #
+      # @param attachments [Array<EInvoiceAPI::Models::DocumentAttachmentCreate>, nil]
+      #
+      # @param billing_address [String, nil]
+      #
+      # @param billing_address_recipient [String, nil]
+      #
+      # @param currency [Symbol, EInvoiceAPI::Models::CurrencyCode] Currency of the invoice
+      #
+      # @param customer_address [String, nil]
+      #
+      # @param customer_address_recipient [String, nil]
+      #
+      # @param customer_email [String, nil]
+      #
+      # @param customer_id [String, nil]
+      #
+      # @param customer_name [String, nil]
+      #
+      # @param customer_tax_id [String, nil]
+      #
+      # @param direction [Symbol, EInvoiceAPI::Models::DocumentDirection]
+      #
+      # @param document_type [Symbol, EInvoiceAPI::Models::DocumentType]
+      #
+      # @param due_date [Date, nil]
+      #
+      # @param invoice_date [Date, nil]
+      #
+      # @param invoice_id [String, nil]
+      #
+      # @param invoice_total [Float, String, nil]
+      #
+      # @param items [Array<EInvoiceAPI::Models::DocumentCreate::Item>, nil]
+      #
+      # @param note [String, nil]
+      #
+      # @param payment_details [Array<EInvoiceAPI::Models::PaymentDetailCreate>, nil]
+      #
+      # @param payment_term [String, nil]
+      #
+      # @param previous_unpaid_balance [Float, String, nil]
+      #
+      # @param purchase_order [String, nil]
+      #
+      # @param remittance_address [String, nil]
+      #
+      # @param remittance_address_recipient [String, nil]
+      #
+      # @param service_address [String, nil]
+      #
+      # @param service_address_recipient [String, nil]
+      #
+      # @param service_end_date [Date, nil]
+      #
+      # @param service_start_date [Date, nil]
+      #
+      # @param shipping_address [String, nil]
+      #
+      # @param shipping_address_recipient [String, nil]
+      #
+      # @param state [Symbol, EInvoiceAPI::Models::DocumentState]
+      #
+      # @param subtotal [Float, String, nil]
+      #
+      # @param tax_details [Array<EInvoiceAPI::Models::DocumentCreate::TaxDetail>, nil]
+      #
+      # @param total_discount [Float, String, nil]
+      #
+      # @param total_tax [Float, String, nil]
+      #
+      # @param vendor_address [String, nil]
+      #
+      # @param vendor_address_recipient [String, nil]
+      #
+      # @param vendor_email [String, nil]
+      #
+      # @param vendor_name [String, nil]
+      #
+      # @param vendor_tax_id [String, nil]
+      #
+      # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [EInvoiceAPI::Models::UblDocumentValidation]
+      #
+      # @see EInvoiceAPI::Models::ValidateValidateJsonParams
+      def validate_json(params = {})
+        parsed, options = EInvoiceAPI::ValidateValidateJsonParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/validate/json",
+          body: parsed,
+          model: EInvoiceAPI::UblDocumentValidation,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {EInvoiceAPI::Models::ValidateValidatePeppolIDParams} for more details.
+      #
+      # 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).
+      #
+      # @overload validate_peppol_id(peppol_id:, request_options: {})
+      #
+      # @param peppol_id [String] Peppol ID in the format `<scheme>:<id>`. Example: `0208:1018265814` for a Belgia
+      #
+      # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [EInvoiceAPI::Models::ValidateValidatePeppolIDResponse]
+      #
+      # @see EInvoiceAPI::Models::ValidateValidatePeppolIDParams
+      def validate_peppol_id(params)
+        parsed, options = EInvoiceAPI::ValidateValidatePeppolIDParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/validate/peppol-id",
+          query: parsed,
+          model: EInvoiceAPI::Models::ValidateValidatePeppolIDResponse,
+          options: options
+        )
+      end
+
+      # Validate the correctness of a UBL document
+      #
+      # @overload validate_ubl(file:, request_options: {})
+      #
+      # @param file [Pathname, StringIO, IO, String, EInvoiceAPI::FilePart]
+      # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [EInvoiceAPI::Models::UblDocumentValidation]
+      #
+      # @see EInvoiceAPI::Models::ValidateValidateUblParams
+      def validate_ubl(params)
+        parsed, options = EInvoiceAPI::ValidateValidateUblParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/validate/ubl",
+          headers: {"content-type" => "multipart/form-data"},
+          body: parsed,
+          model: EInvoiceAPI::UblDocumentValidation,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [EInvoiceAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/e_invoice_api/resources/webhooks.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Resources
+    class Webhooks
+      # Create a new webhook
+      #
+      # @overload create(events:, url:, enabled: nil, request_options: {})
+      #
+      # @param events [Array<String>]
+      # @param url [String]
+      # @param enabled [Boolean]
+      # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [EInvoiceAPI::Models::WebhookResponse]
+      #
+      # @see EInvoiceAPI::Models::WebhookCreateParams
+      def create(params)
+        parsed, options = EInvoiceAPI::WebhookCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/webhooks/",
+          body: parsed,
+          model: EInvoiceAPI::WebhookResponse,
+          options: options
+        )
+      end
+
+      # Get a webhook by ID
+      #
+      # @overload retrieve(webhook_id, request_options: {})
+      #
+      # @param webhook_id [String]
+      # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [EInvoiceAPI::Models::WebhookResponse]
+      #
+      # @see EInvoiceAPI::Models::WebhookRetrieveParams
+      def retrieve(webhook_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/webhooks/%1$s", webhook_id],
+          model: EInvoiceAPI::WebhookResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Update a webhook by ID
+      #
+      # @overload update(webhook_id, enabled: nil, events: nil, url: nil, request_options: {})
+      #
+      # @param webhook_id [String]
+      # @param enabled [Boolean, nil]
+      # @param events [Array<String>, nil]
+      # @param url [String, nil]
+      # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [EInvoiceAPI::Models::WebhookResponse]
+      #
+      # @see EInvoiceAPI::Models::WebhookUpdateParams
+      def update(webhook_id, params = {})
+        parsed, options = EInvoiceAPI::WebhookUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["api/webhooks/%1$s", webhook_id],
+          body: parsed,
+          model: EInvoiceAPI::WebhookResponse,
+          options: options
+        )
+      end
+
+      # Get all webhooks for the current tenant
+      #
+      # @overload list(request_options: {})
+      #
+      # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<EInvoiceAPI::Models::WebhookResponse>]
+      #
+      # @see EInvoiceAPI::Models::WebhookListParams
+      def list(params = {})
+        @client.request(
+          method: :get,
+          path: "api/webhooks/",
+          model: EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::WebhookResponse],
+          options: params[:request_options]
+        )
+      end
+
+      # Delete a webhook
+      #
+      # @overload delete(webhook_id, request_options: {})
+      #
+      # @param webhook_id [String]
+      # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [EInvoiceAPI::Models::WebhookDeleteResponse]
+      #
+      # @see EInvoiceAPI::Models::WebhookDeleteParams
+      def delete(webhook_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["api/webhooks/%1$s", webhook_id],
+          model: EInvoiceAPI::Models::WebhookDeleteResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [EInvoiceAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/e_invoice_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  VERSION = "0.1.0.pre.alpha.5"
+end

data/lib/e_invoice_api.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "e_invoice_api/version"
+require_relative "e_invoice_api/internal/util"
+require_relative "e_invoice_api/internal/type/converter"
+require_relative "e_invoice_api/internal/type/unknown"
+require_relative "e_invoice_api/internal/type/boolean"
+require_relative "e_invoice_api/internal/type/file_input"
+require_relative "e_invoice_api/internal/type/enum"
+require_relative "e_invoice_api/internal/type/union"
+require_relative "e_invoice_api/internal/type/array_of"
+require_relative "e_invoice_api/internal/type/hash_of"
+require_relative "e_invoice_api/internal/type/base_model"
+require_relative "e_invoice_api/internal/type/base_page"
+require_relative "e_invoice_api/internal/type/request_parameters"
+require_relative "e_invoice_api/internal"
+require_relative "e_invoice_api/request_options"
+require_relative "e_invoice_api/file_part"
+require_relative "e_invoice_api/errors"
+require_relative "e_invoice_api/internal/transport/base_client"
+require_relative "e_invoice_api/internal/transport/pooled_net_requester"
+require_relative "e_invoice_api/client"
+require_relative "e_invoice_api/internal/documents_number_page"
+require_relative "e_invoice_api/models/document_create"
+require_relative "e_invoice_api/models/certificate"
+require_relative "e_invoice_api/models/currency_code"
+require_relative "e_invoice_api/models/document_attachment_create"
+require_relative "e_invoice_api/models/document_create_params"
+require_relative "e_invoice_api/models/document_delete_params"
+require_relative "e_invoice_api/models/document_delete_response"
+require_relative "e_invoice_api/models/document_direction"
+require_relative "e_invoice_api/models/document_response"
+require_relative "e_invoice_api/models/document_retrieve_params"
+require_relative "e_invoice_api/models/documents/attachment_add_params"
+require_relative "e_invoice_api/models/documents/attachment_delete_params"
+require_relative "e_invoice_api/models/documents/attachment_delete_response"
+require_relative "e_invoice_api/models/documents/attachment_list_params"
+require_relative "e_invoice_api/models/documents/attachment_list_response"
+require_relative "e_invoice_api/models/documents/attachment_retrieve_params"
+require_relative "e_invoice_api/models/documents/document_attachment"
+require_relative "e_invoice_api/models/documents/ubl_get_params"
+require_relative "e_invoice_api/models/documents/ubl_get_response"
+require_relative "e_invoice_api/models/document_send_params"
+require_relative "e_invoice_api/models/document_state"
+require_relative "e_invoice_api/models/document_type"
+require_relative "e_invoice_api/models/inbox_list_credit_notes_params"
+require_relative "e_invoice_api/models/inbox_list_invoices_params"
+require_relative "e_invoice_api/models/inbox_list_params"
+require_relative "e_invoice_api/models/lookup_retrieve_params"
+require_relative "e_invoice_api/models/lookup_retrieve_response"
+require_relative "e_invoice_api/models/outbox_list_draft_documents_params"
+require_relative "e_invoice_api/models/outbox_list_received_documents_params"
+require_relative "e_invoice_api/models/paginated_document_response"
+require_relative "e_invoice_api/models/payment_detail_create"
+require_relative "e_invoice_api/models/ubl_document_validation"
+require_relative "e_invoice_api/models/unit_of_measure_code"
+require_relative "e_invoice_api/models/validate_validate_json_params"
+require_relative "e_invoice_api/models/validate_validate_peppol_id_params"
+require_relative "e_invoice_api/models/validate_validate_peppol_id_response"
+require_relative "e_invoice_api/models/validate_validate_ubl_params"
+require_relative "e_invoice_api/models/webhook_create_params"
+require_relative "e_invoice_api/models/webhook_delete_params"
+require_relative "e_invoice_api/models/webhook_delete_response"
+require_relative "e_invoice_api/models/webhook_list_params"
+require_relative "e_invoice_api/models/webhook_list_response"
+require_relative "e_invoice_api/models/webhook_response"
+require_relative "e_invoice_api/models/webhook_retrieve_params"
+require_relative "e_invoice_api/models/webhook_update_params"
+require_relative "e_invoice_api/models"
+require_relative "e_invoice_api/resources/documents"
+require_relative "e_invoice_api/resources/documents/attachments"
+require_relative "e_invoice_api/resources/documents/ubl"
+require_relative "e_invoice_api/resources/inbox"
+require_relative "e_invoice_api/resources/lookup"
+require_relative "e_invoice_api/resources/outbox"
+require_relative "e_invoice_api/resources/validate"
+require_relative "e_invoice_api/resources/webhooks"

data/manifest.yaml

@@ -0,0 +1,15 @@
+dependencies:
+  - English
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri

data/rbi/e_invoice_api/client.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module EInvoiceAPI
+  class Client < EInvoiceAPI::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    sig { returns(String) }
+    attr_reader :api_key
+
+    sig { returns(EInvoiceAPI::Resources::Documents) }
+    attr_reader :documents
+
+    sig { returns(EInvoiceAPI::Resources::Inbox) }
+    attr_reader :inbox
+
+    sig { returns(EInvoiceAPI::Resources::Outbox) }
+    attr_reader :outbox
+
+    sig { returns(EInvoiceAPI::Resources::Validate) }
+    attr_reader :validate
+
+    sig { returns(EInvoiceAPI::Resources::Lookup) }
+    attr_reader :lookup
+
+    sig { returns(EInvoiceAPI::Resources::Webhooks) }
+    attr_reader :webhooks
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        api_key: T.nilable(String),
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      ).returns(T.attached_class)
+    end
+    def self.new(
+      # Defaults to `ENV["E_INVOICE_API_KEY"]`
+      api_key: ENV["E_INVOICE_API_KEY"],
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["E_INVOICE_BASE_URL"]`
+      base_url: ENV["E_INVOICE_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: EInvoiceAPI::Client::DEFAULT_MAX_RETRIES,
+      timeout: EInvoiceAPI::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: EInvoiceAPI::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: EInvoiceAPI::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end

data/rbi/e_invoice_api/errors.rbi

@@ -0,0 +1,162 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Errors
+    class Error < StandardError
+      sig { returns(T.nilable(StandardError)) }
+      attr_accessor :cause
+    end
+
+    class ConversionError < EInvoiceAPI::Errors::Error
+    end
+
+    class APIError < EInvoiceAPI::Errors::Error
+      sig { returns(URI::Generic) }
+      attr_accessor :url
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :status
+
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: T.nilable(Integer),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: nil
+      )
+      end
+    end
+
+    class APIConnectionError < EInvoiceAPI::Errors::APIError
+      sig { void }
+      attr_accessor :status
+
+      sig { void }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+      end
+    end
+
+    class APITimeoutError < EInvoiceAPI::Errors::APIConnectionError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
+      end
+    end
+
+    class APIStatusError < EInvoiceAPI::Errors::APIError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.for(url:, status:, body:, request:, response:, message: nil)
+      end
+
+      sig { returns(Integer) }
+      attr_accessor :status
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(url:, status:, body:, request:, response:, message: nil)
+      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 = T.let((500..), T::Range[Integer])
+    end
+  end
+end

data/rbi/e_invoice_api/file_part.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module EInvoiceAPI
+  class FilePart
+    sig { returns(T.any(Pathname, StringIO, IO, String)) }
+    attr_reader :content
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :content_type
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :filename
+
+    # @api private
+    sig { returns(String) }
+    private def read
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_json(*a)
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_yaml(*a)
+    end
+
+    sig do
+      params(
+        content: T.any(Pathname, StringIO, IO, String),
+        filename: T.nilable(String),
+        content_type: T.nilable(String)
+      ).returns(T.attached_class)
+    end
+    def self.new(content, filename: nil, content_type: nil)
+    end
+  end
+end