payabli 2.1.5 → 2.2.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c63cd87b466b55d3321c6fcec2e99d2ccd64246958664133b47d868fec929b96
-  data.tar.gz: 0734a054554e6eb7befe3b2d47d47c94c86ed692c2817718ac6c6447cb846aad
+  metadata.gz: 4e5570a4534220a2d2377264e01967db162cf12480b0bc7c1c3dc66d43291808
+  data.tar.gz: 14d647dfa19da2a6f973bf98416544c60016a1ab3e593ae0135a80ab1a2ed768
 SHA512:
-  metadata.gz: 27185c0e06c9d73f14a4f346dd38e4ab4f24e0171ba4c6adc875d14f9d779758527f46a27dd01cedea7f355e595bee2569a689ddbb3d389b73e460665965757b
-  data.tar.gz: b4576a283d9f9c3c1d475613f04fecc504119a0c2cbe6f89752ce49a1c5984b1621a97f0144dfee09769d2b1f90511c2669d1f8882a0041b4a588d6547b6a2a8
+  metadata.gz: 14ecdae519c81169a049294d59bcd4f2c86255e6f32b3122517b86b2b16693b0905332a8f62eabc0d8558bc5c84006655fca2314c5eeb59fb4651e64a6525e3b
+  data.tar.gz: b3bb126add655d34888c4ee569d528d1e29e36ccd85dd010f5b994581a2a3e39b7284d4edfc17253a26aa8d802d8287058bcd8c5fe037e94b7c5a9433ba67150

data/.fern/metadata.json

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

data/.fernignore

@@ -1,3 +1,4 @@
 # Specify files that shouldn't be modified by Fern
 test/unit/custom_test.rb
 .github/workflows/ci.yml
+LICENSE.md

data/LICENSE.md

@@ -0,0 +1,8 @@
+Copyright (c) 2025 Payabli, Inc.
+
+All Rights Reserved.
+
+This source code is the proprietary property of Payabli, Inc. 
+The source code contained herein is made available for inspection 
+and reference purposes only. No license is granted to use, modify, 
+distribute, or create derivative works from this source code.

data/README.md

