payabli 0.0.485

data/lib/payabli/charge_backs/types/chargeback_query_records.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Payabli
+  module ChargeBacks
+    module Types
+      class ChargebackQueryRecords < Internal::Types::Model
+        field :id, -> { Integer }, optional: false, nullable: false, api_name: "Id"
+        field :chargeback_date, -> { String }, optional: false, nullable: false, api_name: "ChargebackDate"
+        field :case_number, -> { String }, optional: false, nullable: false, api_name: "CaseNumber"
+        field :reason_code, -> { String }, optional: false, nullable: false, api_name: "ReasonCode"
+        field :reason, -> { String }, optional: false, nullable: false, api_name: "Reason"
+        field :reference_number, -> { String }, optional: false, nullable: false, api_name: "ReferenceNumber"
+        field :last_four, -> { String }, optional: false, nullable: false, api_name: "LastFour"
+        field :account_type, -> { String }, optional: false, nullable: false, api_name: "AccountType"
+        field :status, -> { Integer }, optional: false, nullable: false, api_name: "Status"
+        field :method_, -> { String }, optional: false, nullable: false, api_name: "Method"
+        field :created_at, -> { String }, optional: false, nullable: false, api_name: "CreatedAt"
+        field :reply_by, -> { String }, optional: false, nullable: false, api_name: "ReplyBy"
+        field :payment_trans_id, -> { String }, optional: false, nullable: false, api_name: "PaymentTransId"
+        field :schedule_reference, -> { Integer }, optional: true, nullable: false, api_name: "ScheduleReference"
+        field :order_id, -> { String }, optional: false, nullable: false, api_name: "OrderId"
+        field :net_amount, -> { Integer }, optional: false, nullable: false, api_name: "NetAmount"
+        field :transaction_time, -> { String }, optional: false, nullable: false, api_name: "TransactionTime"
+        field :customer, lambda {
+          Payabli::Types::QueryTransactionPayorData
+        }, optional: false, nullable: false, api_name: "Customer"
+        field :payment_data, lambda {
+          Payabli::Types::QueryPaymentData
+        }, optional: false, nullable: false, api_name: "PaymentData"
+        field :paypoint_legalname, -> { String }, optional: false, nullable: false, api_name: "PaypointLegalname"
+        field :paypoint_dbaname, -> { String }, optional: false, nullable: false, api_name: "PaypointDbaname"
+        field :parent_org_name, -> { String }, optional: false, nullable: false, api_name: "ParentOrgName"
+        field :parent_org_id, -> { Integer }, optional: false, nullable: false, api_name: "ParentOrgId"
+        field :paypoint_entryname, -> { String }, optional: false, nullable: false, api_name: "PaypointEntryname"
+        field :responses, lambda {
+          Internal::Types::Array[Payabli::ChargeBacks::Types::ChargeBackResponse]
+        }, optional: false, nullable: false, api_name: "Responses"
+        field :transaction, lambda {
+          Payabli::Types::TransactionQueryRecords
+        }, optional: false, nullable: false, api_name: "Transaction"
+        field :external_paypoint_id, -> { String }, optional: true, nullable: false, api_name: "externalPaypointID"
+        field :pageidentifier, -> { String }, optional: true, nullable: false
+        field :messages, lambda {
+          Internal::Types::Array[Payabli::ChargeBacks::Types::ChargebackMessage]
+        }, optional: false, nullable: false
+        field :service_group, -> { String }, optional: false, nullable: false, api_name: "ServiceGroup"
+        field :dispute_type, -> { String }, optional: false, nullable: false, api_name: "DisputeType"
+        field :processor_name, -> { String }, optional: false, nullable: false, api_name: "ProcessorName"
+      end
+    end
+  end
+end

