payabli 2.2.22 → 2.2.25

data/lib/payabli/query_types/types/device_query_record.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Payabli
+  module QueryTypes
+    module Types
+      class DeviceQueryRecord < Internal::Types::Model
+        field :device_id, -> { String }, optional: false, nullable: true, api_name: "deviceId"
+        field :id_cloud, -> { Integer }, optional: false, nullable: true, api_name: "idCloud"
+        field :description, -> { String }, optional: false, nullable: true
+        field :serial_number, -> { String }, optional: false, nullable: true, api_name: "serialNumber"
+        field :friendly_name, -> { String }, optional: false, nullable: true, api_name: "friendlyName"
+        field :make, -> { String }, optional: false, nullable: true
+        field :model, -> { String }, optional: false, nullable: true
+        field :device_type, -> { Integer }, optional: false, nullable: true, api_name: "deviceType"
+        field :device_status, -> { Integer }, optional: false, nullable: true, api_name: "deviceStatus"
+        field :device_os, -> { Integer }, optional: false, nullable: true, api_name: "deviceOs"
+        field :mac_address, -> { String }, optional: false, nullable: true, api_name: "macAddress"
+        field :last_health_check, -> { String }, optional: false, nullable: true, api_name: "lastHealthCheck"
+        field :registration_code, -> { String }, optional: false, nullable: true, api_name: "registrationCode"
+        field :activation_attempts, -> { Integer }, optional: false, nullable: true, api_name: "activationAttempts"
+        field :activation_code_expiry, -> { String }, optional: false, nullable: true, api_name: "activationCodeExpiry"
+        field :created_at, -> { String }, optional: false, nullable: true, api_name: "createdAt"
+        field :updated_at, -> { String }, optional: false, nullable: true, api_name: "updatedAt"
+        field :paypoint_id, -> { Integer }, optional: false, nullable: true, api_name: "paypointId"
+        field :paypoint_dba, -> { String }, optional: false, nullable: true, api_name: "paypointDba"
+        field :paypoint_legal, -> { String }, optional: false, nullable: true, api_name: "paypointLegal"
+        field :paypoint_entry, -> { String }, optional: false, nullable: true, api_name: "paypointEntry"
+        field :external_paypoint_id, -> { String }, optional: false, nullable: true, api_name: "externalPaypointId"
+        field :parent_org_id, -> { Integer }, optional: false, nullable: true, api_name: "parentOrgId"
+        field :parent_org_name, -> { String }, optional: false, nullable: true, api_name: "parentOrgName"
+      end
+    end
+  end
+end

data/lib/payabli/query_types/types/query_device_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module QueryTypes
+    module Types
+      # Response body for queries about cloud devices.
+      class QueryDeviceResponse < Internal::Types::Model
+        field :summary, -> { Payabli::Types::QuerySummary }, optional: false, nullable: false, api_name: "Summary"
+        field :records, -> { Internal::Types::Array[Payabli::QueryTypes::Types::DeviceQueryRecord] }, optional: false, nullable: false, api_name: "Records"
+      end
+    end
+  end
+end

data/lib/payabli/types/auto_capture.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module AutoCapture
+      # AutoCapture is an alias for Boolean
+
+      # @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/notification_content_event_type.rb

@@ -34,7 +34,6 @@ module Payabli
       APPROVED_APPLICATION = "ApprovedApplication"
       FAILED_BOARDING_APPLICATION = "FailedBoardingApplication"
       SUBMITTED_APPLICATION = "SubmittedApplication"
-      UNDER_WRITING_APPLICATION = "UnderWritingApplication"
       ACTIVATED_MERCHANT = "ActivatedMerchant"
       RECEIVED_CHARGE_BACK = "ReceivedChargeBack"
       CHARGEBACK_UPDATED = "ChargebackUpdated"

data/lib/payabli/types/notification_standard_request_content_event_type.rb

@@ -80,7 +80,6 @@ module Payabli
       APPROVED_APPLICATION = "ApprovedApplication"
       FAILED_BOARDING_APPLICATION = "FailedBoardingApplication"
       SUBMITTED_APPLICATION = "SubmittedApplication"
-      UNDER_WRITING_APPLICATION = "UnderWritingApplication"
       ACTIVATED_MERCHANT = "ActivatedMerchant"
       RECEIVED_CHARGE_BACK = "ReceivedChargeBack"
       CHARGEBACK_UPDATED = "ChargebackUpdated"

data/lib/payabli/types/processing_section.rb

@@ -18,6 +18,11 @@ module Payabli
       field :when_delivered, -> { Payabli::Types::TemplateElement }, optional: true, nullable: false, api_name: "whenDelivered"
       field :when_provided, -> { Payabli::Types::TemplateElement }, optional: true, nullable: false, api_name: "whenProvided"
       field :when_refunded, -> { Payabli::Types::TemplateElement }, optional: true, nullable: false, api_name: "whenRefunded"
