nordlet 0.5.5 → 0.5.7

data/lib/nordlet/partners/types/update_partners_request_invoice_currency.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Partners
+    module Types
+      module UpdatePartnersRequestInvoiceCurrency
+        extend Nordlet::Internal::Types::Enum
+
+        EUR = "EUR"
+        USD = "USD"
+        GBP = "GBP"
+        PLN = "PLN"
+        SEK = "SEK"
+        NOK = "NOK"
+        DKK = "DKK"
+        CHF = "CHF"
+        CZK = "CZK"
+        HUF = "HUF"
+        RON = "RON"
+        AED = "AED"
+        AFN = "AFN"
+        ALL = "ALL"
+        AMD = "AMD"
+        ARS = "ARS"
+        AUD = "AUD"
+        AZN = "AZN"
+        BAM = "BAM"
+        BDT = "BDT"
+        BHD = "BHD"
+        BOB = "BOB"
+        BRL = "BRL"
+        BYN = "BYN"
+        CAD = "CAD"
+        CLP = "CLP"
+        CNY = "CNY"
+        COP = "COP"
+        DJF = "DJF"
+        DZD = "DZD"
+        EGP = "EGP"
+        ETB = "ETB"
+        GEL = "GEL"
+        GNF = "GNF"
+        HKD = "HKD"
+        IDR = "IDR"
+        ILS = "ILS"
+        INR = "INR"
+        IQD = "IQD"
+        IRR = "IRR"
+        ISK = "ISK"
+        JOD = "JOD"
+        JPY = "JPY"
+        KES = "KES"
+        KGS = "KGS"
+        KRW = "KRW"
+        KWD = "KWD"
+        KZT = "KZT"
+        LBP = "LBP"
+        LKR = "LKR"
+        LYD = "LYD"
+        MAD = "MAD"
+        MDL = "MDL"
+        MGA = "MGA"
+        MKD = "MKD"
+        MNT = "MNT"
+        MXN = "MXN"
+        MYR = "MYR"
+        MZN = "MZN"
+        NZD = "NZD"
+        PAB = "PAB"
+        PEN = "PEN"
+        PHP = "PHP"
+        PKR = "PKR"
+        QAR = "QAR"
+        RSD = "RSD"
+        SAR = "SAR"
+        SGD = "SGD"
+        SYP = "SYP"
+        THB = "THB"
+        TJS = "TJS"
+        TMT = "TMT"
+        TND = "TND"
+        TRY = "TRY"
+        TWD = "TWD"
+        TZS = "TZS"
+        UAH = "UAH"
+        UYU = "UYU"
+        UZS = "UZS"
+        VES = "VES"
+        VND = "VND"
+        XAF = "XAF"
+        XOF = "XOF"
+        YER = "YER"
+        ZAR = "ZAR"
+      end
+    end
+  end
+end

data/lib/nordlet/partners/types/update_partners_request_invoice_locale.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Partners
+    module Types
+      module UpdatePartnersRequestInvoiceLocale
+        extend Nordlet::Internal::Types::Enum
+
+        EN = "en"
+        LT = "lt"
+        DE = "de"
+        FR = "fr"
+        ES = "es"
+        IT = "it"
+        PT = "pt"
+        NL = "nl"
+        PL = "pl"
+        SV = "sv"
+        DA = "da"
+        NO = "no"
+        FI = "fi"
+        ET = "et"
+        LV = "lv"
+        CS = "cs"
+        SK = "sk"
+        HU = "hu"
+        RO = "ro"
+        BG = "bg"
+        HR = "hr"
+        SL = "sl"
+        EL = "el"
+        MT = "mt"
+        IS = "is"
+        GA = "ga"
+        ZH = "zh"
+        JA = "ja"
+        AR = "ar"
+        HI = "hi"
+        RU = "ru"
+        TR = "tr"
+      end
+    end
+  end
+end

data/lib/nordlet/partners/types/update_partners_response.rb

@@ -30,6 +30,10 @@ module Nordlet
 
         field :payment_term_days, -> { Integer }, optional: false, nullable: true, api_name: "paymentTermDays"
 