data/lib/payabli/charge_backs/types/response_charge_back.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module ChargeBacks
+    module Types
+      class ResponseChargeBack < Internal::Types::Model
+        field :id, -> { Integer }, optional: false, nullable: false, api_name: "Id"
+        field :idempotency_key, -> { String }, optional: true, nullable: false, api_name: "idempotencyKey"
+        field :attachments, -> { Internal::Types::Array[Payabli::Types::FileContent] }, optional: true, nullable: false
+        field :contact_email, -> { String }, optional: true, nullable: false, api_name: "contactEmail"
+        field :contact_name, -> { String }, optional: true, nullable: false, api_name: "contactName"
+        field :notes, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/payabli/check_capture/client.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Payabli
+  module CheckCapture
+    class Client
+      # @param client [Payabli::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Captures a check for Remote Deposit Capture (RDC) using the provided check images and details. This endpoint handles the OCR extraction of check data including MICR, routing number, account number, and amount. See the [RDC guide](/developers/developer-guides/pay-in-rdc) for more details.
+      #
+      # @param request_options [Hash]
+      # @param params [Payabli::CheckCapture::Types::CheckCaptureRequestBody]
+      # @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 [Payabli::CheckCapture::Types::CheckCaptureResponse]
+      def check_processing(request_options: {}, **params)
+        _body_prop_names = %i[entry_point front_image rear_image check_amount]
+        _body_bag = params.slice(*_body_prop_names)
+
+        _request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Payabli::Environment::SANDBOX,
+          method: "POST",
+          path: "CheckCapture/CheckProcessing",
+          body: Payabli::CheckCapture::Types::CheckCaptureRequestBody.new(_body_bag).to_h
+        )
+        begin
+          _response = @client.send(_request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = _response.code.to_i
+        if code.between?(200, 299)
+          Payabli::CheckCapture::Types::CheckCaptureResponse.load(_response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+    end
+  end
+end

data/lib/payabli/check_capture/types/check_capture_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Payabli
+  module CheckCapture
+    module Types
+      # Request model for check capture processing.
+      class CheckCaptureRequest < Internal::Types::Model
+        field :entry_point, -> { String }, optional: false, nullable: false, api_name: "entryPoint"
+        field :front_image, -> { String }, optional: false, nullable: false, api_name: "frontImage"
+        field :rear_image, -> { String }, optional: false, nullable: false, api_name: "rearImage"
+        field :check_amount, -> { Integer }, optional: false, nullable: false, api_name: "checkAmount"
+      end
+    end
+  end
+end

data/lib/payabli/check_capture/types/check_capture_request_body.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module CheckCapture
+    module Types
+      class CheckCaptureRequestBody < Internal::Types::Model
+        field :entry_point, -> { String }, optional: false, nullable: false, api_name: "entryPoint"
+        field :front_image, -> { String }, optional: false, nullable: false, api_name: "frontImage"
+        field :rear_image, -> { String }, optional: false, nullable: false, api_name: "rearImage"
+        field :check_amount, -> { Integer }, optional: false, nullable: false, api_name: "checkAmount"
+      end
+    end
+  end
+end

data/lib/payabli/check_capture/types/check_capture_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Payabli
+  module CheckCapture
+    module Types
+      # Response model for check capture processing.
+      class CheckCaptureResponse < Internal::Types::Model
+        field :id, -> { String }, optional: true, nullable: false
+        field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
+        field :process_date, -> { String }, optional: false, nullable: false, api_name: "processDate"
+        field :ocr_micr, -> { String }, optional: true, nullable: false, api_name: "ocrMicr"
+        field :ocr_micr_status, -> { String }, optional: true, nullable: false, api_name: "ocrMicrStatus"
+        field :ocr_micr_confidence, -> { String }, optional: true, nullable: false, api_name: "ocrMicrConfidence"
+        field :ocr_account_number, -> { String }, optional: true, nullable: false, api_name: "ocrAccountNumber"
+        field :ocr_routing_number, -> { String }, optional: true, nullable: false, api_name: "ocrRoutingNumber"
+        field :ocr_check_number, -> { String }, optional: true, nullable: false, api_name: "ocrCheckNumber"
+        field :ocr_check_tran_code, -> { String }, optional: true, nullable: false, api_name: "ocrCheckTranCode"
+        field :ocr_amount, -> { String }, optional: true, nullable: false, api_name: "ocrAmount"
+        field :ocr_amount_status, -> { String }, optional: true, nullable: false, api_name: "ocrAmountStatus"
+        field :ocr_amount_confidence, -> { String }, optional: true, nullable: false, api_name: "ocrAmountConfidence"
+        field :amount_discrepancy_detected, lambda {
+          Internal::Types::Boolean
+        }, optional: false, nullable: false, api_name: "amountDiscrepancyDetected"
+        field :endorsement_detected, lambda {
+          Internal::Types::Boolean
+        }, optional: false, nullable: false, api_name: "endorsementDetected"
+        field :errors, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+        field :messages, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+        field :car_lar_match_confidence, lambda {
+          String
+        }, optional: true, nullable: false, api_name: "carLarMatchConfidence"
+        field :car_lar_match_status, -> { String }, optional: true, nullable: false, api_name: "carLarMatchStatus"
+        field :front_image, -> { String }, optional: true, nullable: false, api_name: "frontImage"
+        field :rear_image, -> { String }, optional: true, nullable: false, api_name: "rearImage"
+        field :check_type, -> { Integer }, optional: false, nullable: false, api_name: "checkType"
+        field :reference_number, -> { String }, optional: true, nullable: false, api_name: "referenceNumber"
+        field :page_identifier, -> { String }, optional: true, nullable: false, api_name: "pageIdentifier"
+      end
+    end
+  end
+end

data/lib/payabli/client.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module Payabli
+  class Client
+    # @param base_url [String, nil]
+    # @param api_key [String]
+    #
+    # @return [void]
+    def initialize(base_url:, api_key:)
+      @raw_client = Payabli::Internal::Http::RawClient.new(
+        base_url: base_url,
+        headers: {
+          "X-Fern-Language": "Ruby",
+          requestToken: api_key.to_s
+        }
+      )
+    end
+
+    # @return [Payabli::Bill::Client]
+    def bill
+      @bill ||= Payabli::Bill::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Boarding::Client]
+    def boarding
+      @boarding ||= Payabli::Boarding::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::ChargeBacks::Client]
+    def charge_backs
+      @charge_backs ||= Payabli::ChargeBacks::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::CheckCapture::Client]
+    def check_capture
+      @check_capture ||= Payabli::CheckCapture::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Cloud::Client]
+    def cloud
+      @cloud ||= Payabli::Cloud::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Customer::Client]
+    def customer
+      @customer ||= Payabli::Customer::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Export::Client]
+    def export
+      @export ||= Payabli::Export::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::HostedPaymentPages::Client]
+    def hosted_payment_pages
+      @hosted_payment_pages ||= Payabli::HostedPaymentPages::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Import::Client]
+    def import
+      @import ||= Payabli::Import::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Invoice::Client]
+    def invoice
+      @invoice ||= Payabli::Invoice::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::LineItem::Client]
+    def line_item
+      @line_item ||= Payabli::LineItem::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::MoneyIn::Client]
+    def money_in
+      @money_in ||= Payabli::MoneyIn::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::MoneyOut::Client]
+    def money_out
+      @money_out ||= Payabli::MoneyOut::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Notification::Client]
+    def notification
+      @notification ||= Payabli::Notification::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Notificationlogs::Client]
+    def notificationlogs
+      @notificationlogs ||= Payabli::Notificationlogs::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Ocr::Client]
+    def ocr
+      @ocr ||= Payabli::Ocr::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Organization::Client]
+    def organization
+      @organization ||= Payabli::Organization::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::PaymentLink::Client]
+    def payment_link
+      @payment_link ||= Payabli::PaymentLink::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::PaymentMethodDomain::Client]
+    def payment_method_domain
+      @payment_method_domain ||= Payabli::PaymentMethodDomain::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Paypoint::Client]
+    def paypoint
+      @paypoint ||= Payabli::Paypoint::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Query::Client]
+    def query
+      @query ||= Payabli::Query::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Statistic::Client]
+    def statistic
+      @statistic ||= Payabli::Statistic::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Subscription::Client]
+    def subscription
+      @subscription ||= Payabli::Subscription::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Templates::Client]
+    def templates
+      @templates ||= Payabli::Templates::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::TokenStorage::Client]
+    def token_storage
+      @token_storage ||= Payabli::TokenStorage::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::User::Client]
+    def user
+      @user ||= Payabli::User::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Vendor::Client]
+    def vendor
+      @vendor ||= Payabli::Vendor::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Wallet::Client]
+    def wallet
+      @wallet ||= Payabli::Wallet::Client.new(client: @raw_client)
+    end
+  end
+end

