payabli 3.0.10 → 3.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5592e568d992b9b084033c2084cdf8fbb9f8dcf6cf741779dffbe0729b1c9756
-  data.tar.gz: 5371e7e363edd80deace02b87c77ca2b509b9cb739172159a370237df52c9bf7
+  metadata.gz: 0144b8863c13e815b04ac5deeb134ec9ff868dee0f613ebdb32c30f65fcc4e53
+  data.tar.gz: 2480d71e0c0ff34170adf2da7059c19e5ff6e133939639d2e19b4120a70642f5
 SHA512:
-  metadata.gz: b6f5371080ad1ac24f97dbdd649b5eccfe4bbf96e346ff94360734ec1498154863ea0ce54c1afbdbfbd5b59c3c881eb9a3f1c88c6485964d3fe498c4f636d4e9
-  data.tar.gz: 28d44e720fa0625f83627bd6d367abf6b1a8ef45e95cf8ec9d3fe7ab08d382f3b0239b0fe35dc30fcd97300d9d12be488a41af51c08a6507b025db7abf8e4007
+  metadata.gz: 4f72da83aae935c0a21d6a95f45547261c3557a06a169c210b26a6ca114eb8f341581be1e6cc805b1ab2ad55afc8294f1348c93c2cb55923bc36f1896531f2c6
+  data.tar.gz: 1018bb7c00bec622ea398c474c8a90ce426a6348375d9a08984c70d8d2f1bca7a1d5389d21cae149d01bd0a713e35ace4ce506884cb2dc744d6adc3f216c315c

data/.fern/metadata.json

@@ -1,16 +1,16 @@
 {
   "cliVersion": "5.98.1",
   "generatorName": "fernapi/fern-ruby-sdk",
-  "generatorVersion": "1.23.0",
+  "generatorVersion": "1.24.0",
   "generatorConfig": {
     "enableWireTests": true,
     "rubocopVariableNumberStyle": "snake_case",
     "respectOptionalRequestBody": true
   },
-  "originGitCommit": "2adc358322dabc538c0685e4f8aba68a245a8501",
+  "originGitCommit": "75a6ae666f6df6ac60fb9521709c38d26cb8db9e",
   "originGitCommitIsDirty": true,
   "invokedBy": "ci",
-  "requestedVersion": "3.0.10",
+  "requestedVersion": "3.0.12",
   "ciProvider": "github",
-  "sdkVersion": "3.0.10"
+  "sdkVersion": "3.0.12"
 }

data/lib/payabli/client.rb