+      field :combined_batches, -> { Payabli::Types::TemplateElement }, optional: true, nullable: false, api_name: "CombinedBatches"
+      field :payout_average_monthly_volume, -> { Payabli::Types::TemplateElement }, optional: true, nullable: false, api_name: "payoutAverageMonthlyVolume"
+      field :payout_high_ticket_amount, -> { Payabli::Types::TemplateElement }, optional: true, nullable: false, api_name: "payoutHighTicketAmount"
+      field :payout_average_ticket_amount, -> { Payabli::Types::TemplateElement }, optional: true, nullable: false, api_name: "payoutAverageTicketAmount"
+      field :payout_credit_limit, -> { Payabli::Types::TemplateElement }, optional: true, nullable: false, api_name: "payoutCreditLimit"
     end
   end
 end

data/lib/payabli/types/template_element.rb

@@ -8,6 +8,7 @@ module Payabli
       field :read_only, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "readOnly"
       field :value, -> { String }, optional: true, nullable: false
       field :visible, -> { Internal::Types::Boolean }, optional: true, nullable: false
+      field :required, -> { Internal::Types::Boolean }, optional: true, nullable: false
     end
   end
 end

data/lib/payabli/types/v_card_card_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module VCardCardType
+      # VCardCardType 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/types/v_card_record.rb

@@ -4,6 +4,7 @@ module Payabli
   module Types
     class VCardRecord < Internal::Types::Model
       field :vcard_sent, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "vcardSent"
+      field :card_type, -> { Integer }, optional: true, nullable: false, api_name: "cardType"
       field :card_token, -> { String }, optional: true, nullable: false, api_name: "cardToken"
       field :card_number, -> { String }, optional: true, nullable: false, api_name: "cardNumber"
       field :cvc, -> { String }, optional: true, nullable: false

data/lib/payabli/types/vendor_data.rb

@@ -35,6 +35,8 @@ module Payabli
       field :state, -> { String }, optional: true, nullable: false
       field :vendor_status, -> { Integer }, optional: true, nullable: false, api_name: "vendorStatus"
       field :zip, -> { String }, optional: true, nullable: false
+      field :default_method_id, -> { String }, optional: true, nullable: false, api_name: "defaultMethodId"
+      field :attachment, -> { Payabli::Types::FileContent }, optional: true, nullable: false
     end
   end
 end

data/lib/payabli/types/vendor_query_record.rb

@@ -47,6 +47,13 @@ module Payabli
       field :vendor_number, -> { String }, optional: true, nullable: false, api_name: "VendorNumber"
       field :vendor_status, -> { Integer }, optional: true, nullable: false, api_name: "VendorStatus"
       field :zip, -> { String }, optional: true, nullable: false, api_name: "Zip"
+      field :payment_portal_url, -> { String }, optional: true, nullable: false, api_name: "PaymentPortalUrl"
+      field :card_accepted, -> { String }, optional: true, nullable: false, api_name: "CardAccepted"
+      field :ach_accepted, -> { String }, optional: true, nullable: false, api_name: "AchAccepted"
+      field :enrichment_status, -> { String }, optional: true, nullable: false, api_name: "EnrichmentStatus"
+      field :enriched_by, -> { String }, optional: true, nullable: false, api_name: "EnrichedBy"
+      field :enriched_at, -> { String }, optional: true, nullable: false, api_name: "EnrichedAt"
+      field :enrichment_id, -> { String }, optional: true, nullable: false, api_name: "EnrichmentId"
     end
   end
 end

data/lib/payabli/vendor/client.rb

@@ -114,7 +114,7 @@ module Payabli
         end
       end
 
-      # Retrieves a vendor's details.
+      # Retrieves a vendor's details, including enrichment status and payment acceptance info when available.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -147,6 +147,44 @@ module Payabli
           raise error_class.new(response.body, code: code)
         end
       end