data/lib/payabli/cloud/client.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Cloud
+    class Client
+      # @param client [Payabli::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Register a cloud device to an entrypoint. See [Devices Quickstart](/developers/developer-guides/devices-quickstart#devices-quickstart) for a complete guide.
+      #
+      # @param request_options [Hash]
+      # @param params [Payabli::Cloud::Types::DeviceEntry]
+      # @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] :entry
+      # @option params [String, nil] :idempotency_key
+      #
+      # @return [Payabli::Cloud::Types::AddDeviceResponse]
+      def add_device(request_options: {}, **params)
+        _path_param_names = %i[entry]
+        _body = params.except(*_path_param_names)
+        _body_prop_names = %i[description registration_code]
+        _body_bag = _body.slice(*_body_prop_names)
+
+        _request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Payabli::Environment::SANDBOX,
+          method: "POST",
+          path: "Cloud/register/#{params[:entry]}",
+          body: Payabli::Cloud::Types::DeviceEntry.new(_body_bag).to_h
+        )
+        begin
+          _response = @client.send(_request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = _response.code.to_i
+        if code.between?(200, 299)
+          Payabli::Cloud::Types::AddDeviceResponse.load(_response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Retrieve the registration history for a device.
+      #
+      # @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] :entry
+      # @option params [String] :device_id
+      #
+      # @return [Payabli::Types::CloudQueryApiResponse]
+      def history_device(request_options: {}, **params)
+        _request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Payabli::Environment::SANDBOX,
+          method: "GET",
+          path: "Cloud/history/#{params[:entry]}/#{params[:device_id]}"
+        )
+        begin
+          _response = @client.send(_request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = _response.code.to_i
+        if code.between?(200, 299)
+          Payabli::Types::CloudQueryApiResponse.load(_response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Get a list of cloud devices registered to an entrypoint.
+      #
+      # @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] :entry
+      # @option params [Boolean, nil] :force_refresh
+      #
+      # @return [Payabli::Types::CloudQueryApiResponse]
+      def list_device(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.symbolize_keys(params)
+        _query_param_names = %i[force_refresh]
+        _query = {}
+        _query["forceRefresh"] = params[:force_refresh] if params.key?(:force_refresh)
+        params = params.except(*_query_param_names)
+
+        _request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Payabli::Environment::SANDBOX,
+          method: "GET",
+          path: "Cloud/list/#{params[:entry]}",
+          query: _query
+        )
+        begin
+          _response = @client.send(_request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = _response.code.to_i
+        if code.between?(200, 299)
+          Payabli::Types::CloudQueryApiResponse.load(_response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+
+      # Remove a cloud device from an entrypoint.
+      #
+      # @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] :entry
+      # @option params [String] :device_id
+      #
+      # @return [Payabli::Cloud::Types::RemoveDeviceResponse]
+      def remove_device(request_options: {}, **params)
+        _request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url] || Payabli::Environment::SANDBOX,
+          method: "DELETE",
+          path: "Cloud/register/#{params[:entry]}/#{params[:device_id]}"
+        )
+        begin
+          _response = @client.send(_request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = _response.code.to_i
+        if code.between?(200, 299)
+          Payabli::Cloud::Types::RemoveDeviceResponse.load(_response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(_response.body, code: code)
+        end
+      end
+    end
+  end
+end

data/lib/payabli/cloud/types/add_device_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Cloud
+    module Types
+      class AddDeviceResponse < Internal::Types::Model
+        field :page_identifier, -> { String }, optional: true, nullable: false, api_name: "pageIdentifier"
+        field :response_data, -> { String }, optional: true, nullable: false, api_name: "responseData"
+      end
+    end
+  end
+end

data/lib/payabli/cloud/types/device_entry.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Cloud
+    module Types
+      class DeviceEntry < Internal::Types::Model
+        field :entry, -> { String }, optional: false, nullable: false
+        field :idempotency_key, -> { String }, optional: true, nullable: false, api_name: "idempotencyKey"
+        field :description, -> { String }, optional: true, nullable: false
+        field :registration_code, -> { String }, optional: true, nullable: false, api_name: "registrationCode"
+      end
+    end
+  end
+end

data/lib/payabli/cloud/types/list_device_request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Cloud
+    module Types
+      class ListDeviceRequest < Internal::Types::Model
+        field :entry, -> { String }, optional: false, nullable: false
+        field :force_refresh, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "forceRefresh"
+      end
+    end
+  end
+end

data/lib/payabli/cloud/types/remove_device_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Cloud
+    module Types
+      class RemoveDeviceResponse < Internal::Types::Model
+        field :page_identifier, -> { String }, optional: true, nullable: false, api_name: "pageIdentifier"
+        field :response_data, -> { String }, optional: true, nullable: false, api_name: "responseData"
+      end
+    end
+  end
+end