@@ -32,7 +32,7 @@ module Payabli
       @raw_client = Payabli::Internal::Http::RawClient.new(
         base_url: base_url || Payabli::Environment::SANDBOX,
         headers: {
-          "User-Agent" => "payabli/3.0.10",
+          "User-Agent" => "payabli/3.0.12",
           "X-Fern-Language" => "Ruby"
         },
         auth_provider: Payabli::Internal::RoutingAuthProvider.new(

data/lib/payabli/money_out/client.rb

@@ -31,7 +31,7 @@ module Payabli
       # affected.
       #
       # @param request_options [Hash]
-      # @param params [Payabli::MoneyOut::Types::RequestOutAuthorize]
+      # @param params [Payabli::Types::AuthorizePayoutBody]
       # @option request_options [String] :base_url
       # @option request_options [Hash{String => Object}] :additional_headers
       # @option request_options [Hash{String => Object}] :additional_query_parameters
@@ -65,14 +65,12 @@ module Payabli
       # @return [Payabli::Types::AuthCapturePayoutResponse]
       def authorize_out(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
-        request_data = Payabli::MoneyOut::Types::RequestOutAuthorize.new(params).to_h
-        non_body_param_names = %w[allowDuplicatedBills doNotCreateBills sameDayACH idempotencyKey]
-        body = request_data.except(*non_body_param_names)
-
+        query_param_names = %i[allow_duplicated_bills do_not_create_bills same_day_ach]
         query_params = {}
         query_params["allowDuplicatedBills"] = params[:allow_duplicated_bills] if params.key?(:allow_duplicated_bills)
         query_params["doNotCreateBills"] = params[:do_not_create_bills] if params.key?(:do_not_create_bills)
         query_params["sameDayACH"] = params[:same_day_ach] if params.key?(:same_day_ach)
+        params = params.except(*query_param_names)
 
         headers = {}
         headers["idempotencyKey"] = params[:idempotency_key] if params[:idempotency_key]
@@ -84,7 +82,7 @@ module Payabli
           path: "MoneyOut/authorize",
           headers: headers,
           query: query_params,
-          body: body,
+          body: Payabli::Types::AuthorizePayoutBody.new(params).to_h,
           request_options: request_options
         )
         begin
@@ -322,6 +320,90 @@ module Payabli
         end
       end
 
+      # Authorizes a payout and captures it in the same request, returning the capture result. Use this endpoint when
+      # you need the capture outcome synchronously: it does the same work as calling `POST /MoneyOut/authorize` followed
+      # by `GET /MoneyOut/capture/{referenceId}`, in a single call.
+      #
+      # Risk and fraud review runs at both the authorize and capture stages, exactly as it does for the two-call flow.
+      #
+      # Payabli ignores the `autoCapture` field in the request body, since this endpoint always captures inline.
+      #
+      # If the capture fails, the payout stays authorized. Retry the capture with `GET /MoneyOut/capture/{referenceId}`
+      # using the `referenceId` from the error response rather than resubmitting, which would create a second payout.
+      # See the [Manage payouts guide](/guides/pay-out-developer-payouts-manage#authorize-and-capture-in-one-call) for
+      # details.
+      #
+      # @param request_options [Hash]
+      # @param params [Payabli::Types::AuthorizePayoutBody]
+      # @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 [Boolean, nil] :same_day_ach
+      # @option params [Boolean, nil] :do_not_create_bills
+      # @option params [Boolean, nil] :allow_duplicated_bills
+      # @option params [Boolean, nil] :update_vendor_payment_method
+      # @option params [Boolean, nil] :auto_convert_same_day_ach
+      # @option params [String, nil] :idempotency_key
+      #
+      # @example
+      #   client.money_out.payout(
+      #     entry_point: "8cfec329267",
+      #     order_description: "Window Painting",
+      #     payment_method: {
+      #       method_: "managed"
+      #     },
+      #     payment_details: {
+      #       total_amount: 47
+      #     },
+      #     vendor_data: {
+      #       vendor_number: "VEN-123"
+      #     },
+      #     invoice_data: [{
+      #       bill_id: 54323
+      #     }]
+      #   )
+      #
+      # @return [Payabli::Types::AuthCapturePayoutResponse]
+      def payout(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        query_param_names = %i[same_day_ach do_not_create_bills allow_duplicated_bills update_vendor_payment_method auto_convert_same_day_ach]
+        query_params = {}
+        query_params["sameDayACH"] = params[:same_day_ach] if params.key?(:same_day_ach)
+        query_params["doNotCreateBills"] = params[:do_not_create_bills] if params.key?(:do_not_create_bills)
+        query_params["allowDuplicatedBills"] = params[:allow_duplicated_bills] if params.key?(:allow_duplicated_bills)
+        query_params["updateVendorPaymentMethod"] = params[:update_vendor_payment_method] if params.key?(:update_vendor_payment_method)
+        query_params["autoConvertSameDayAch"] = params[:auto_convert_same_day_ach] if params.key?(:auto_convert_same_day_ach)
+        params = params.except(*query_param_names)
+
+        headers = {}
+        headers["idempotencyKey"] = params[:idempotency_key] if params[:idempotency_key]
+
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }]).merge(headers)
+        request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "MoneyOut/payout",
+          headers: headers,
+          query: query_params,
+          body: Payabli::Types::AuthorizePayoutBody.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::Types::AuthCapturePayoutResponse.load(response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
       # Returns details for a processed money out transaction.
       #
       # @param request_options [Hash]

data/lib/payabli/money_out/types/payout_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module MoneyOut
+    module Types
+      class PayoutRequest < Internal::Types::Model
+        field :same_day_ach, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "sameDayACH"
+
+        field :do_not_create_bills, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "doNotCreateBills"
+
+        field :allow_duplicated_bills, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "allowDuplicatedBills"
+
+        field :update_vendor_payment_method, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "updateVendorPaymentMethod"
+
+        field :auto_convert_same_day_ach, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "autoConvertSameDayAch"
+
+        field :idempotency_key, -> { String }, optional: true, nullable: false, api_name: "idempotencyKey"
+
+        field :body, -> { Payabli::Types::AuthorizePayoutBody }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/payabli/money_out/types/request_out_authorize.rb

@@ -12,29 +12,7 @@ module Payabli
 
         field :idempotency_key, -> { String }, optional: true, nullable: false, api_name: "idempotencyKey"
 
-        field :entry_point, -> { String }, optional: false, nullable: false, api_name: "entryPoint"
-
-        field :source, -> { String }, optional: true, nullable: false
-
-        field :order_id, -> { String }, optional: true, nullable: false, api_name: "orderId"
-
-        field :order_description, -> { String }, optional: true, nullable: false, api_name: "orderDescription"
-
-        field :payment_method, -> { Payabli::Types::AuthorizePaymentMethod }, optional: false, nullable: false, api_name: "paymentMethod"
-
-        field :payment_details, -> { Payabli::Types::RequestOutAuthorizePaymentDetails }, optional: false, nullable: false, api_name: "paymentDetails"
-
-        field :vendor_data, -> { Payabli::Types::RequestOutAuthorizeVendorData }, optional: false, nullable: false, api_name: "vendorData"
-
-        field :invoice_data, -> { Internal::Types::Array[Payabli::Types::RequestOutAuthorizeInvoiceData] }, optional: true, nullable: false, api_name: "invoiceData"
-
-        field :account_id, -> { String }, optional: true, nullable: false, api_name: "accountId"
-
-        field :subdomain, -> { String }, optional: true, nullable: false
-
-        field :subscription_id, -> { Integer }, optional: true, nullable: false, api_name: "subscriptionId"
-
-        field :auto_capture, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "autoCapture"
+        field :body, -> { Payabli::Types::AuthorizePayoutBody }, optional: false, nullable: false
       end
     end
   end

data/lib/payabli/ocr/client.rb

@@ -10,13 +10,14 @@ module Payabli
         @client = client
       end
 
-      # Use this endpoint to upload an image file for OCR processing. The accepted file formats include PDF, JPG, JPEG,
-      # PNG, and GIF. Specify the desired type of result (either 'bill' or 'invoice') in the path parameter
-      # `typeResult`. The response will contain the OCR processing results, including extracted data such as bill
-      # number, vendor information, bill items, and more.
+      # Use this endpoint to upload a document file for OCR processing as `multipart/form-data`, with the file in a
+      # field named `file`. The accepted file formats include PDF, JPG, JPEG, PNG, and GIF. Specify the desired type of
+      # result (either 'bill' or 'invoice') in the path parameter `typeResult`. The response will contain the OCR
+      # processing results, including extracted data such as bill number, vendor information, bill items, and more. To
+      # send the file as a Base64-encoded string in a JSON body instead, use `ocrDocumentJson`.
       #
       # @param request_options [Hash]
-      # @param params [Payabli::Types::FileContentImageOnly]
+      # @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
@@ -30,16 +31,17 @@ module Payabli
       # @return [Payabli::Types::PayabliApiResponseOcr]
       def ocr_document_form(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
-        path_param_names = %i[type_result]
-        body_params = params.except(*path_param_names)
+        body = Internal::Multipart::FormData.new
+
+        body.add_part(params[:file].to_form_data_part(name: "file")) if params[:file]
 
         headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
-        request = Payabli::Internal::JSON::Request.new(
+        request = Payabli::Internal::Multipart::Request.new(
           base_url: request_options[:base_url],
           method: "POST",
           path: "Import/ocrDocumentForm/#{URI.encode_uri_component(params[:type_result].to_s)}",
           headers: headers,
-          body: Payabli::Types::FileContentImageOnly.new(body_params).to_h,
+          body: body,
           request_options: request_options
         )
         begin
@@ -62,7 +64,7 @@ module Payabli
       # bill number, vendor information, bill items, and more.
       #
       # @param request_options [Hash]
-      # @param params [Payabli::Types::FileContentImageOnly]
+      # @param params [Payabli::Ocr::Types::OcrDocumentJsonRequest]
       # @option request_options [String] :base_url
       # @option request_options [Hash{String => Object}] :additional_headers
       # @option request_options [Hash{String => Object}] :additional_query_parameters
@@ -76,8 +78,9 @@ module Payabli
       # @return [Payabli::Types::PayabliApiResponseOcr]
       def ocr_document_json(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
-        path_param_names = %i[type_result]
-        body_params = params.except(*path_param_names)
+        request_data = Payabli::Ocr::Types::OcrDocumentJsonRequest.new(params).to_h
+        non_body_param_names = %w[typeResult]
+        body = request_data.except(*non_body_param_names)
 
         headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
@@ -85,7 +88,7 @@ module Payabli
           method: "POST",
           path: "Import/ocrDocumentJson/#{URI.encode_uri_component(params[:type_result].to_s)}",
           headers: headers,
-          body: Payabli::Types::FileContentImageOnly.new(body_params).to_h,
+          body: body,
           request_options: request_options
         )
         begin

data/lib/payabli/ocr/types/ocr_document_form_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Ocr
+    module Types
+      class OcrDocumentFormRequest < Internal::Types::Model
+        field :type_result, -> { String }, optional: false, nullable: false, api_name: "typeResult"
+      end
+    end
+  end
+end

data/lib/payabli/ocr/types/ocr_document_json_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Ocr
+    module Types
+      class OcrDocumentJsonRequest < Internal::Types::Model
+        field :type_result, -> { String }, optional: false, nullable: false, api_name: "typeResult"
+
+        field :ftype, -> { Payabli::Types::FileContentFtype }, optional: true, nullable: false
+
+        field :filename, -> { String }, optional: true, nullable: false
+
+        field :furl, -> { String }, optional: true, nullable: false
+
+        field :f_content, -> { String }, optional: true, nullable: false, api_name: "fContent"
+      end
+    end
+  end
+end

data/lib/payabli/types/authorize_payout_body.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    class AuthorizePayoutBody < Internal::Types::Model
+      field :entry_point, -> { String }, optional: false, nullable: false, api_name: "entryPoint"
+
+      field :source, -> { String }, optional: true, nullable: false
+
+      field :order_id, -> { String }, optional: true, nullable: false, api_name: "orderId"
+
+      field :order_description, -> { String }, optional: true, nullable: false, api_name: "orderDescription"
+
+      field :payment_method, -> { Payabli::Types::AuthorizePaymentMethod }, optional: false, nullable: false, api_name: "paymentMethod"
+
+      field :payment_details, -> { Payabli::Types::RequestOutAuthorizePaymentDetails }, optional: false, nullable: false, api_name: "paymentDetails"
+
+      field :vendor_data, -> { Payabli::Types::RequestOutAuthorizeVendorData }, optional: false, nullable: false, api_name: "vendorData"
+
+      field :invoice_data, -> { Internal::Types::Array[Payabli::Types::RequestOutAuthorizeInvoiceData] }, optional: true, nullable: false, api_name: "invoiceData"
+
+      field :account_id, -> { String }, optional: true, nullable: false, api_name: "accountId"
+
+      field :subdomain, -> { String }, optional: true, nullable: false
+
+      field :subscription_id, -> { Integer }, optional: true, nullable: false, api_name: "subscriptionId"
+
+      field :auto_capture, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "autoCapture"
+    end
+  end
+end

data/lib/payabli/types/bill_details_response.rb

@@ -12,6 +12,10 @@ module Payabli
 
       field :net_amount, -> { String }, optional: true, nullable: false, api_name: "netAmount"
 
+      field :paid_amount, -> { String }, optional: true, nullable: false, api_name: "paidAmount"
+
+      field :outstanding_balance, -> { String }, optional: true, nullable: false, api_name: "outstandingBalance"
+
       field :discount, -> { String }, optional: true, nullable: false
 
       field :due_date, -> { String }, optional: false, nullable: true, api_name: "dueDate"

data/lib/payabli/types/bill_query_record_2.rb

@@ -73,6 +73,10 @@ module Payabli
 
       field :total_amount, -> { Integer }, optional: false, nullable: true, api_name: "TotalAmount"
 
+      field :paid_amount, -> { Integer }, optional: false, nullable: true, api_name: "PaidAmount"
+
+      field :outstanding_balance, -> { Integer }, optional: false, nullable: true, api_name: "OutstandingBalance"
+
       field :transaction, -> { Payabli::Types::TransactionOutQueryRecord }, optional: false, nullable: true, api_name: "Transaction"
 
       field :vendor, -> { Payabli::Types::VendorOutData }, optional: false, nullable: true, api_name: "Vendor"

data/lib/payabli/types/bill_response_data.rb

@@ -13,6 +13,10 @@ module Payabli
 
       field :total_amount, -> { Integer }, optional: true, nullable: false, api_name: "TotalAmount"
 
+      field :paid_amount, -> { Integer }, optional: true, nullable: false, api_name: "PaidAmount"
+
+      field :outstanding_balance, -> { Integer }, optional: true, nullable: false, api_name: "OutstandingBalance"
+
       field :bill_date, -> { String }, optional: false, nullable: true, api_name: "BillDate"
 
       field :due_date, -> { String }, optional: false, nullable: true, api_name: "DueDate"

data/lib/payabli/types/owners.rb

@@ -33,7 +33,7 @@ module Payabli
 
       field :ozip, -> { String }, optional: true, nullable: false
 
-      field :additional_data, -> { String }, optional: true, nullable: false, api_name: "additionalData"
+      field :additional_data, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false, api_name: "additionalData"
     end
   end
 end

data/lib/payabli/types/query_payout_transaction_records_item.rb

@@ -21,6 +21,8 @@ module Payabli
 
       field :payment_id, -> { String }, optional: true, nullable: false, api_name: "PaymentId"
 
+      field :order_id, -> { String }, optional: true, nullable: false, api_name: "orderId"
+
       field :trans_id, -> { String }, optional: true, nullable: false, api_name: "TransId"
 
       field :trans_status, -> { Integer }, optional: true, nullable: false, api_name: "TransStatus"

data/lib/payabli/types/query_summary.rb

@@ -3,7 +3,7 @@
 module Payabli
   module Types
     class QuerySummary < Internal::Types::Model
-      field :page_identifier, -> { String }, optional: true, nullable: false, api_name: "pageIdentifier"
+      field :page_identifier, -> { String }, optional: false, nullable: true, api_name: "pageidentifier"
 
       field :page_size, -> { Integer }, optional: true, nullable: false, api_name: "pageSize"
 

data/lib/payabli/version.rb

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

data/lib/payabli.rb

@@ -643,7 +643,6 @@ require_relative "payabli/types/v_card_query_response"
 require_relative "payabli/types/v_card_transaction_record"
 require_relative "payabli/types/v_card_transaction_query_response"
 require_relative "payabli/types/type_result"
-require_relative "payabli/types/file_content_image_only"
 require_relative "payabli/types/ocr_bill_item"
 require_relative "payabli/types/ocr_bill_item_additional_data"
 require_relative "payabli/types/ocr_vendor_billing_data"
@@ -872,6 +871,7 @@ require_relative "payabli/types/request_out_authorize_payment_details"
 require_relative "payabli/types/request_out_authorize_vendor_data"
 require_relative "payabli/types/request_out_authorize_invoice_data"
 require_relative "payabli/types/auto_capture"
+require_relative "payabli/types/authorize_payout_body"
 require_relative "payabli/types/vendoridtrans"
 require_relative "payabli/types/auth_capture_payout_response_data"
 require_relative "payabli/types/auth_capture_payout_response"
@@ -1076,6 +1076,8 @@ require_relative "payabli/query/types/list_vcards_transactions_request"
 require_relative "payabli/query/types/list_vcards_transactions_org_request"
 require_relative "payabli/query/types/list_vcards_org_request"
 require_relative "payabli/ocr/client"
+require_relative "payabli/ocr/types/ocr_document_form_request"
+require_relative "payabli/ocr/types/ocr_document_json_request"
 require_relative "payabli/notificationlogs/client"
 require_relative "payabli/notificationlogs/types/search_notification_logs_request"
 require_relative "payabli/device/client"
@@ -1150,6 +1152,7 @@ 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/payout_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"