payabli 3.0.0 → 3.0.2

data/lib/payabli/types/refund_v_2_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Optional request body for the v2 refund endpoints. Provide split instructions to refund a split-funded
+    # transaction. Omit the body for a standard refund. Fields match the v1 refund-with-instructions request.
+    class RefundV2Request < Internal::Types::Model
+      field :amount, -> { Integer }, optional: true, nullable: false
+
+      field :ipaddress, -> { String }, optional: true, nullable: false
+
+      field :order_description, -> { String }, optional: true, nullable: false, api_name: "orderDescription"
+
+      field :order_id, -> { String }, optional: true, nullable: false, api_name: "orderId"
+
+      field :refund_details, -> { Payabli::Types::RefundDetail }, optional: true, nullable: false, api_name: "refundDetails"
+
+      field :source, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/payabli/types/renew_v_card_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    class RenewVCardResponse < Internal::Types::Model
+      field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
+
+      field :is_success, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "isSuccess"
+
+      field :response_data, -> { Payabli::Types::RenewVCardResponseData }, optional: false, nullable: false, api_name: "responseData"
+    end
+  end
+end

data/lib/payabli/types/renew_v_card_response_data.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    class RenewVCardResponseData < Internal::Types::Model
+      field :auth_code, -> { String }, optional: false, nullable: true, api_name: "authCode"
+
+      field :reference_id, -> { String }, optional: false, nullable: false, api_name: "referenceId"
+
+      field :result_code, -> { Integer }, optional: false, nullable: false, api_name: "resultCode"
+
+      field :result_text, -> { String }, optional: false, nullable: false, api_name: "resultText"
+
+      field :avs_response_text, -> { String }, optional: false, nullable: true, api_name: "avsResponseText"
+
+      field :cvv_response_text, -> { String }, optional: false, nullable: true, api_name: "cvvResponseText"
+
+      field :customer_id, -> { Integer }, optional: false, nullable: true, api_name: "customerId"
+
+      field :vendor_id, -> { Integer }, optional: false, nullable: true, api_name: "vendorId"
+
+      field :method_reference_id, -> { String }, optional: false, nullable: true, api_name: "methodReferenceId"
+    end
+  end
+end

data/lib/payabli/types/settlement_split_funding_detail.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A split funding instruction on a settled transaction, enriched with the batch and transfer that paid out the split
+    # when that information is available. Returned by the settlement query endpoints.
+    class SettlementSplitFundingDetail < Internal::Types::Model
+      field :recipient_entry_point, -> { String }, optional: true, nullable: false, api_name: "recipientEntryPoint"
+
+      field :account_id, -> { String }, optional: true, nullable: false, api_name: "AccountId"
+
+      field :description, -> { String }, optional: true, nullable: false, api_name: "Description"
+
+      field :amount, -> { Integer }, optional: true, nullable: false, api_name: "Amount"
+
+      field :batch_number, -> { String }, optional: true, nullable: false, api_name: "batchNumber"
+
+      field :transfer_id, -> { Integer }, optional: true, nullable: false, api_name: "transferId"
+
+      field :transfer_amount, -> { Integer }, optional: true, nullable: false, api_name: "transferAmount"
+    end
+  end
+end

data/lib/payabli/types/settlement_status_name.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module SettlementStatusName
+      # SettlementStatusName is an alias for Object
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/payabli/types/stat_basic_extended_query_record.rb

@@ -23,6 +23,14 @@ module Payabli
 
       field :out_pending_method_transactions, -> { Integer }, optional: false, nullable: false, api_name: "outPendingMethodTransactions"
 
+      field :out_rtp_transactions, -> { Integer }, optional: false, nullable: false, api_name: "outRTPTransactions"
+
+      field :out_rtp_volume, -> { Integer }, optional: false, nullable: false, api_name: "outRTPVolume"
+
+      field :out_wire_transactions, -> { Integer }, optional: false, nullable: false, api_name: "outWireTransactions"
+
+      field :out_wire_volume, -> { Integer }, optional: false, nullable: false, api_name: "outWireVolume"
+
       field :out_transactions_volume, -> { Integer }, optional: false, nullable: false, api_name: "outTransactionsVolume"
 
       field :out_subscriptions_paid_volume, -> { Integer }, optional: false, nullable: false, api_name: "outSubscriptionsPaidVolume"

data/lib/payabli/types/transfer_out_record.rb

@@ -71,6 +71,10 @@ module Payabli
       field :events_data, -> { Internal::Types::Array[Payabli::Types::TransferOutEventData] }, optional: false, nullable: true, api_name: "eventsData"
 
       field :messages, -> { Internal::Types::Array[Payabli::Types::TransferOutMessage] }, optional: false, nullable: true