+
+      # Triggers AI-powered vendor enrichment for an existing vendor. Runs one or more enrichment stages (invoice scan,
+      # web search) based on the `scope` parameter. Can automatically apply extracted payment acceptance info and vendor
+      # contact information to the vendor record, or return raw results for manual review. Contact Payabli to enable
+      # this feature.
+      #
+      # @param request_options [Hash]
+      # @param params [Payabli::Vendor::Types::VendorEnrichRequest]
+      # @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::Vendor::Types::VendorEnrichResponse]
+      def enrich_vendor(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "Vendor/enrich/#{URI.encode_uri_component(params[:entry].to_s)}",
+          body: Payabli::Vendor::Types::VendorEnrichRequest.new(params).to_h,
+          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::Vendor::Types::VendorEnrichResponse.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/vendor_enrich_request.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Vendor
+    module Types
+      # Request body for the vendor enrichment endpoint.
+      class VendorEnrichRequest < Internal::Types::Model
+        field :vendor_id, -> { Integer }, optional: false, nullable: false, api_name: "vendorId"
+        field :scope, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+        field :apply_enrichment_data, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "applyEnrichmentData"
+        field :schedule_call_if_needed, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "scheduleCallIfNeeded"
+        field :invoice_file, -> { Payabli::Types::FileContent }, optional: true, nullable: false, api_name: "invoiceFile"
+        field :bill_id, -> { Integer }, optional: true, nullable: false, api_name: "billId"
+        field :fallback_method, -> { String }, optional: true, nullable: false, api_name: "fallbackMethod"
+      end
+    end
+  end
+end

data/lib/payabli/vendor/types/vendor_enrich_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Vendor
+    module Types
+      # Response from the vendor enrichment endpoint.
+      class VendorEnrichResponse < 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::Vendor::Types::VendorEnrichResponseData }, optional: true, nullable: false, api_name: "responseData"
+      end
+    end
+  end
+end

data/lib/payabli/vendor/types/vendor_enrich_response_data.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Vendor
+    module Types
+      # Enrichment result details.
+      class VendorEnrichResponseData < Internal::Types::Model
+        field :enrichment_id, -> { String }, optional: true, nullable: false, api_name: "enrichmentId"
+        field :status, -> { String }, optional: true, nullable: false
+        field :stages_triggered, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "stagesTriggered"
+        field :vendor_payout_ready, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "vendorPayoutReady"
+        field :enrichment_data, -> { Payabli::Vendor::Types::VendorEnrichmentData }, optional: true, nullable: false, api_name: "enrichmentData"
+      end
+    end
+  end
+end

data/lib/payabli/vendor/types/vendor_enrichment_data.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Vendor
+    module Types
+      # Container for enrichment stage results.
+      class VendorEnrichmentData < Internal::Types::Model
+        field :invoice_scan, -> { Payabli::Vendor::Types::VendorEnrichmentInvoiceScan }, optional: true, nullable: false, api_name: "invoiceScan"
+        field :web_search, -> { Payabli::Vendor::Types::VendorEnrichmentWebSearch }, optional: true, nullable: false, api_name: "webSearch"
+      end
+    end
+  end
+end

data/lib/payabli/vendor/types/vendor_enrichment_invoice_scan.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Vendor
+    module Types
+      # Vendor contact information and payment acceptance info extracted from an invoice.
+      class VendorEnrichmentInvoiceScan < Internal::Types::Model
+        field :vendor_name, -> { String }, optional: true, nullable: false, api_name: "vendorName"
+        field :street, -> { String }, optional: true, nullable: false
+        field :city, -> { String }, optional: true, nullable: false
+        field :state, -> { String }, optional: true, nullable: false
+        field :zip_code, -> { String }, optional: true, nullable: false, api_name: "zipCode"
+        field :country, -> { String }, optional: true, nullable: false
+        field :phone, -> { String }, optional: true, nullable: false
+        field :email, -> { String }, optional: true, nullable: false
+        field :payment_link, -> { String }, optional: true, nullable: false, api_name: "paymentLink"
+        field :card_accepted, -> { String }, optional: true, nullable: false, api_name: "cardAccepted"
+        field :ach_accepted, -> { String }, optional: true, nullable: false, api_name: "achAccepted"
+        field :check_accepted, -> { String }, optional: true, nullable: false, api_name: "checkAccepted"
+        field :invoice_number, -> { String }, optional: true, nullable: false, api_name: "invoiceNumber"
+        field :amount_due, -> { Integer }, optional: true, nullable: false, api_name: "amountDue"
+        field :due_date, -> { String }, optional: true, nullable: false, api_name: "dueDate"
+      end
+    end
+  end
+end

data/lib/payabli/vendor/types/vendor_enrichment_web_search.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Vendor
+    module Types
+      # Vendor contact information and payment acceptance info found through web search.
+      class VendorEnrichmentWebSearch < Internal::Types::Model
+        field :phone, -> { String }, optional: true, nullable: false
+        field :phone_type, -> { String }, optional: true, nullable: false, api_name: "phoneType"
+        field :email, -> { String }, optional: true, nullable: false
+        field :email_type, -> { String }, optional: true, nullable: false, api_name: "emailType"
+        field :street, -> { String }, optional: true, nullable: false
+        field :city, -> { String }, optional: true, nullable: false
+        field :state, -> { String }, optional: true, nullable: false
+        field :zip_code, -> { String }, optional: true, nullable: false, api_name: "zipCode"
+        field :country, -> { String }, optional: true, nullable: false
+        field :address_type, -> { String }, optional: true, nullable: false, api_name: "addressType"
+        field :payment_link, -> { String }, optional: true, nullable: false, api_name: "paymentLink"
+        field :payment_link_type, -> { String }, optional: true, nullable: false, api_name: "paymentLinkType"
+        field :card_accepted, -> { String }, optional: true, nullable: false, api_name: "cardAccepted"
+        field :ach_accepted, -> { String }, optional: true, nullable: false, api_name: "achAccepted"
+        field :check_accepted, -> { String }, optional: true, nullable: false, api_name: "checkAccepted"
+      end
+    end
+  end
+end

