voltaria_sdk 2.34.5

data/lib/voltaria/clients/types/list_client_checklist_summaries_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Clients
+    module Types
+      class ListClientChecklistSummariesRequest < Internal::Types::Model
+        field :client_id, -> { String }, optional: false, nullable: false
+        field :page, -> { Integer }, optional: true, nullable: false
+        field :page_size, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/voltaria/clients/types/list_client_waivers_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Clients
+    module Types
+      class ListClientWaiversRequest < Internal::Types::Model
+        field :client_id, -> { String }, optional: false, nullable: false
+        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
+      end
+    end
+  end
+end

data/lib/voltaria/clients/types/list_clients_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Clients
+    module Types
+      class ListClientsRequest < 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
+      end
+    end
+  end
+end

data/lib/voltaria/clients/types/list_limit_requests_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Clients
+    module Types
+      class ListLimitRequestsRequest < Internal::Types::Model
+        field :client_id, -> { String }, optional: true, nullable: false
+        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
+      end
+    end
+  end
+end

data/lib/voltaria/clients/types/list_onboarding_clients_request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Clients
+    module Types
+      class ListOnboardingClientsRequest < Internal::Types::Model
+        field :page, -> { Integer }, optional: true, nullable: false
+        field :page_size, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/voltaria/clients/types/reject_onboarding_request.rb

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