+
+      field :type, -> { String }, optional: false, nullable: true
+
+      field :method_, -> { String }, optional: false, nullable: true, api_name: "method"
     end
   end
 end

data/lib/payabli/types/vendor_call_status_completed.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Details of a completed outreach call that returned data.
+    class VendorCallStatusCompleted < Internal::Types::Model
+      field :completed_at, -> { String }, optional: true, nullable: false, api_name: "completedAt"
+
+      field :duration_seconds, -> { Integer }, optional: true, nullable: false, api_name: "durationSeconds"
+
+      field :summary, -> { String }, optional: true, nullable: false
+
+      field :call_id, -> { String }, optional: true, nullable: false, api_name: "callId"
+
+      field :transcript, -> { String }, optional: true, nullable: false
+
+      field :extracted_data, -> { Payabli::Types::VendorCallStatusExtractedData }, optional: true, nullable: false, api_name: "extractedData"
+    end
+  end
+end

data/lib/payabli/types/vendor_call_status_extracted_data.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Data extracted from a completed outreach call.
+    class VendorCallStatusExtractedData < Internal::Types::Model
+      field :selected_payment_method, -> { String }, optional: true, nullable: false, api_name: "selectedPaymentMethod"
+
+      field :contact_email, -> { String }, optional: true, nullable: false, api_name: "contactEmail"
+    end
+  end
+end

data/lib/payabli/types/vendor_call_status_failed.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Details of an outreach call that didn't complete successfully.
+    class VendorCallStatusFailed < Internal::Types::Model
+      field :last_attempt_at, -> { String }, optional: true, nullable: false, api_name: "lastAttemptAt"
+
+      field :reason, -> { String }, optional: true, nullable: false
+
+      field :attempts_remaining, -> { Integer }, optional: true, nullable: false, api_name: "attemptsRemaining"
+
+      field :max_attempts, -> { Integer }, optional: true, nullable: false, api_name: "maxAttempts"
+
+      field :next_retry_scheduled_for, -> { String }, optional: true, nullable: false, api_name: "nextRetryScheduledFor"
+    end
+  end
+end

data/lib/payabli/types/vendor_call_status_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Latest AI outreach call activity for a vendor. The populated block depends on the `state` discriminator.
+    class VendorCallStatusResponse < Internal::Types::Model
+      field :vendor_id, -> { Integer }, optional: true, nullable: false, api_name: "vendorId"
+
+      field :state, -> { String }, optional: true, nullable: false
+
+      field :scheduled, -> { Payabli::Types::VendorCallStatusScheduled }, optional: true, nullable: false
+
+      field :completed, -> { Payabli::Types::VendorCallStatusCompleted }, optional: true, nullable: false
+
+      field :failed, -> { Payabli::Types::VendorCallStatusFailed }, optional: true, nullable: false
+    end
+  end
+end

data/lib/payabli/types/vendor_call_status_scheduled.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Details of a queued or in-progress outreach call.
+    class VendorCallStatusScheduled < Internal::Types::Model
+      field :scheduled_for, -> { String }, optional: true, nullable: false, api_name: "scheduledFor"
+
+      field :attempts_remaining, -> { Integer }, optional: true, nullable: false, api_name: "attemptsRemaining"
+
+      field :max_attempts, -> { Integer }, optional: true, nullable: false, api_name: "maxAttempts"
+    end
+  end
+end

data/lib/payabli/types/vendor_data.rb

@@ -5,7 +5,7 @@ module Payabli
     class VendorData < Internal::Types::Model
       field :vendor_number, -> { String }, optional: true, nullable: false, api_name: "vendorNumber"
 
-      field :additional_data, -> { Internal::Types::Hash[String, Internal::Types::Hash[String, Object]] }, optional: true, nullable: false, api_name: "AdditionalData"
+      field :additional_data, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false, api_name: "AdditionalData"
 
       field :address_1, -> { String }, optional: true, nullable: false, api_name: "address1"
 

data/lib/payabli/types/vendor_query_record.rb

@@ -13,7 +13,7 @@ module Payabli
 
       field :city, -> { String }, optional: true, nullable: false, api_name: "City"
 
-      field :contacts, -> { Payabli::Types::ContactsResponse }, optional: true, nullable: false, api_name: "Contacts"
+      field :contacts, -> { Internal::Types::Array[Payabli::Types::ContactsResponse] }, optional: true, nullable: false, api_name: "Contacts"
 
       field :country, -> { String }, optional: true, nullable: false, api_name: "Country"
 