@@ -8,11 +8,15 @@ The Payabli Ruby library provides convenient access to the Payabli APIs from Rub
 
 - [Documentation](#documentation)
 - [Reference](#reference)
+- [Passing Query Parameters](#passing-query-parameters)
 - [Usage](#usage)
 - [Environments](#environments)
 - [Errors](#errors)
 - [Advanced](#advanced)
+  - [Retries](#retries)
   - [Timeouts](#timeouts)
+  - [Additional Headers](#additional-headers)
+  - [Additional Query Parameters](#additional-query-parameters)
 - [Contributing](#contributing)
 
 ## Documentation
@@ -23,6 +27,31 @@ API reference documentation is available [here](https://docs.payabli.com).
 
 A full reference for this library is available [here](https://github.com/payabli/sdk-ruby/blob/HEAD/./reference.md).
 
+## Passing Query Parameters
+
+```ruby
+client = Payabli::Client.new(
+    api_key: "API_KEY",
+    base_url: Payabli::Environment::SANDBOX
+)
+
+entry_point = "ENTRYPOINT"
+
+result = client.query.list_customers(
+  request_options: {
+    additional_query_parameters: {
+      "email(ct)": "test@example.com",
+    }
+  }, 
+  **{
+    entry: entry_point,
+  }
+)
+
+puts result.to_h
+```
+
+
 ## Usage
 
 Instantiate and use the client with the following:
@@ -103,6 +132,28 @@ end
 
 ## Advanced
 
+### Retries
+
+The SDK is instrumented with automatic retries. A request will be retried as long as the request is deemed
+retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` option to configure this behavior.
+
+```ruby
+require "payabli"
+
+client = Payabli::Client.new(
+    base_url: "https://example.com",
+    max_retries: 3  # Configure max retries (default is 2)
+)
+```
+
 ### Timeouts
 
 The SDK defaults to a 60 second timeout. Use the `timeout` option to configure this behavior.
@@ -116,6 +167,40 @@ response = client.money_in.getpaid(
 )
 ```
 
+### Additional Headers
+
+If you would like to send additional headers as part of the request, use the `additional_headers` request option.
+
+```ruby
+require "payabli"
+
+response = client.money_in.getpaid(
+    ...,
+    request_options: {
+        additional_headers: {
+            "X-Custom-Header" => "custom-value"
+        }
+    }
+)
+```
+
+### Additional Query Parameters
+
+If you would like to send additional query parameters as part of the request, use the `additional_query_parameters` request option.
+
+```ruby
+require "payabli"
+
+response = client.money_in.getpaid(
+    ...,
+    request_options: {
+        additional_query_parameters: {
+            "custom_param" => "custom-value"
+        }
+    }
+)
+```
+
 ## Contributing
 
 While we value open-source contributions to this SDK, this library is generated programmatically.

data/lib/payabli/bill/client.rb

@@ -24,13 +24,18 @@ module Payabli
       #
       # @return [Payabli::Bill::Types::BillResponse]
       def add_bill(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         path_param_names = %i[entry]
         body_params = params.except(*path_param_names)
 
+        headers = {}
+        headers["idempotencyKey"] = params[:idempotency_key] if params[:idempotency_key]
+
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "POST",
           path: "Bill/single/#{params[:entry]}",
+          headers: headers,
           body: Payabli::Bill::Types::BillOutData.new(body_params).to_h,
           request_options: request_options
         )
@@ -63,7 +68,7 @@ module Payabli
       #
       # @return [Payabli::Bill::Types::BillResponse]
       def delete_attached_from_bill(request_options: {}, **params)
-        params = Payabli::Internal::Types::Utils.symbolize_keys(params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         query_param_names = %i[return_object]
         query_params = {}
         query_params["returnObject"] = params[:return_object] if params.key?(:return_object)
@@ -103,6 +108,7 @@ module Payabli
       #
       # @return [Payabli::Bill::Types::BillResponse]
       def delete_bill(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "DELETE",
@@ -136,6 +142,7 @@ module Payabli
       #
       # @return [Payabli::Bill::Types::EditBillResponse]
       def edit_bill(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "PUT",
@@ -172,7 +179,7 @@ module Payabli
       #
       # @return [Payabli::Types::FileContent]
       def get_attached_from_bill(request_options: {}, **params)
-        params = Payabli::Internal::Types::Utils.symbolize_keys(params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         query_param_names = %i[return_object]
         query_params = {}
         query_params["returnObject"] = params[:return_object] if params.key?(:return_object)
@@ -212,6 +219,7 @@ module Payabli
       #
       # @return [Payabli::Bill::Types::GetBillResponse]
       def get_bill(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",
@@ -251,7 +259,7 @@ module Payabli
       #
       # @return [Payabli::Types::BillQueryResponse]
       def list_bills(request_options: {}, **params)
-        params = Payabli::Internal::Types::Utils.symbolize_keys(params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         query_param_names = %i[export_format from_record limit_record parameters sort_by]
         query_params = {}
         query_params["exportFormat"] = params[:export_format] if params.key?(:export_format)
@@ -301,7 +309,7 @@ module Payabli
       #
       # @return [Payabli::Types::BillQueryResponse]
       def list_bills_org(request_options: {}, **params)
-        params = Payabli::Internal::Types::Utils.symbolize_keys(params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         query_param_names = %i[export_format from_record limit_record parameters sort_by]
         query_params = {}
         query_params["exportFormat"] = params[:export_format] if params.key?(:export_format)
@@ -345,6 +353,7 @@ module Payabli
       #
       # @return [Payabli::Bill::Types::ModifyApprovalBillResponse]
       def modify_approval_bill(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "PUT",
@@ -381,19 +390,23 @@ module Payabli
       #
       # @return [Payabli::Bill::Types::BillResponse]
       def send_to_approval_bill(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         path_param_names = %i[id_bill]
         body_params = params.except(*path_param_names)
 
-        params = Payabli::Internal::Types::Utils.symbolize_keys(params)
         query_param_names = %i[autocreate_user]
         query_params = {}
         query_params["autocreateUser"] = params[:autocreate_user] if params.key?(:autocreate_user)
         params = params.except(*query_param_names)
 
+        headers = {}
+        headers["idempotencyKey"] = params[:idempotency_key] if params[:idempotency_key]
+
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "POST",
           path: "Bill/approval/#{params[:id_bill]}",
+          headers: headers,
           query: query_params,
           body: body_params,
           request_options: request_options
@@ -427,7 +440,7 @@ module Payabli
       #
       # @return [Payabli::Bill::Types::SetApprovedBillResponse]
       def set_approved_bill(request_options: {}, **params)
-        params = Payabli::Internal::Types::Utils.symbolize_keys(params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         query_param_names = %i[email]
         query_params = {}
         query_params["email"] = params[:email] if params.key?(:email)

data/lib/payabli/boarding/client.rb

@@ -22,6 +22,7 @@ module Payabli
       #
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def add_application(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",
@@ -56,6 +57,7 @@ module Payabli
       #
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def delete_application(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "DELETE",
@@ -89,6 +91,7 @@ module Payabli
       #
       # @return [Payabli::Types::ApplicationDetailsRecord]
       def get_application(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",
@@ -122,16 +125,16 @@ module Payabli
       #
       # @return [Payabli::Types::ApplicationQueryRecord]
       def get_application_by_auth(request_options: {}, **params)
-        path_param_names = %i[x_id]
-        body_params = params.except(*path_param_names)
-        body_prop_names = %i[email reference_id]
-        body_bag = body_params.slice(*body_prop_names)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        request_data = Payabli::Boarding::Types::RequestAppByAuth.new(params).to_h
+        non_body_param_names = ["xId"]
+        body = request_data.except(*non_body_param_names)
 
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "POST",
           path: "Boarding/read/#{params[:x_id]}",
-          body: Payabli::Boarding::Types::RequestAppByAuth.new(body_bag).to_h,
+          body: body,
           request_options: request_options
         )
         begin
@@ -161,6 +164,7 @@ module Payabli
       #
       # @return [Payabli::Types::BoardingLinkQueryRecord]
       def get_by_id_link_application(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",
@@ -194,6 +198,7 @@ module Payabli
       #
       # @return [Payabli::Types::BoardingLinkQueryRecord]
       def get_by_template_id_link_application(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",
@@ -231,7 +236,7 @@ module Payabli
       #
       # @return [Payabli::Types::PayabliApiResponse00]
       def get_external_application(request_options: {}, **params)
-        params = Payabli::Internal::Types::Utils.symbolize_keys(params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         query_param_names = %i[send_email]
         query_params = {}
         query_params["sendEmail"] = params[:send_email] if params.key?(:send_email)
@@ -271,6 +276,7 @@ module Payabli
       #
       # @return [Payabli::Types::BoardingLinkQueryRecord]
       def get_link_application(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",
@@ -310,7 +316,7 @@ module Payabli
       #
       # @return [Payabli::Types::QueryBoardingAppsListResponse]
       def list_applications(request_options: {}, **params)
-        params = Payabli::Internal::Types::Utils.symbolize_keys(params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         query_param_names = %i[export_format from_record limit_record parameters sort_by]
         query_params = {}
         query_params["exportFormat"] = params[:export_format] if params.key?(:export_format)
@@ -358,7 +364,7 @@ module Payabli
       #
       # @return [Payabli::Types::QueryBoardingLinksResponse]
       def list_boarding_links(request_options: {}, **params)
-        params = Payabli::Internal::Types::Utils.symbolize_keys(params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         query_param_names = %i[from_record limit_record parameters sort_by]
         query_params = {}
         query_params["fromRecord"] = params[:from_record] if params.key?(:from_record)
@@ -401,6 +407,7 @@ module Payabli
       #
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def update_application(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "PUT",

data/lib/payabli/charge_backs/client.rb

@@ -24,16 +24,20 @@ module Payabli
       #
       # @return [Payabli::ChargeBacks::Types::AddResponseResponse]
       def add_response(request_options: {}, **params)
-        path_param_names = %i[id]
-        body_params = params.except(*path_param_names)
-        body_prop_names = %i[attachments contact_email contact_name notes]
-        body_bag = body_params.slice(*body_prop_names)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        request_data = Payabli::ChargeBacks::Types::ResponseChargeBack.new(params).to_h
+        non_body_param_names = %w[Id idempotencyKey]
+        body = request_data.except(*non_body_param_names)
+
+        headers = {}
+        headers["idempotencyKey"] = params[:idempotency_key] if params[:idempotency_key]
 
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "POST",
           path: "ChargeBacks/response/#{params[:id]}",
-          body: Payabli::ChargeBacks::Types::ResponseChargeBack.new(body_bag).to_h,
+          headers: headers,
+          body: body,
           request_options: request_options
         )
         begin
@@ -63,6 +67,7 @@ module Payabli
       #
       # @return [Payabli::ChargeBacks::Types::ChargebackQueryRecords]
       def get_chargeback(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",
@@ -97,6 +102,7 @@ module Payabli
       #
       # @return [String]
       def get_chargeback_attachment(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",

data/lib/payabli/check_capture/client.rb

@@ -24,14 +24,12 @@ module Payabli
       #
       # @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)
-
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "POST",
           path: "CheckCapture/CheckProcessing",
-          body: Payabli::CheckCapture::Types::CheckCaptureRequestBody.new(body_bag).to_h,
+          body: Payabli::CheckCapture::Types::CheckCaptureRequestBody.new(params).to_h,
           request_options: request_options
         )
         begin

data/lib/payabli/client.rb

@@ -6,11 +6,11 @@ module Payabli
     # @param api_key [String]
     #
     # @return [void]
-    def initialize(base_url:, api_key:)
+    def initialize(api_key:, base_url: nil)
       @raw_client = Payabli::Internal::Http::RawClient.new(
         base_url: base_url || Payabli::Environment::SANDBOX,
         headers: {
-          "User-Agent" => "payabli-sdk/2.1.5",
+          "User-Agent" => "payabli/2.2.15",
           "X-Fern-Language" => "Ruby",
           requestToken: api_key.to_s
         }

data/lib/payabli/cloud/client.rb

@@ -25,16 +25,20 @@ module Payabli
       #
       # @return [Payabli::Cloud::Types::AddDeviceResponse]
       def add_device(request_options: {}, **params)
-        path_param_names = %i[entry]
-        body_params = params.except(*path_param_names)
-        body_prop_names = %i[description registration_code]
-        body_bag = body_params.slice(*body_prop_names)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        request_data = Payabli::Cloud::Types::DeviceEntry.new(params).to_h
+        non_body_param_names = %w[entry idempotencyKey]
+        body = request_data.except(*non_body_param_names)
+
+        headers = {}
+        headers["idempotencyKey"] = params[:idempotency_key] if params[:idempotency_key]
 
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "POST",
           path: "Cloud/register/#{params[:entry]}",
-          body: Payabli::Cloud::Types::DeviceEntry.new(body_bag).to_h,
+          headers: headers,
+          body: body,
           request_options: request_options
         )
         begin
@@ -65,6 +69,7 @@ module Payabli
       #
       # @return [Payabli::Types::CloudQueryApiResponse]
       def history_device(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",
@@ -99,7 +104,7 @@ module Payabli
       #
       # @return [Payabli::Types::CloudQueryApiResponse]
       def list_device(request_options: {}, **params)
-        params = Payabli::Internal::Types::Utils.symbolize_keys(params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         query_param_names = %i[force_refresh]
         query_params = {}
         query_params["forceRefresh"] = params[:force_refresh] if params.key?(:force_refresh)
@@ -140,6 +145,7 @@ module Payabli
       #
       # @return [Payabli::Cloud::Types::RemoveDeviceResponse]
       def remove_device(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "DELETE",

data/lib/payabli/customer/client.rb

@@ -28,20 +28,24 @@ module Payabli
       #
       # @return [Payabli::Types::PayabliApiResponseCustomerQuery]
       def add_customer(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         path_param_names = %i[entry]
         body_params = params.except(*path_param_names)
 
-        params = Payabli::Internal::Types::Utils.symbolize_keys(params)
         query_param_names = %i[force_customer_creation replace_existing]
         query_params = {}
         query_params["forceCustomerCreation"] = params[:force_customer_creation] if params.key?(:force_customer_creation)
         query_params["replaceExisting"] = params[:replace_existing] if params.key?(:replace_existing)
         params = params.except(*query_param_names)
 
+        headers = {}
+        headers["idempotencyKey"] = params[:idempotency_key] if params[:idempotency_key]
+
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "POST",
           path: "Customer/single/#{params[:entry]}",
+          headers: headers,
           query: query_params,
           body: Payabli::Types::CustomerData.new(body_params).to_h,
           request_options: request_options
@@ -73,6 +77,7 @@ module Payabli
       #
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def delete_customer(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "DELETE",
@@ -106,6 +111,7 @@ module Payabli
       #
       # @return [Payabli::Types::CustomerQueryRecords]
       def get_customer(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",
@@ -140,6 +146,7 @@ module Payabli
       #
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def link_customer_transaction(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",
@@ -173,6 +180,7 @@ module Payabli
       #
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def request_consent(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",
@@ -206,6 +214,7 @@ module Payabli
       #
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def update_customer(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "PUT",