payabli 2.2.14 → 2.2.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c26b5153988401c77aa801347a9048487e89019dd9d58bf459c3d95dce29896
-  data.tar.gz: bb2810a10f507f337d7816018d250deb2875bcf35279d88f17a711c4f488c65f
+  metadata.gz: 4e5570a4534220a2d2377264e01967db162cf12480b0bc7c1c3dc66d43291808
+  data.tar.gz: 14d647dfa19da2a6f973bf98416544c60016a1ab3e593ae0135a80ab1a2ed768
 SHA512:
-  metadata.gz: 975ebf7ca566db3eb3fa88f22a104ba3c692e7567c73bf7a1042d3abc3ce6ffe338cdfded122da65c3777279d5783d04fab7bad32c3165fad008e39652af4f65
-  data.tar.gz: 91617a635216b2c28fcfcd2079b2bfe6aad527355946fb915320c29dc00965d22e355e5ee52d28c176e2b2dcf43026dfd4197c21c654f3d820ab4e6abb1b2c7c
+  metadata.gz: 14ecdae519c81169a049294d59bcd4f2c86255e6f32b3122517b86b2b16693b0905332a8f62eabc0d8558bc5c84006655fca2314c5eeb59fb4651e64a6525e3b
+  data.tar.gz: b3bb126add655d34888c4ee569d528d1e29e36ccd85dd010f5b994581a2a3e39b7284d4edfc17253a26aa8d802d8287058bcd8c5fe037e94b7c5a9433ba67150

data/.fern/metadata.json

@@ -1,9 +1,9 @@
 {
-  "cliVersion": "3.32.0",
+  "cliVersion": "3.68.1",
   "generatorName": "fernapi/fern-ruby-sdk",
   "generatorVersion": "1.0.0-rc83",
   "generatorConfig": {
     "enableWireTests": true
   },
-  "sdkVersion": "2.2.14"
+  "sdkVersion": "2.2.15"
 }

data/lib/payabli/client.rb

@@ -10,7 +10,7 @@ module Payabli
       @raw_client = Payabli::Internal::Http::RawClient.new(
         base_url: base_url || Payabli::Environment::SANDBOX,
         headers: {
-          "User-Agent" => "payabli/2.2.14",
+          "User-Agent" => "payabli/2.2.15",
           "X-Fern-Language" => "Ruby",
           requestToken: api_key.to_s
         }

data/lib/payabli/money_out/client.rb

@@ -377,6 +377,56 @@ module Payabli
         error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
         raise error_class.new(response.body, code: code)
       end
+
+      # Updates the status of a processed check payment transaction. This endpoint handles the status transition,
+      # updates related bills, creates audit events, and triggers notifications.
+      #
+      # The transaction must meet all of the following criteria:
+      # - **Status**: Must be in Processing or Processed status.
+      # - **Payment method**: Must be a check payment method.
+      #
+      # ### Allowed status values
+      #
+      # | Value | Status | Description |
+      # |-------|--------|-------------|
+      # | `0` | Cancelled/Voided | Cancels the check transaction. Reverts associated bills to their previous state
+      # (Approved or Active), creates "Cancelled" events, and sends a `payout_transaction_voidedcancelled` notification
+      # if the notification is enabled. |
+      # | `5` | Paid | Marks the check transaction as paid. Updates associated bills to "Paid" status, creates "Paid"
+      # events, and sends a `payout_transaction_paid` notification if the notification is enabled. |
+      #
+      # @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] :trans_id
+      # @option params [Payabli::MoneyOutTypes::Types::AllowedCheckPaymentStatus] :check_payment_status
+      #
+      # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
+      def update_check_payment_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: "PATCH",
+          path: "MoneyOut/status/#{params[:trans_id]}/#{params[:check_payment_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::PayabliApiResponse00Responsedatanonobject.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/money_out_types/types/allowed_check_payment_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module MoneyOutTypes
+    module Types
+      module AllowedCheckPaymentStatus
+        extend Payabli::Internal::Types::Enum
+
+        CANCELLED = "0"
+        PAID = "5"
+      end
+    end
+  end
+end

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

@@ -8,7 +8,6 @@ module Payabli
         field :transfer_detail_id, -> { Integer }, optional: false, nullable: true, api_name: "transferDetailId"
         field :transfer_id, -> { Integer }, optional: false, nullable: true, api_name: "transferId"
         field :transaction_id, -> { String }, optional: false, nullable: true, api_name: "transactionId"
-        field :id_out, -> { Integer }, optional: false, nullable: true, api_name: "idOut"
         field :id_out, -> { Integer }, optional: false, nullable: true, api_name: "IdOut"
         field :method_, -> { String }, optional: false, nullable: true, api_name: "method"
         field :type, -> { String }, optional: false, nullable: true

data/lib/payabli/version.rb

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

data/lib/payabli.rb

@@ -688,6 +688,7 @@ require_relative "payabli/types/vendor_response_billing_data"
 require_relative "payabli/types/vendor_data_response_payment_method"
 require_relative "payabli/types/vendor_data_response"
 require_relative "payabli/types/ach_payment_method"
+require_relative "payabli/money_out_types/types/allowed_check_payment_status"
 require_relative "payabli/money_out_types/types/lot_number"
 require_relative "payabli/money_out_types/types/authorize_payment_method"
 require_relative "payabli/money_out_types/types/request_out_authorize_vendor_billing_data"

data/reference.md

@@ -12361,6 +12361,90 @@ in the response when you make a GET request to `/MoneyOut/details/{transId}`.
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">update_check_payment_status</a>(trans_id, check_payment_status) -> Payabli::Types::PayabliApiResponse00Responsedatanonobject</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Updates the status of a processed check payment transaction. This endpoint handles the status transition, updates related bills, creates audit events, and triggers notifications.
+
+The transaction must meet all of the following criteria:
+- **Status**: Must be in Processing or Processed status.
+- **Payment method**: Must be a check payment method.
+
+### Allowed status values
+
+| Value | Status | Description |
+|-------|--------|-------------|
+| `0` | Cancelled/Voided | Cancels the check transaction. Reverts associated bills to their previous state (Approved or Active), creates "Cancelled" events, and sends a `payout_transaction_voidedcancelled` notification if the notification is enabled. |
+| `5` | Paid | Marks the check transaction as paid. Updates associated bills to "Paid" status, creates "Paid" events, and sends a `payout_transaction_paid` notification if the notification is enabled. |
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.money_out.update_check_payment_status(
+  trans_id: 'TRANS123456',
+  check_payment_status: '5'
+);
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**trans_id:** `String` — The Payabli transaction ID for the check payment.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**check_payment_status:** `Payabli::MoneyOutTypes::Types::AllowedCheckPaymentStatus` — The new status to apply to the check transaction. To mark a check as `Paid`, send 5. To mark a check as `Cancelled`, send 0.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Payabli::MoneyOut::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>