data/lib/payabli/version.rb

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

data/lib/payabli.rb

@@ -259,6 +259,7 @@ require_relative "payabli/types/auto_element"
 require_relative "payabli/types/avgticketamt"
 require_relative "payabli/types/avs_response_text"
 require_relative "payabli/types/avs_response"
+require_relative "payabli/types/auto_capture"
 require_relative "payabli/types/cvv_response"
 require_relative "payabli/types/cvv_response_text"
 require_relative "payabli/types/bank_section"
@@ -674,6 +675,7 @@ require_relative "payabli/types/transfer_summary"
 require_relative "payabli/types/transfer_query_response"
 require_relative "payabli/types/payment_trans_status_description"
 require_relative "payabli/types/user_data"
+require_relative "payabli/types/v_card_card_type"
 require_relative "payabli/types/v_card_summary"
 require_relative "payabli/types/associated_vendor"
 require_relative "payabli/types/v_card_record"
@@ -743,6 +745,8 @@ require_relative "payabli/query_types/types/transfer_out_detail_bill"
 require_relative "payabli/query_types/types/transfer_out_detail_event"
 require_relative "payabli/query_types/types/transfer_out_detail_record"
 require_relative "payabli/query_types/types/transfer_out_detail_query_response"
+require_relative "payabli/query_types/types/device_query_record"
+require_relative "payabli/query_types/types/query_device_response"
 require_relative "payabli/v_2_money_in_types/types/v_2_response_code"
 require_relative "payabli/v_2_money_in_types/types/v_2_response_reason"
 require_relative "payabli/v_2_money_in_types/types/v_2_response_explanation"
@@ -790,6 +794,8 @@ require_relative "payabli/invoice/types/invoice_response_without_data"
 require_relative "payabli/invoice/types/send_invoice_response"
 require_relative "payabli/invoice/types/invoice_number_response"
 require_relative "payabli/line_item/types/delete_item_response"
+require_relative "payabli/management/types/bank_account_verification_details_response"
+require_relative "payabli/management/types/verify_account_details_response"
 require_relative "payabli/money_in/types/invalid_trans_status_error_type"
 require_relative "payabli/money_in/types/receipt_response"
 require_relative "payabli/money_in/types/capture_response_data"
@@ -899,6 +905,12 @@ require_relative "payabli/user/types/change_psw_user_response"
 require_relative "payabli/user/types/delete_user_response"
 require_relative "payabli/user/types/edit_mfa_user_response"
 require_relative "payabli/user/types/logout_user_response"
+require_relative "payabli/vendor/types/vendor_enrich_request"
+require_relative "payabli/vendor/types/vendor_enrichment_invoice_scan"
+require_relative "payabli/vendor/types/vendor_enrichment_web_search"
+require_relative "payabli/vendor/types/vendor_enrichment_data"
+require_relative "payabli/vendor/types/vendor_enrich_response_data"
+require_relative "payabli/vendor/types/vendor_enrich_response"
 require_relative "payabli/client"
 require_relative "payabli/bill/client"
 require_relative "payabli/bill/types/add_bill_request"
@@ -971,6 +983,8 @@ require_relative "payabli/invoice/types/send_invoice_request"
 require_relative "payabli/line_item/client"
 require_relative "payabli/line_item/types/add_item_request"
 require_relative "payabli/line_item/types/list_line_items_request"
+require_relative "payabli/management/client"
+require_relative "payabli/management/types/verify_account_details_request"
 require_relative "payabli/money_in/client"
 require_relative "payabli/money_in/types/request_payment_authorize"
 require_relative "payabli/money_in/types/request_credit"
@@ -1019,6 +1033,8 @@ require_relative "payabli/query/types/list_chargebacks_request"
 require_relative "payabli/query/types/list_chargebacks_org_request"
 require_relative "payabli/query/types/list_customers_request"
 require_relative "payabli/query/types/list_customers_org_request"
+require_relative "payabli/query/types/list_devices_request"
+require_relative "payabli/query/types/list_devices_org_request"
 require_relative "payabli/query/types/list_notification_reports_request"
 require_relative "payabli/query/types/list_notification_reports_org_request"
 require_relative "payabli/query/types/list_notifications_request"