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

data/lib/e_invoice_api/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < EInvoiceAPI::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in EInvoiceAPI::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, EInvoiceAPI::Internal::Type::HashOf[EInvoiceAPI::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, EInvoiceAPI::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, EInvoiceAPI::Internal::Type::HashOf[EInvoiceAPI::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(EInvoiceAPI::RequestOptions, EInvoiceAPI::Internal::AnyHash) }
+    end
+  end
+end

data/lib/e_invoice_api/resources/documents/attachments.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Resources
+    class Documents
+      class Attachments
+        # Get attachment details with for an invoice or credit note with link to download
+        # file (signed URL, valid for 1 hour)
+        #
+        # @overload retrieve(attachment_id, document_id:, request_options: {})
+        #
+        # @param attachment_id [String]
+        # @param document_id [String]
+        # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [EInvoiceAPI::Models::Documents::DocumentAttachment]
+        #
+        # @see EInvoiceAPI::Models::Documents::AttachmentRetrieveParams
+        def retrieve(attachment_id, params)
+          parsed, options = EInvoiceAPI::Documents::AttachmentRetrieveParams.dump_request(params)
+          document_id =
+            parsed.delete(:document_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["api/documents/%1$s/attachments/%2$s", document_id, attachment_id],
+            model: EInvoiceAPI::Documents::DocumentAttachment,
+            options: options
+          )
+        end
+
+        # Get all attachments for an invoice or credit note
+        #
+        # @overload list(document_id, request_options: {})
+        #
+        # @param document_id [String]
+        # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<EInvoiceAPI::Models::Documents::DocumentAttachment>]
+        #
+        # @see EInvoiceAPI::Models::Documents::AttachmentListParams
+        def list(document_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["api/documents/%1$s/attachments", document_id],
+            model: EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::Documents::DocumentAttachment],
+            options: params[:request_options]
+          )
+        end
+
+        # Delete an attachment from an invoice or credit note
+        #
+        # @overload delete(attachment_id, document_id:, request_options: {})
+        #
+        # @param attachment_id [String]
+        # @param document_id [String]
+        # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [EInvoiceAPI::Models::Documents::AttachmentDeleteResponse]
+        #
+        # @see EInvoiceAPI::Models::Documents::AttachmentDeleteParams
+        def delete(attachment_id, params)
+          parsed, options = EInvoiceAPI::Documents::AttachmentDeleteParams.dump_request(params)
+          document_id =
+            parsed.delete(:document_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["api/documents/%1$s/attachments/%2$s", document_id, attachment_id],
+            model: EInvoiceAPI::Models::Documents::AttachmentDeleteResponse,
+            options: options
+          )
+        end
+
+        # Add a new attachment to an invoice or credit note
+        #
+        # @overload add(document_id, file:, request_options: {})
+        #
+        # @param document_id [String]
+        # @param file [Pathname, StringIO, IO, String, EInvoiceAPI::FilePart]
+        # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [EInvoiceAPI::Models::Documents::DocumentAttachment]
+        #
+        # @see EInvoiceAPI::Models::Documents::AttachmentAddParams
+        def add(document_id, params)
+          parsed, options = EInvoiceAPI::Documents::AttachmentAddParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["api/documents/%1$s/attachments", document_id],
+            headers: {"content-type" => "multipart/form-data"},
+            body: parsed,
+            model: EInvoiceAPI::Documents::DocumentAttachment,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [EInvoiceAPI::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/e_invoice_api/resources/documents/ubl.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Resources
+    class Documents
+      class Ubl
+        # Get the UBL for an invoice or credit note
+        #
+        # @overload get(document_id, request_options: {})
+        #
+        # @param document_id [String]
+        # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [EInvoiceAPI::Models::Documents::UblGetResponse]
+        #
+        # @see EInvoiceAPI::Models::Documents::UblGetParams
+        def get(document_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["api/documents/%1$s/ubl", document_id],
+            model: EInvoiceAPI::Models::Documents::UblGetResponse,
+            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/documents.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Resources
+    class Documents
+      # @return [EInvoiceAPI::Resources::Documents::Attachments]
+      attr_reader :attachments
+
+      # @return [EInvoiceAPI::Resources::Documents::Ubl]
+      attr_reader :ubl
+
+      # Create a new invoice or credit note
+      #
+      # @overload create(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::DocumentResponse]
+      #
+      # @see EInvoiceAPI::Models::DocumentCreateParams
+      def create(params = {})
+        parsed, options = EInvoiceAPI::DocumentCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "api/documents/",
+          body: parsed,
+          model: EInvoiceAPI::DocumentResponse,
+          options: options
+        )
+      end
+
+      # Get an invoice or credit note by ID
+      #
+      # @overload retrieve(document_id, request_options: {})
+      #
+      # @param document_id [String]
+      # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [EInvoiceAPI::Models::DocumentResponse]
+      #
+      # @see EInvoiceAPI::Models::DocumentRetrieveParams
+      def retrieve(document_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["api/documents/%1$s", document_id],
+          model: EInvoiceAPI::DocumentResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Delete an invoice or credit note
+      #
+      # @overload delete(document_id, request_options: {})
+      #
+      # @param document_id [String]
+      # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [EInvoiceAPI::Models::DocumentDeleteResponse]
+      #
+      # @see EInvoiceAPI::Models::DocumentDeleteParams
+      def delete(document_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["api/documents/%1$s", document_id],
+          model: EInvoiceAPI::Models::DocumentDeleteResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Send an invoice or credit note via Peppol
+      #
+      # @overload send_(document_id, email: nil, receiver_peppol_id: nil, receiver_peppol_scheme: nil, sender_peppol_id: nil, sender_peppol_scheme: nil, request_options: {})
+      #
+      # @param document_id [String]
+      # @param email [String, nil]
+      # @param receiver_peppol_id [String, nil]
+      # @param receiver_peppol_scheme [String, nil]
+      # @param sender_peppol_id [String, nil]
+      # @param sender_peppol_scheme [String, nil]
+      # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [EInvoiceAPI::Models::DocumentResponse]
+      #
+      # @see EInvoiceAPI::Models::DocumentSendParams
+      def send_(document_id, params = {})
+        parsed, options = EInvoiceAPI::DocumentSendParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["api/documents/%1$s/send", document_id],
+          query: parsed,
+          model: EInvoiceAPI::DocumentResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [EInvoiceAPI::Client]
+      def initialize(client:)
+        @client = client
+        @attachments = EInvoiceAPI::Resources::Documents::Attachments.new(client: client)
+        @ubl = EInvoiceAPI::Resources::Documents::Ubl.new(client: client)
+      end
+    end
+  end
+end

data/lib/e_invoice_api/resources/inbox.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Resources
+    class Inbox
+      # Retrieve a paginated list of received documents with filtering options.
+      #
+      # @overload list(date_from: nil, date_to: nil, page: nil, page_size: nil, search: nil, sender: 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 sender [String, nil] Filter by sender ID
+      #
+      # @param state [Symbol, EInvoiceAPI::Models::DocumentState, nil] Filter by document state
+      #
+      # @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::InboxListParams
+      def list(params = {})
+        parsed, options = EInvoiceAPI::InboxListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/inbox/",
+          query: parsed,
+          page: EInvoiceAPI::Internal::DocumentsNumberPage,
+          model: EInvoiceAPI::DocumentResponse,
+          options: options
+        )
+      end
+
+      # Retrieve a paginated list of received credit notes with filtering options.
+      #
+      # @overload list_credit_notes(page: nil, page_size: nil, request_options: {})
+      #
+      # @param page [Integer] Page number
+      #
+      # @param page_size [Integer] Number of items per page
+      #
+      # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [EInvoiceAPI::Internal::DocumentsNumberPage<EInvoiceAPI::Models::DocumentResponse>]
+      #
+      # @see EInvoiceAPI::Models::InboxListCreditNotesParams
+      def list_credit_notes(params = {})
+        parsed, options = EInvoiceAPI::InboxListCreditNotesParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/inbox/credit-notes",
+          query: parsed,
+          page: EInvoiceAPI::Internal::DocumentsNumberPage,
+          model: EInvoiceAPI::DocumentResponse,
+          options: options
+        )
+      end
+
+      # Retrieve a paginated list of received invoices with filtering options.
+      #
+      # @overload list_invoices(page: nil, page_size: nil, request_options: {})
+      #
+      # @param page [Integer] Page number
+      #
+      # @param page_size [Integer] Number of items per page
+      #
+      # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [EInvoiceAPI::Internal::DocumentsNumberPage<EInvoiceAPI::Models::DocumentResponse>]
+      #
+      # @see EInvoiceAPI::Models::InboxListInvoicesParams
+      def list_invoices(params = {})
+        parsed, options = EInvoiceAPI::InboxListInvoicesParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/inbox/invoices",
+          query: parsed,
+          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

data/lib/e_invoice_api/resources/lookup.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Resources
+    class Lookup
+      # Some parameter documentations has been truncated, see
+      # {EInvoiceAPI::Models::LookupRetrieveParams} for more details.
+      #
+      # 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).
+      #
+      # @overload retrieve(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::LookupRetrieveResponse]
+      #
+      # @see EInvoiceAPI::Models::LookupRetrieveParams
+      def retrieve(params)
+        parsed, options = EInvoiceAPI::LookupRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/lookup",
+          query: parsed,
+          model: EInvoiceAPI::Models::LookupRetrieveResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [EInvoiceAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/e_invoice_api/resources/outbox.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Resources
+    class Outbox
+      # Retrieve a paginated list of draft documents with filtering options.
+      #
+      # @overload list_draft_documents(page: nil, page_size: nil, request_options: {})
+      #
+      # @param page [Integer] Page number
+      #
+      # @param page_size [Integer] Number of items per page
+      #
+      # @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [EInvoiceAPI::Internal::DocumentsNumberPage<EInvoiceAPI::Models::DocumentResponse>]
+      #
+      # @see EInvoiceAPI::Models::OutboxListDraftDocumentsParams
+      def list_draft_documents(params = {})
+        parsed, options = EInvoiceAPI::OutboxListDraftDocumentsParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/outbox/drafts",
+          query: parsed,
+          page: EInvoiceAPI::Internal::DocumentsNumberPage,
+          model: EInvoiceAPI::DocumentResponse,
+          options: options
+        )
+      end
+
+      # Retrieve a paginated list of received documents with filtering options.
+      #
+      # @overload list_received_documents(date_from: nil, date_to: nil, page: nil, page_size: nil, search: nil, sender: 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 sender [String, nil] Filter by sender ID
+      #
+      # @param state [Symbol, EInvoiceAPI::Models::DocumentState, nil] Filter by document state
+      #
+      # @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::OutboxListReceivedDocumentsParams
+      def list_received_documents(params = {})
+        parsed, options = EInvoiceAPI::OutboxListReceivedDocumentsParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "api/outbox/",
+          query: parsed,
+          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