+        field :invoice_currency, -> { String }, optional: false, nullable: true, api_name: "invoiceCurrency"
+
+        field :invoice_locale, -> { String }, optional: false, nullable: true, api_name: "invoiceLocale"
+
         field :credit_limit, -> { String }, optional: false, nullable: true, api_name: "creditLimit"
 
         field :price_list_id, -> { String }, optional: false, nullable: true, api_name: "priceListId"

data/lib/nordlet/public/client.rb

@@ -48,8 +48,8 @@ module Nordlet
       # Redirect (302) to the company's payment page for the issued invoice that carries this payment token, rendered
       # from the template set with `sales/invoices/payment-settings/update` with the invoice number, the amount still
       # unpaid, the currency, the token, the invoice id and the customer name (see `sales/invoices/payment-link`).
-      # Answers 404 when the token matches no issued invoice or the company has no template, and 409 when the invoice is
-      # already paid.
+      # Answers 404 when the token matches no issued invoice, the invoice has `payLinkEnabled` false or the company has
+      # no template, and 409 when the invoice is already paid.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -80,6 +80,115 @@ module Nordlet
         error_class = Nordlet::Errors::ResponseError.subclass_for_code(code)
         raise error_class.new(response.body, code: code)
       end
+
+      # Return the issued sale document that carries this customer token (`token` of `sales/invoices/view`), in the
+      # shape of `sales/invoices/view` without the token. Answers 404 when the token matches no issued document.
+      #
+      # @param request_options [Hash]
+      # @param params [Nordlet::Public::Types::InvoicesGetPublicRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
+      # @return [Nordlet::Public::Types::InvoicesGetPublicResponse]
+      def invoices_get(request_options: {}, **params)
+        params = Nordlet::Internal::Types::Utils.normalize_keys(params)
+        request = Nordlet::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v1/public/invoices/get",
+          body: Nordlet::Public::Types::InvoicesGetPublicRequest.new(params).to_h,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Nordlet::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Nordlet::Public::Types::InvoicesGetPublicResponse.load(response.body)
+        else
+          error_class = Nordlet::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Open a Stripe Checkout page on the company's connected Stripe account for the amount still unpaid on the issued
+      # invoice that carries this customer token, and return its `url`. Stripe sends the customer back to the public
+      # invoice page. Answers 404 when the token matches no issued invoice, the invoice has `payLinkEnabled` false or
+      # the company has no Stripe account that can take charges, 409 when the invoice is already paid and 422 when
+      # Stripe cannot take the amount in the invoice currency.
+      #
+      # @param request_options [Hash]
+      # @param params [Nordlet::Public::Types::InvoicesCheckoutPublicRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
+      # @return [Nordlet::Public::Types::InvoicesCheckoutPublicResponse]
+      def invoices_checkout(request_options: {}, **params)
+        params = Nordlet::Internal::Types::Utils.normalize_keys(params)
+        request = Nordlet::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v1/public/invoices/checkout",
+          body: Nordlet::Public::Types::InvoicesCheckoutPublicRequest.new(params).to_h,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Nordlet::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Nordlet::Public::Types::InvoicesCheckoutPublicResponse.load(response.body)
+        else
+          error_class = Nordlet::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Return the PDF of the issued sale document that carries this customer token, base64-encoded, as
+      # `sales/invoices/pdf` renders it in the document's own language, English when it has none. Answers 404 when the
+      # token matches no issued document.
+      #
+      # @param request_options [Hash]
+      # @param params [Nordlet::Public::Types::InvoicesPdfPublicRequest]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
+      # @return [Nordlet::Public::Types::InvoicesPdfPublicResponse]
+      def invoices_pdf(request_options: {}, **params)
+        params = Nordlet::Internal::Types::Utils.normalize_keys(params)
+        request = Nordlet::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v1/public/invoices/pdf",
+          body: Nordlet::Public::Types::InvoicesPdfPublicRequest.new(params).to_h,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Nordlet::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Nordlet::Public::Types::InvoicesPdfPublicResponse.load(response.body)
+        else
+          error_class = Nordlet::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
     end
   end
 end