data/lib/voltaria/documents/client.rb

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Documents
+    class Client
+      # @param client [Voltaria::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Retrieve all documents linked to a 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 [String, nil] :client_id
+      # @option params [String, nil] :loan_id
+      # @option params [String, nil] :installment_id
+      # @option params [String, nil] :waterfall_id
+      # @option params [Integer, nil] :page
+      # @option params [Integer, nil] :page_size
+      # @option params [String, nil] :order_by
+      # @option params [String, nil] :q
+      #
+      # @return [Voltaria::Types::PaginatedResponseDocumentResponse]
+      def list_documents(request_options: {}, **params)
+        params = Voltaria::Internal::Types::Utils.normalize_keys(params)
+        query_param_names = %i[client_id loan_id installment_id waterfall_id page page_size order_by q]
+        query_params = {}
+        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["installment_id"] = params[:installment_id] if params.key?(:installment_id)
+        query_params["waterfall_id"] = params[:waterfall_id] if params.key?(:waterfall_id)
+        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)
+        params.except(*query_param_names)
+
+        request = Voltaria::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v2/documents",
+          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::PaginatedResponseDocumentResponse.load(response.body)
+        else
+          error_class = Voltaria::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Upload a new document related to a client or loan, such as financial statements or KYC files.
+      #
+      # @param request_options [Hash]
+      # @param params [void]
+      # @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, nil] :client_id
+      # @option params [String, nil] :loan_id
+      # @option params [String, nil] :installment_id
+      # @option params [String, nil] :waterfall_id
+      #
+      # @return [Voltaria::Types::DocumentResponse]
+      def upload_document(request_options: {}, **params)
+        params = Voltaria::Internal::Types::Utils.normalize_keys(params)
+        body = Internal::Multipart::FormData.new
+
+        if params[:category]
+          body.add(
+            name: "category",
+            value: params[:category]
+          )
+        end
+        if params[:file_name]
+          body.add(
+            name: "file_name",
+            value: params[:file_name]
+          )
+        end
+        body.add_part(params[:file].to_form_data_part(name: "file")) if params[:file]
+
+        request = Voltaria::Internal::Multipart::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v2/documents",
+          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::DocumentResponse.load(response.body)
+        else
+          error_class = Voltaria::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Retrieve all available document categories.
+      #
+      # @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
+      #
+      # @return [Voltaria::Types::AvailableDocumentCategoriesResponse]
+      def get_available_document_categories(request_options: {}, **params)
+        Voltaria::Internal::Types::Utils.normalize_keys(params)
+        request = Voltaria::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v2/documents/available-categories",
+          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::AvailableDocumentCategoriesResponse.load(response.body)
+        else
+          error_class = Voltaria::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Retrieve details for a specific document using its document 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] :document_id
+      #
+      # @return [Voltaria::Types::DocumentResponse]
+      def get_document_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/documents/#{URI.encode_uri_component(params[:document_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::DocumentResponse.load(response.body)
+        else
+          error_class = Voltaria::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Delete a specific document by using its document 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] :document_id
+      #
+      # @return [untyped]
+      def delete_document(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/documents/#{URI.encode_uri_component(params[:document_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/documents/types/delete_document_request.rb

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

data/lib/voltaria/documents/types/document_create_payload.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Documents
+    module Types
+      class DocumentCreatePayload < Internal::Types::Model
+        field :client_id, -> { String }, optional: true, nullable: false
+        field :loan_id, -> { String }, optional: true, nullable: false
+        field :installment_id, -> { String }, optional: true, nullable: false
+        field :waterfall_id, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/voltaria/documents/types/get_document_by_id_request.rb

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

data/lib/voltaria/documents/types/list_documents_request.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Documents
+    module Types
+      class ListDocumentsRequest < Internal::Types::Model
+        field :client_id, -> { String }, optional: true, nullable: false
+        field :loan_id, -> { String }, optional: true, nullable: false
+        field :installment_id, -> { String }, optional: true, nullable: false
+        field :waterfall_id, -> { String }, optional: true, nullable: false
+        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
+      end
+    end
+  end
+end

data/lib/voltaria/drawdowns/client.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Drawdowns
+    class Client
+      # @param client [Voltaria::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Retrieve a list of drawdowns.
+      #
+      # @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
+      #
+      # @return [Voltaria::Types::PaginatedResponseDrawdownResponse]
+      def list_drawdowns(request_options: {}, **params)
+        params = Voltaria::Internal::Types::Utils.normalize_keys(params)
+        query_param_names = %i[page page_size 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["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/drawdowns",
+          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::PaginatedResponseDrawdownResponse.load(response.body)
+        else
+          error_class = Voltaria::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Create a new drawdown request.
+      #
+      # @param request_options [Hash]
+      # @param params [Voltaria::Drawdowns::Types::DrawdownCreatePayload]
+      # @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::DrawdownResponse]
+      def create_drawdown_request(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/drawdowns",
+          body: Voltaria::Drawdowns::Types::DrawdownCreatePayload.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::DrawdownResponse.load(response.body)
+        else
+          error_class = Voltaria::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Retrieve all checklist items for a specific drawdown
+      #
+      # @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] :drawdown_id
+      # @option params [Integer, nil] :page
+      # @option params [Integer, nil] :page_size
+      # @option params [String, nil] :order_by
+      # @option params [String, nil] :q
+      #
+      # @return [Voltaria::Types::PaginatedResponseDrawdownChecklistResponse]
+      def list_drawdown_checklists(request_options: {}, **params)
+        params = Voltaria::Internal::Types::Utils.normalize_keys(params)
+        query_param_names = %i[page page_size 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["order_by"] = params[:order_by] if params.key?(:order_by)
+        query_params["q"] = params[:q] if params.key?(:q)
+        params = params.except(*query_param_names)
+
+        request = Voltaria::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v2/drawdowns/#{URI.encode_uri_component(params[:drawdown_id].to_s)}/checklists",
+          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::PaginatedResponseDrawdownChecklistResponse.load(response.body)
+        else
+          error_class = Voltaria::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+    end
+  end
+end

data/lib/voltaria/drawdowns/types/drawdown_create_payload.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Drawdowns
+    module Types
+      class DrawdownCreatePayload < Internal::Types::Model
+        field :amount, -> { Voltaria::Drawdowns::Types::DrawdownCreatePayloadAmount }, optional: false, nullable: false
+        field :drawdown_date, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/voltaria/drawdowns/types/drawdown_create_payload_amount.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Drawdowns
+    module Types
+      # The amount for the drawdown.
+      class DrawdownCreatePayloadAmount < Internal::Types::Model
+        extend Voltaria::Internal::Types::Union
+
+        member -> { Integer }
+        member -> { String }
+      end
+    end
+  end
+end

data/lib/voltaria/drawdowns/types/list_drawdown_checklists_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Drawdowns
+    module Types
+      class ListDrawdownChecklistsRequest < Internal::Types::Model
+        field :drawdown_id, -> { String }, optional: false, nullable: false
+        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
+      end
+    end
+  end
+end

data/lib/voltaria/drawdowns/types/list_drawdowns_request.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Drawdowns
+    module Types
+      class ListDrawdownsRequest < 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
+      end
+    end
+  end
+end

data/lib/voltaria/environment.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Voltaria
+  class Environment
+    SANDBOX = "https://api.sandbox.voltaria.io"
+    PRODUCTION = "https://api.voltaria.io"
+  end
+end

data/lib/voltaria/errors/api_error.rb

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

data/lib/voltaria/errors/client_error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Errors
+    class ClientError < ResponseError
+    end
+
+    class UnauthorizedError < ClientError
+    end
+
+    class ForbiddenError < ClientError
+    end
+
+    class NotFoundError < ClientError
+    end
+  end
+end

data/lib/voltaria/errors/redirect_error.rb

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

data/lib/voltaria/errors/response_error.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Errors
+    class ResponseError < ApiError
+      attr_reader :code
+
+      def initialize(msg, code:)
+        @code = code
+        super(msg)
+      end
+
+      def inspect
+        "#<#{self.class.name} @code=#{code} @body=#{message}>"
+      end
+
+      # Returns the most appropriate error class for the given code.
+      #
+      # @return [Class]
+      def self.subclass_for_code(code)
+        case code
+        when 300..399
+          RedirectError
+        when 401
+          UnauthorizedError
+        when 403
+          ForbiddenError
+        when 404
+          NotFoundError
+        when 400..499
+          ClientError
+        when 503
+          ServiceUnavailableError
+        when 500..599
+          ServerError
+        else
+          ResponseError
+        end
+      end
+    end
+  end
+end

data/lib/voltaria/errors/server_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Voltaria
+  module Errors
+    class ServerError < ResponseError
+    end
+
+    class ServiceUnavailableError < ApiError
+    end
+  end
+end