voltaria_sdk 2.34.5

data/lib/voltaria/errors/timeout_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Errors
+    class TimeoutError < ApiError
+    end
+  end
+end

data/lib/voltaria/installments/client.rb

@@ -0,0 +1,292 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Installments
+    class Client
+      # @param client [Voltaria::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Retrieve a list of all loan installments under your partner account. Supports optional filtering by loan or
+      # client.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @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
+      # @option params [Integer, nil] :page
+      # @option params [Integer, nil] :page_size
+      # @option params [String, nil] :client_id
+      # @option params [String, nil] :loan_id
+      # @option params [String, nil] :order_by
+      # @option params [String, nil] :q
+      #
+      # @return [Voltaria::Types::PaginatedResponseInstallmentResponseWithClientInfo]
+      def list_installments(request_options: {}, **params)
+        params = Voltaria::Internal::Types::Utils.normalize_keys(params)
+        query_param_names = %i[page page_size client_id loan_id order_by q]
+        query_params = {}
+        query_params["page"] = params[:page] if params.key?(:page)
+        query_params["page_size"] = params[:page_size] if params.key?(:page_size)
+        query_params["client_id"] = params[:client_id] if params.key?(:client_id)
+        query_params["loan_id"] = params[:loan_id] if params.key?(:loan_id)
+        query_params["order_by"] = params[:order_by] if params.key?(:order_by)
+        query_params["q"] = params[:q] if params.key?(:q)
+        params.except(*query_param_names)
+
+        request = Voltaria::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v2/installments",
+          query: query_params,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Voltaria::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Voltaria::Types::PaginatedResponseInstallmentResponseWithClientInfo.load(response.body)
+        else
+          error_class = Voltaria::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Add new installments to a loan with its specific loan ID. This endpoint is available to select partners and will
+      # trigger the recalculation of the IRR and interest amounts for all installments of the loan.
+      #
+      # @param request_options [Hash]
+      # @param params [Voltaria::Installments::Types::InstallmentCreatePayload]
+      # @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 [Array[Voltaria::Types::InstallmentResponse]]
+      def add_installment(request_options: {}, **params)
+        params = Voltaria::Internal::Types::Utils.normalize_keys(params)
+        request = Voltaria::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v2/installments",
+          body: Voltaria::Installments::Types::InstallmentCreatePayload.new(params).to_h,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Voltaria::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        return if code.between?(200, 299)
+
+        error_class = Voltaria::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
+
+      # Retrieve a list of payment promises recorded for installments under your partner account. Supports optional
+      # filtering by loan or client.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @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
+      # @option params [Integer, nil] :page
+      # @option params [Integer, nil] :page_size
+      # @option params [String, nil] :order_by
+      # @option params [String, nil] :q
+      # @option params [String, nil] :loan_id
+      # @option params [String, nil] :client_id
+      #
+      # @return [Voltaria::Types::PaginatedResponsePaymentPromiseResponse]
+      def list_payment_promises(request_options: {}, **params)
+        params = Voltaria::Internal::Types::Utils.normalize_keys(params)
+        query_param_names = %i[page page_size order_by q loan_id client_id]
+        query_params = {}
+        query_params["page"] = params[:page] if params.key?(:page)
+        query_params["page_size"] = params[:page_size] if params.key?(:page_size)
+        query_params["order_by"] = params[:order_by] if params.key?(:order_by)
+        query_params["q"] = params[:q] if params.key?(:q)
+        query_params["loan_id"] = params[:loan_id] if params.key?(:loan_id)
+        query_params["client_id"] = params[:client_id] if params.key?(:client_id)
+        params.except(*query_param_names)
+
+        request = Voltaria::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v2/installments/payment-promises",
+          query: query_params,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Voltaria::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Voltaria::Types::PaginatedResponsePaymentPromiseResponse.load(response.body)
+        else
+          error_class = Voltaria::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Record a payment promise made by a client for one of their installments. The promised date must be today or in
+      # the future.
+      #
+      # @param request_options [Hash]
+      # @param params [Voltaria::Installments::Types::PaymentPromiseCreatePayload]
+      # @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 [Voltaria::Types::PaymentPromiseResponse]
+      def create_payment_promise(request_options: {}, **params)
+        params = Voltaria::Internal::Types::Utils.normalize_keys(params)
+        request = Voltaria::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v2/installments/payment-promises",
+          body: Voltaria::Installments::Types::PaymentPromiseCreatePayload.new(params).to_h,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Voltaria::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Voltaria::Types::PaymentPromiseResponse.load(response.body)
+        else
+          error_class = Voltaria::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Retrieve detailed information for a specific installment using its installment ID.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @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
+      # @option params [String] :installment_id
+      #
+      # @return [Voltaria::Types::InstallmentResponse]
+      def get_installment_by_id(request_options: {}, **params)
+        params = Voltaria::Internal::Types::Utils.normalize_keys(params)
+        request = Voltaria::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v2/installments/#{URI.encode_uri_component(params[:installment_id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Voltaria::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Voltaria::Types::InstallmentResponse.load(response.body)
+        else
+          error_class = Voltaria::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Update an installment's amount and expected repayment date with its specific installment ID. This endpoint is
+      # available to select partners and will trigger the recalculation of the IRR and interest amounts for all
+      # installments of the loan.
+      #
+      # @param request_options [Hash]
+      # @param params [Voltaria::Installments::Types::InstallmentEditPayload]
+      # @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
+      # @option params [String] :installment_id
+      #
+      # @return [Voltaria::Types::InstallmentResponse]
+      def edit_installment(request_options: {}, **params)
+        params = Voltaria::Internal::Types::Utils.normalize_keys(params)
+        request_data = Voltaria::Installments::Types::InstallmentEditPayload.new(params).to_h
+        non_body_param_names = ["installment_id"]
+        body = request_data.except(*non_body_param_names)
+
+        request = Voltaria::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "PUT",
+          path: "v2/installments/#{URI.encode_uri_component(params[:installment_id].to_s)}",
+          body: body,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Voltaria::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Voltaria::Types::InstallmentResponse.load(response.body)
+        else
+          error_class = Voltaria::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Delete an installment with its specific installment ID. This endpoint is available to select partners and will
+      # trigger the recalculation of the IRR and interest amounts for all installments of the loan.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @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
+      # @option params [String] :installment_id
+      #
+      # @return [Hash[String, Object]]
+      def delete_installment(request_options: {}, **params)
+        params = Voltaria::Internal::Types::Utils.normalize_keys(params)
+        request = Voltaria::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "DELETE",
+          path: "v2/installments/#{URI.encode_uri_component(params[:installment_id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Voltaria::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        return if code.between?(200, 299)
+
+        error_class = Voltaria::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
+    end
+  end
+end