data/lib/nordlet/public/types/invoices_checkout_public_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Public
+    module Types
+      class InvoicesCheckoutPublicRequest < Internal::Types::Model
+        field :token, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/nordlet/public/types/invoices_checkout_public_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Public
+    module Types
+      class InvoicesCheckoutPublicResponse < Internal::Types::Model
+        field :url, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/nordlet/public/types/invoices_get_public_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Public
+    module Types
+      class InvoicesGetPublicRequest < Internal::Types::Model
+        field :token, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/nordlet/public/types/invoices_get_public_response.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Public
+    module Types
+      class InvoicesGetPublicResponse < Internal::Types::Model
+        field :type, -> { Nordlet::Public::Types::InvoicesGetPublicResponseType }, optional: false, nullable: false
+
+        field :status, -> { Nordlet::Public::Types::InvoicesGetPublicResponseStatus }, optional: false, nullable: false
+
+        field :payment_status, -> { Nordlet::Public::Types::InvoicesGetPublicResponsePaymentStatus }, optional: false, nullable: false, api_name: "paymentStatus"
+
+        field :number, -> { String }, optional: false, nullable: true
+
+        field :issue_date, -> { String }, optional: false, nullable: true, api_name: "issueDate"
+
+        field :due_date, -> { String }, optional: false, nullable: true, api_name: "dueDate"
+
+        field :currency, -> { String }, optional: false, nullable: false
+
+        field :net_total, -> { String }, optional: false, nullable: false, api_name: "netTotal"
+
+        field :vat_total, -> { String }, optional: false, nullable: false, api_name: "vatTotal"
+
+        field :sales_tax_percent, -> { String }, optional: false, nullable: true, api_name: "salesTaxPercent"
+
+        field :sales_tax_total, -> { String }, optional: false, nullable: false, api_name: "salesTaxTotal"
+
+        field :gross_total, -> { String }, optional: false, nullable: false, api_name: "grossTotal"
+
+        field :paid_amount, -> { String }, optional: false, nullable: false, api_name: "paidAmount"
+
+        field :paid_on, -> { String }, optional: false, nullable: true, api_name: "paidOn"
+
+        field :notes, -> { String }, optional: false, nullable: true
+
+        field :pay_url, -> { String }, optional: false, nullable: true, api_name: "payUrl"
+
+        field :seller, -> { Nordlet::Public::Types::InvoicesGetPublicResponseSeller }, optional: false, nullable: false
+
+        field :buyer, -> { Nordlet::Public::Types::InvoicesGetPublicResponseBuyer }, optional: false, nullable: false
+
+        field :lines, -> { Internal::Types::Array[Nordlet::Public::Types::InvoicesGetPublicResponseLinesItem] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/nordlet/public/types/invoices_get_public_response_buyer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Public
+    module Types
+      class InvoicesGetPublicResponseBuyer < Internal::Types::Model
+        field :name, -> { String }, optional: false, nullable: false
+
+        field :vat_code, -> { String }, optional: false, nullable: true, api_name: "vatCode"
+
+        field :address, -> { Nordlet::Public::Types::InvoicesGetPublicResponseBuyerAddress }, optional: false, nullable: false
+
+        field :email, -> { String }, optional: false, nullable: true
+      end
+    end
+  end
+end

data/lib/nordlet/public/types/invoices_get_public_response_buyer_address.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Public
+    module Types
+      class InvoicesGetPublicResponseBuyerAddress < Internal::Types::Model
+        field :street, -> { String }, optional: false, nullable: true
+
+        field :city, -> { String }, optional: false, nullable: true
+
+        field :postal_code, -> { String }, optional: false, nullable: true, api_name: "postalCode"
+
+        field :country_code, -> { String }, optional: false, nullable: true, api_name: "countryCode"
+      end
+    end
+  end
+end

data/lib/nordlet/public/types/invoices_get_public_response_lines_item.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Public
+    module Types
+      class InvoicesGetPublicResponseLinesItem < Internal::Types::Model
+        field :description, -> { String }, optional: false, nullable: false
+
+        field :unit, -> { String }, optional: false, nullable: false
+
+        field :quantity, -> { String }, optional: false, nullable: false
+
+        field :unit_price, -> { String }, optional: false, nullable: true, api_name: "unitPrice"
+
+        field :vat_rate_percent, -> { String }, optional: false, nullable: false, api_name: "vatRatePercent"
+
+        field :line_net, -> { String }, optional: false, nullable: false, api_name: "lineNet"
+      end
+    end
+  end
+end

data/lib/nordlet/public/types/invoices_get_public_response_payment_status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Public
+    module Types
+      module InvoicesGetPublicResponsePaymentStatus
+        extend Nordlet::Internal::Types::Enum
+
+        UNPAID = "unpaid"
+        PARTIAL = "partial"
+        PAID = "paid"
+      end
+    end
+  end
+end

data/lib/nordlet/public/types/invoices_get_public_response_seller.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Public
+    module Types
+      class InvoicesGetPublicResponseSeller < Internal::Types::Model
+        field :name, -> { String }, optional: false, nullable: false
+
+        field :vat_code, -> { String }, optional: false, nullable: true, api_name: "vatCode"
+
+        field :country_code, -> { String }, optional: false, nullable: true, api_name: "countryCode"
+
+        field :address, -> { Nordlet::Public::Types::InvoicesGetPublicResponseSellerAddress }, optional: false, nullable: false
+
+        field :email, -> { String }, optional: false, nullable: true
+
+        field :iban, -> { String }, optional: false, nullable: true
+
+        field :bank_name, -> { String }, optional: false, nullable: true, api_name: "bankName"
+
+        field :bank_bic, -> { String }, optional: false, nullable: true, api_name: "bankBic"
+
+        field :bank_code, -> { String }, optional: false, nullable: true, api_name: "bankCode"
+
+        field :bank_branch_code, -> { String }, optional: false, nullable: true, api_name: "bankBranchCode"
+
+        field :bank_account_number, -> { String }, optional: false, nullable: true, api_name: "bankAccountNumber"
+      end
+    end
+  end
+end

data/lib/nordlet/public/types/invoices_get_public_response_seller_address.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Public
+    module Types
+      class InvoicesGetPublicResponseSellerAddress < Internal::Types::Model
+        field :street, -> { String }, optional: false, nullable: true
+
+        field :city, -> { String }, optional: false, nullable: true
+
+        field :postal_code, -> { String }, optional: false, nullable: true, api_name: "postalCode"
+
+        field :country_code, -> { String }, optional: false, nullable: true, api_name: "countryCode"
+      end
+    end
+  end
+end

data/lib/nordlet/public/types/invoices_get_public_response_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Public
+    module Types
+      module InvoicesGetPublicResponseStatus
+        extend Nordlet::Internal::Types::Enum
+
+        DRAFT = "draft"
+        ISSUED = "issued"
+      end
+    end
+  end
+end

data/lib/nordlet/public/types/invoices_get_public_response_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Public
+    module Types
+      module InvoicesGetPublicResponseType
+        extend Nordlet::Internal::Types::Enum
+
+        INVOICE = "invoice"
+        CREDIT_NOTE = "credit_note"
+        PROFORMA = "proforma"
+        ADVANCE = "advance"
+      end
+    end
+  end
+end

data/lib/nordlet/public/types/invoices_pdf_public_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Public
+    module Types
+      class InvoicesPdfPublicRequest < Internal::Types::Model
+        field :token, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/nordlet/public/types/invoices_pdf_public_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Nordlet
+  module Public
+    module Types
+      class InvoicesPdfPublicResponse < Internal::Types::Model
+        field :file_name, -> { String }, optional: false, nullable: false, api_name: "fileName"
+
+        field :content_type, -> { String }, optional: false, nullable: false, api_name: "contentType"
+
+        field :data, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end