data/lib/payabli/types/vendor_schedule_call_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Response from the schedule outreach call endpoint.
+    class VendorScheduleCallResponse < Internal::Types::Model
+      field :response_code, -> { Integer }, optional: true, nullable: false, api_name: "responseCode"
+
+      field :page_identifier, -> { String }, optional: true, nullable: false, api_name: "pageIdentifier"
+
+      field :room_id, -> { Integer }, optional: true, nullable: false, api_name: "roomId"
+
+      field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
+
+      field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
+
+      field :response_data, -> { Payabli::Types::VendorScheduleCallResponseData }, optional: true, nullable: false, api_name: "responseData"
+    end
+  end
+end

data/lib/payabli/types/vendor_schedule_call_response_data.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Scheduled call details.
+    class VendorScheduleCallResponseData < Internal::Types::Model
+      field :call_schedule_id, -> { Integer }, optional: true, nullable: false, api_name: "callScheduleId"
+
+      field :enrichment_id, -> { String }, optional: true, nullable: false, api_name: "enrichmentId"
+
+      field :scheduled_call_date, -> { String }, optional: true, nullable: false, api_name: "scheduledCallDate"
+
+      field :status, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/payabli/types/vendoridtrans.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module Vendoridtrans
+      # Vendoridtrans is an alias for Integer
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/payabli/vendor/client.rb

@@ -189,6 +189,85 @@ module Payabli
           raise error_class.new(response.body, code: code)
         end
       end
