e-invoice-api 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2717245c8c3aa50544bc2b5b5cc22b3e7df3b1243404356d18b9427c7e8237ab
-  data.tar.gz: 13158d3d26f6e2a9f70be7fce58ba3c82dc2d3a5d7f0f36e38ba65fab57dd873
+  metadata.gz: 6f1662511e2c72c61d378f24d8a9070d1afcfddd24d66a9390cdb9c7455336ab
+  data.tar.gz: 87fb923838021213706bbd2d493d8abe7f71e27f3f053b3cda23d397d81518b8
 SHA512:
-  metadata.gz: cfb8a54649b656efcb8de955043f0b75161cbe8484f9ac7243dd51212ef307e8e1982b1960988f97ee9d8e4a4b7ae7a5f42b84ac61d0d1a2169265fa653b9e66
-  data.tar.gz: 63ce2a78bf4f4aa626a0ecea34282074a70340142f87861cb779e7654aaea9a47d4b34edea26fa259da9388ed67f0bf99025467ef3a95b46945948a222ae556a
+  metadata.gz: 1d601e5b569985d5f5d1ce3613765f240e9bf30a872ed9b3840c520d7291e1666dc9b94a64b50ae1e4dc61d8cc70f575ccee08cde5304e7641a728e4480193ef
+  data.tar.gz: 609338c3438489a7cb3edde8afb93828bb2052a23bf2615d6143770307a451a6916d6e19c6c72866e5c21c9b784e197cc4f66fbedfeeec928d2c55023ce700b1

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.8.0 (2025-10-08)
+
+Full Changelog: [v0.7.0...v0.8.0](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.7.0...v0.8.0)
+
+### Features
+
+* **api:** manual updates ([ee38fcc](https://github.com/e-invoice-be/e-invoice-rb/commit/ee38fcc6a7ba81d4a3bc3bc1620ae9cca923da3c))
+
 ## 0.7.0 (2025-10-08)
 
 Full Changelog: [v0.6.0...v0.7.0](https://github.com/e-invoice-be/e-invoice-rb/compare/v0.6.0...v0.7.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "e-invoice-api", "~> 0.7.0"
+gem "e-invoice-api", "~> 0.8.0"
 ```
 
 <!-- x-release-please-end -->
@@ -73,17 +73,17 @@ Request parameters that correspond to file uploads can be passed as raw contents
 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"))
+response = e_invoice.documents.create_from_pdf(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"))
+response = e_invoice.documents.create_from_pdf(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)
+response = e_invoice.documents.create_from_pdf(file: file)
 
-puts(document_attachment.id)
+puts(response.customer_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).

data/lib/e_invoice_api/client.rb

@@ -33,6 +33,9 @@ module EInvoiceAPI
     # @return [EInvoiceAPI::Resources::Lookup]
     attr_reader :lookup
 
+    # @return [EInvoiceAPI::Resources::Me]
+    attr_reader :me
+
     # @return [EInvoiceAPI::Resources::Webhooks]
     attr_reader :webhooks
 
@@ -88,6 +91,7 @@ module EInvoiceAPI
       @outbox = EInvoiceAPI::Resources::Outbox.new(client: self)
       @validate = EInvoiceAPI::Resources::Validate.new(client: self)
       @lookup = EInvoiceAPI::Resources::Lookup.new(client: self)
+      @me = EInvoiceAPI::Resources::Me.new(client: self)
       @webhooks = EInvoiceAPI::Resources::Webhooks.new(client: self)
     end
   end

data/lib/e_invoice_api/internal/type/base_model.rb

@@ -438,11 +438,11 @@ module EInvoiceAPI
         # @return [Hash{Symbol=>Object}]
         #
         # @example
-        #   # `document_attachment_create` is a `EInvoiceAPI::DocumentAttachmentCreate`
-        #   document_attachment_create => {
-        #     file_name: file_name,
-        #     file_data: file_data,
-        #     file_size: file_size
+        #   # `allowance` is a `EInvoiceAPI::Allowance`
+        #   allowance => {
+        #     amount: amount,
+        #     base_amount: base_amount,
+        #     multiplier_factor: multiplier_factor
         #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)

data/lib/e_invoice_api/models/allowance.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Models
+    class Allowance < EInvoiceAPI::Internal::Type::BaseModel
+      # @!attribute amount
+      #   The allowance amount, without VAT. Must be rounded to maximum 2 decimals
+      #
+      #   @return [String, nil]
+      optional :amount, String, nil?: true
+
+      # @!attribute base_amount
+      #   The base amount that may be used, in conjunction with the allowance percentage,
+      #   to calculate the allowance amount. Must be rounded to maximum 2 decimals
+      #
+      #   @return [String, nil]
+      optional :base_amount, String, nil?: true
+
+      # @!attribute multiplier_factor
+      #   The percentage that may be used, in conjunction with the allowance base amount,
+      #   to calculate the allowance amount. To state 20%, use value 20
+      #
+      #   @return [String, nil]
+      optional :multiplier_factor, String, nil?: true
+
+      # @!attribute reason
+      #   The reason for the allowance
+      #
+      #   @return [String, nil]
+      optional :reason, String, nil?: true
+
+      # @!attribute reason_code
+      #   The code for the allowance reason
+      #
+      #   @return [String, nil]
+      optional :reason_code, String, nil?: true
+
+      # @!attribute tax_code
+      #   Duty or tax or fee category codes (Subset of UNCL5305)
+      #
+      #   Agency: UN/CEFACT Version: D.16B Subset: OpenPEPPOL
+      #
+      #   @return [Symbol, EInvoiceAPI::Models::Allowance::TaxCode, nil]
+      optional :tax_code, enum: -> { EInvoiceAPI::Allowance::TaxCode }, nil?: true
+
+      # @!attribute tax_rate
+      #   The VAT rate, represented as percentage that applies to the allowance
+      #
+      #   @return [String, nil]
+      optional :tax_rate, String, nil?: true
+
+      # @!method initialize(amount: nil, base_amount: nil, multiplier_factor: nil, reason: nil, reason_code: nil, tax_code: nil, tax_rate: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {EInvoiceAPI::Models::Allowance} for more details.
+      #
+      #   An allowance is a discount for example for early payment, volume discount, etc.
+      #
+      #   @param amount [String, nil] The allowance amount, without VAT. Must be rounded to maximum 2 decimals
+      #
+      #   @param base_amount [String, nil] The base amount that may be used, in conjunction with the allowance percentage,
+      #
+      #   @param multiplier_factor [String, nil] The percentage that may be used, in conjunction with the allowance base amount,
+      #
+      #   @param reason [String, nil] The reason for the allowance
+      #
+      #   @param reason_code [String, nil] The code for the allowance reason
+      #
+      #   @param tax_code [Symbol, EInvoiceAPI::Models::Allowance::TaxCode, nil] Duty or tax or fee category codes (Subset of UNCL5305)
+      #
+      #   @param tax_rate [String, nil] The VAT rate, represented as percentage that applies to the allowance
+
+      # Duty or tax or fee category codes (Subset of UNCL5305)
+      #
+      # Agency: UN/CEFACT Version: D.16B Subset: OpenPEPPOL
+      #
+      # @see EInvoiceAPI::Models::Allowance#tax_code
+      module TaxCode
+        extend EInvoiceAPI::Internal::Type::Enum
+
+        AE = :AE
+        E = :E
+        S = :S
+        Z = :Z
+        G = :G
+        O = :O
+        K = :K
+        L = :L
+        M = :M
+        B = :B
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/e_invoice_api/models/charge.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Models
+    class Charge < EInvoiceAPI::Internal::Type::BaseModel
+      # @!attribute amount
+      #   The charge amount, without VAT. Must be rounded to maximum 2 decimals
+      #
+      #   @return [String, nil]
+      optional :amount, String, nil?: true
+
+      # @!attribute base_amount
+      #   The base amount that may be used, in conjunction with the charge percentage, to
+      #   calculate the charge amount. Must be rounded to maximum 2 decimals
+      #
+      #   @return [String, nil]
+      optional :base_amount, String, nil?: true
+
+      # @!attribute multiplier_factor
+      #   The percentage that may be used, in conjunction with the charge base amount, to
+      #   calculate the charge amount. To state 20%, use value 20
+      #
+      #   @return [String, nil]
+      optional :multiplier_factor, String, nil?: true
+
+      # @!attribute reason
+      #   The reason for the charge
+      #
+      #   @return [String, nil]
+      optional :reason, String, nil?: true
+
+      # @!attribute reason_code
+      #   The code for the charge reason
+      #
+      #   @return [String, nil]
+      optional :reason_code, String, nil?: true
+
+      # @!attribute tax_code
+      #   Duty or tax or fee category codes (Subset of UNCL5305)
+      #
+      #   Agency: UN/CEFACT Version: D.16B Subset: OpenPEPPOL
+      #
+      #   @return [Symbol, EInvoiceAPI::Models::Charge::TaxCode, nil]
+      optional :tax_code, enum: -> { EInvoiceAPI::Charge::TaxCode }, nil?: true
+
+      # @!attribute tax_rate
+      #   The VAT rate, represented as percentage that applies to the charge
+      #
+      #   @return [String, nil]
+      optional :tax_rate, String, nil?: true
+
+      # @!method initialize(amount: nil, base_amount: nil, multiplier_factor: nil, reason: nil, reason_code: nil, tax_code: nil, tax_rate: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {EInvoiceAPI::Models::Charge} for more details.
+      #
+      #   A charge is an additional fee for example for late payment, late delivery, etc.
+      #
+      #   @param amount [String, nil] The charge amount, without VAT. Must be rounded to maximum 2 decimals
+      #
+      #   @param base_amount [String, nil] The base amount that may be used, in conjunction with the charge percentage, to
+      #
+      #   @param multiplier_factor [String, nil] The percentage that may be used, in conjunction with the charge base amount, to
+      #
+      #   @param reason [String, nil] The reason for the charge
+      #
+      #   @param reason_code [String, nil] The code for the charge reason
+      #
+      #   @param tax_code [Symbol, EInvoiceAPI::Models::Charge::TaxCode, nil] Duty or tax or fee category codes (Subset of UNCL5305)
+      #
+      #   @param tax_rate [String, nil] The VAT rate, represented as percentage that applies to the charge
+
+      # Duty or tax or fee category codes (Subset of UNCL5305)
+      #
+      # Agency: UN/CEFACT Version: D.16B Subset: OpenPEPPOL
+      #
+      # @see EInvoiceAPI::Models::Charge#tax_code
+      module TaxCode
+        extend EInvoiceAPI::Internal::Type::Enum
+
+        AE = :AE
+        E = :E
+        S = :S
+        Z = :Z
+        G = :G
+        O = :O
+        K = :K
+        L = :L
+        M = :M
+        B = :B
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/e_invoice_api/models/document_create_from_pdf_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module EInvoiceAPI
+  module Models
+    # @see EInvoiceAPI::Resources::Documents#create_from_pdf
+    class DocumentCreateFromPdfParams < EInvoiceAPI::Internal::Type::BaseModel
+      extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
+      include EInvoiceAPI::Internal::Type::RequestParameters
+
+      # @!attribute file
+      #
+      #   @return [Pathname, StringIO, IO, String, EInvoiceAPI::FilePart]
+      required :file, EInvoiceAPI::Internal::Type::FileInput
+
+      # @!attribute customer_tax_id
+      #
+      #   @return [String, nil]
+      optional :customer_tax_id, String, nil?: true
+
+      # @!attribute vendor_tax_id
+      #
+      #   @return [String, nil]
+      optional :vendor_tax_id, String, nil?: true
+
+      # @!method initialize(file:, customer_tax_id: nil, vendor_tax_id: nil, request_options: {})
+      #   @param file [Pathname, StringIO, IO, String, EInvoiceAPI::FilePart]
+      #   @param customer_tax_id [String, nil]
+      #   @param vendor_tax_id [String, nil]
+      #   @param request_options [EInvoiceAPI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end