data/lib/voltaria/installments/types/delete_installment_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Installments
+    module Types
+      class DeleteInstallmentRequest < Internal::Types::Model
+        field :installment_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/voltaria/installments/types/get_installment_by_id_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Installments
+    module Types
+      class GetInstallmentByIDRequest < Internal::Types::Model
+        field :installment_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/voltaria/installments/types/installment_create_payload.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Installments
+    module Types
+      class InstallmentCreatePayload < Internal::Types::Model
+        field :loan_id, -> { String }, optional: false, nullable: false
+        field :installments, -> { Internal::Types::Array[Voltaria::Types::LoanInstallmentCreatePayload] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/voltaria/installments/types/installment_edit_payload.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Installments
+    module Types
+      class InstallmentEditPayload < Internal::Types::Model
+        field :installment_id, -> { String }, optional: false, nullable: false
+        field :amount, -> { Voltaria::Installments::Types::InstallmentEditPayloadAmount }, optional: false, nullable: false
+        field :expected_repayment_at, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/voltaria/installments/types/installment_edit_payload_amount.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Installments
+    module Types
+      # The new amount for the installment
+      class InstallmentEditPayloadAmount < Internal::Types::Model
+        extend Voltaria::Internal::Types::Union
+
+        member -> { Integer }
+        member -> { String }
+      end
+    end
+  end
+end

data/lib/voltaria/installments/types/list_installments_request.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Installments
+    module Types
+      class ListInstallmentsRequest < Internal::Types::Model
+        field :page, -> { Integer }, optional: true, nullable: false
+        field :page_size, -> { Integer }, optional: true, nullable: false
+        field :client_id, -> { String }, optional: true, nullable: false
+        field :loan_id, -> { String }, optional: true, nullable: false
+        field :order_by, -> { String }, optional: true, nullable: false
+        field :q, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/voltaria/installments/types/list_payment_promises_request.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Installments
+    module Types
+      class ListPaymentPromisesRequest < Internal::Types::Model
+        field :page, -> { Integer }, optional: true, nullable: false
+        field :page_size, -> { Integer }, optional: true, nullable: false
+        field :order_by, -> { String }, optional: true, nullable: false
+        field :q, -> { String }, optional: true, nullable: false
+        field :loan_id, -> { String }, optional: true, nullable: false
+        field :client_id, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/voltaria/installments/types/payment_promise_create_payload.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Installments
+    module Types
+      class PaymentPromiseCreatePayload < Internal::Types::Model
+        field :installment_id, -> { String }, optional: false, nullable: false
+        field :amount, -> { Voltaria::Installments::Types::PaymentPromiseCreatePayloadAmount }, optional: false, nullable: false
+        field :promised_date, -> { String }, optional: false, nullable: false
+        field :notes, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/voltaria/installments/types/payment_promise_create_payload_amount.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Installments
+    module Types
+      # The amount the client has promised to pay (must be > 0)
+      class PaymentPromiseCreatePayloadAmount < Internal::Types::Model
+        extend Voltaria::Internal::Types::Union
+
+        member -> { Integer }
+        member -> { String }
+      end
+    end
+  end
+end

data/lib/voltaria/internal/errors/constraint_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Internal
+    module Errors
+      class ConstraintError < StandardError
+      end
+    end
+  end
+end

data/lib/voltaria/internal/errors/type_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Internal
+    module Errors
+      class TypeError < StandardError
+      end
+    end
+  end
+end

data/lib/voltaria/internal/http/base_request.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Internal
+    module Http
+      # @api private
+      class BaseRequest
+        attr_reader :base_url, :path, :method, :headers, :query, :request_options
+
+        # @param base_url [String] The base URL for the request
+        # @param path [String] The path for the request
+        # @param method [String] The HTTP method for the request (:get, :post, etc.)
+        # @param headers [Hash] Additional headers for the request (optional)
+        # @param query [Hash] Query parameters for the request (optional)
+        # @param request_options [Voltaria::RequestOptions, Hash{Symbol=>Object}, nil]
+        def initialize(base_url:, path:, method:, headers: {}, query: {}, request_options: {})
+          @base_url = base_url
+          @path = path
+          @method = method
+          @headers = headers
+          @query = query
+          @request_options = request_options
+        end
+
+        # @return [Hash] The query parameters merged with additional query parameters from request options.
+        def encode_query
+          additional_query = @request_options&.dig(:additional_query_parameters) || @request_options&.dig("additional_query_parameters") || {}
+          @query.merge(additional_query)
+        end
+
+        # Child classes should implement:
+        # - encode_headers: Returns the encoded HTTP request headers.
+        # - encode_body: Returns the encoded HTTP request body.
+
+        private
+
+        # Merges additional_headers from request_options into sdk_headers, filtering out
+        # any keys that collide with SDK-set or client-protected headers (case-insensitive).
+        # @param sdk_headers [Hash] Headers set by the SDK for this request type.
+        # @param protected_keys [Array<String>] Additional header keys that must not be overridden.
+        # @return [Hash] The merged headers.
+        def merge_additional_headers(sdk_headers, protected_keys: [])
+          additional_headers = @request_options&.dig(:additional_headers) || @request_options&.dig("additional_headers") || {}
+          all_protected = (sdk_headers.keys + protected_keys).to_set { |k| k.to_s.downcase }
+          filtered = additional_headers.reject { |key, _| all_protected.include?(key.to_s.downcase) }
+          sdk_headers.merge(filtered)
+        end
+      end
+    end
+  end
+end