+
+      # Schedules an AI outreach call to a vendor to collect their preferred payment method and contact email. This is
+      # the third enrichment stage. Calls are scheduled for the next business day at around 9 AM in the vendor's
+      # timezone, with retries on no-answer and a fallback payment method applied when retries are exhausted. This
+      # feature is opt-in at the org level. Contact your Payabli representative to enable it, provision a phone number,
+      # and discuss pricing.
+      #
+      # @param request_options [Hash]
+      # @param params [Payabli::Vendor::Types::ScheduleEnrichmentCallRequest]
+      # @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
+      #
+      # @return [Payabli::Types::VendorScheduleCallResponse]
+      def schedule_enrichment_call(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        request_data = Payabli::Vendor::Types::ScheduleEnrichmentCallRequest.new(params).to_h
+        non_body_param_names = %w[entry]
+        body = request_data.except(*non_body_param_names)
+
+        request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "Vendor/enrich/schedule_call/#{URI.encode_uri_component(params[:entry].to_s)}",
+          body: body,
+          request_options: request_options
+        )
+        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::VendorScheduleCallResponse.load(response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Returns the latest AI outreach call activity for a vendor. The response is a composite object with a `state`
+      # discriminator (`none`, `scheduled`, `successful`, or `failed`); the block that matches the current state is
+      # populated. When the vendor has no call activity, `state` is `none` and the response returns HTTP 200.
+      #
+      # @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] :id_vendor
+      #
+      # @return [Payabli::Types::VendorCallStatusResponse]
+      def get_enrichment_call_status(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "Vendor/#{URI.encode_uri_component(params[:id_vendor].to_s)}/enrichment/call-status",
+          request_options: request_options
+        )
+        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::VendorCallStatusResponse.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/vendor/types/schedule_enrichment_call_request.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Vendor
+    module Types
+      class ScheduleEnrichmentCallRequest < Internal::Types::Model
+        field :entry, -> { String }, optional: false, nullable: false
+
+        field :vendor_id, -> { Integer }, optional: false, nullable: false, api_name: "vendorId"
+
+        field :phone, -> { String }, optional: true, nullable: false
+
+        field :enrichment_id, -> { String }, optional: true, nullable: false, api_name: "enrichmentId"
+
+        field :bill_id, -> { Integer }, optional: true, nullable: false, api_name: "billId"
+
+        field :fallback_method, -> { String }, optional: true, nullable: false, api_name: "fallbackMethod"
+
+        field :max_retries, -> { Integer }, optional: true, nullable: false, api_name: "maxRetries"
+
+        field :timezone, -> { String }, optional: true, nullable: false
+
+        field :send_now, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "sendNow"
+      end
+    end
+  end
+end

data/lib/payabli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Payabli
-  VERSION = "3.0.0"
+  VERSION = "3.0.2"
 end

data/lib/payabli.rb

@@ -348,6 +348,7 @@ require_relative "payabli/types/v_2_bad_request_error_detail"
 require_relative "payabli/types/v_2_bad_request_error"
 require_relative "payabli/types/v_2_declined_transaction_response_wrapper"
 require_relative "payabli/types/v_2_internal_server_error"
+require_relative "payabli/types/refund_v_2_request"
 require_relative "payabli/types/schedule_detail"
 require_relative "payabli/types/set_pause"
 require_relative "payabli/types/update_subscription_response"
@@ -589,6 +590,7 @@ require_relative "payabli/types/whenprovided"
 require_relative "payabli/types/whenrefunded"
 require_relative "payabli/types/query_entrypoint_response_records_item"
 require_relative "payabli/types/query_entrypoint_response"
+require_relative "payabli/types/settlement_split_funding_detail"
 require_relative "payabli/types/query_response_settlements_records_item"
 require_relative "payabli/types/query_response_settlements_summary"
 require_relative "payabli/types/query_response_settlements"
@@ -621,6 +623,7 @@ require_relative "payabli/types/transfer_out_detail_payment_data"
 require_relative "payabli/types/transfer_out_detail_bill_attachment"
 require_relative "payabli/types/transfer_out_detail_bill"
 require_relative "payabli/types/transfer_out_detail_event"
+require_relative "payabli/types/settlement_status_name"
 require_relative "payabli/types/transfer_out_detail_record"
 require_relative "payabli/types/transfer_out_detail_query_response"
 require_relative "payabli/types/query_user_response"
@@ -844,6 +847,13 @@ require_relative "payabli/types/vendor_enrichment_web_search"
 require_relative "payabli/types/vendor_enrichment_data"
 require_relative "payabli/types/vendor_enrich_response_data"
 require_relative "payabli/types/vendor_enrich_response"
+require_relative "payabli/types/vendor_schedule_call_response_data"
+require_relative "payabli/types/vendor_schedule_call_response"
+require_relative "payabli/types/vendor_call_status_scheduled"
+require_relative "payabli/types/vendor_call_status_extracted_data"
+require_relative "payabli/types/vendor_call_status_completed"
+require_relative "payabli/types/vendor_call_status_failed"
+require_relative "payabli/types/vendor_call_status_response"
 require_relative "payabli/types/create_ghost_card_response_data"
 require_relative "payabli/types/create_ghost_card_response"
 require_relative "payabli/types/card_status"
@@ -855,23 +865,29 @@ require_relative "payabli/types/request_out_authorize_vendor_data"
 require_relative "payabli/types/lot_number"
 require_relative "payabli/types/request_out_authorize_invoice_data"
 require_relative "payabli/types/auto_capture"
+require_relative "payabli/types/vendoridtrans"
 require_relative "payabli/types/auth_capture_payout_response_data"
 require_relative "payabli/types/auth_capture_payout_response"
 require_relative "payabli/types/capture_all_out_response_response_data_item"
 require_relative "payabli/types/capture_all_out_response"
+require_relative "payabli/types/cancel_payout_response_data"
 require_relative "payabli/types/payabli_api_response_0000"
 require_relative "payabli/types/bill_details_response"
+require_relative "payabli/types/entity_id_string"
 require_relative "payabli/types/bill_detail_response"
 require_relative "payabli/types/v_card_get_response_contact"
 require_relative "payabli/types/v_card_get_response_associated_vendor_billing_data"
 require_relative "payabli/types/v_card_get_response_associated_vendor_summary"
 require_relative "payabli/types/v_card_get_response_associated_vendor"
 require_relative "payabli/types/v_card_get_response"
+require_relative "payabli/types/renew_v_card_response_data"
+require_relative "payabli/types/renew_v_card_response"
 require_relative "payabli/types/operation_result"
 require_relative "payabli/types/allowed_check_payment_status"
 require_relative "payabli/types/reissue_payment_method"
 require_relative "payabli/types/reissue_payout_response_data"
 require_relative "payabli/types/reissue_payout_response"
+require_relative "payabli/types/deposit_funds_response"
 require_relative "payabli/types/cascade"
 require_relative "payabli/types/organization_id"
 require_relative "payabli/types/apple_pay_id"
@@ -1066,6 +1082,7 @@ require_relative "payabli/user/types/user_auth_psw_reset_request"
 require_relative "payabli/user/types/mfa_validation_data"
 require_relative "payabli/vendor/client"
 require_relative "payabli/vendor/types/vendor_enrich_request"
+require_relative "payabli/vendor/types/schedule_enrichment_call_request"
 require_relative "payabli/ghost_card/client"
 require_relative "payabli/ghost_card/types/create_ghost_card_request_body"
 require_relative "payabli/ghost_card/types/update_card_request_body"
@@ -1073,8 +1090,11 @@ require_relative "payabli/money_out/client"
 require_relative "payabli/money_out/types/request_out_authorize"
 require_relative "payabli/money_out/types/capture_all_out_request"
 require_relative "payabli/money_out/types/capture_out_request"
+require_relative "payabli/money_out/types/renew_v_card_request"
 require_relative "payabli/money_out/types/send_v_card_link_request"
 require_relative "payabli/money_out/types/reissue_out_request"
+require_relative "payabli/funding/client"
+require_relative "payabli/funding/types/deposit_funds_request"
 require_relative "payabli/wallet/client"
 require_relative "payabli/wallet/types/configure_organization_request_apple_pay"
 require_relative "payabli/wallet/types/configure_paypoint_request_apple_pay"