payabli 0.0.486 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a78a6dd0a21617ba21e0125fcb5c3bf5059f7d1f04d3dd62afaa263bc5cfa93
-  data.tar.gz: 323ace38d78bea0447ec9d902cf352f97821da6f2ab518cf2228d83718f4663d
+  metadata.gz: 5882844e5431ac871ff8a2a376164206612536fc75c7952c07ac877533aa1388
+  data.tar.gz: ce4a667f8ce22c3c02b593180c379efe4403110f73f99427c5186df742f9cf61
 SHA512:
-  metadata.gz: e71a0a50197fa8314276c5a93d136c831b7f936c41e35499eb6f10a10740973e653d9b7310c4e99c64f4470c19ba63da6f53dd36eab562b1e9663774eaf7d420
-  data.tar.gz: d5fdb7fbf34219244f99b37884853e48a4d808e32f30684aee8c57d4941a166e3ec23c3fe7239b751d18c789a50ca5685afa6cdb71e5757eb313fbdd3da8d78a
+  metadata.gz: 5e737d1303f5f79f51e8b0209e545d5b74bc8c47fe36157ba844a68b840281544254a80f2d788f17cfebb2bdf569916aaf2f90393b1c7657e643b1afebf4a301
+  data.tar.gz: ef6cf59e2ba75346ff158aae88dd3063988541c9c39fc5d069c415ab7f01c7ce98a9ae1a76727ef79be7a1aab7baa87c15cd16f1625e9e9e8a497eb22073c66b

data/.fern/metadata.json

@@ -1,5 +1,5 @@
 {
   "cliVersion": "2.1.0",
   "generatorName": "fernapi/fern-ruby-sdk",
-  "generatorVersion": "1.0.0-rc42"
+  "generatorVersion": "1.0.0-rc39"
 }

data/lib/payabli/bill/client.rb

@@ -5,22 +5,16 @@ module Payabli
     class Client
       # @param client [Payabli::Internal::Http::RawClient]
       #
-      # @return [void]
+      # @return [Payabli::Bill::Client]
       def initialize(client:)
         @client = client
       end
 
       # Creates a bill in an entrypoint.
       #
-      # @param request_options [Hash]
+      # @param request_options [Payabli::RequestOptions]
+      #
       # @param params [Payabli::Bill::Types::BillOutData]
-      # @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
-      # @option params [String, nil] :idempotency_key
       #
       # @return [Payabli::Bill::Types::BillResponse]
       def add_bill(request_options: {}, **params)
@@ -49,16 +43,9 @@ module Payabli
 
       # Delete a file attached to a bill.
       #
-      # @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_bill
-      # @option params [String] :filename
-      # @option params [Boolean, nil] :return_object
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Bill::Types::BillResponse]
       def delete_attached_from_bill(request_options: {}, **params)
@@ -90,14 +77,9 @@ module Payabli
 
       # Deletes a bill by ID.
       #
-      # @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_bill
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Bill::Types::BillResponse]
       def delete_bill(request_options: {}, **params)
@@ -122,14 +104,9 @@ module Payabli
 
       # Updates a bill by ID.
       #
-      # @param request_options [Hash]
+      # @param request_options [Payabli::RequestOptions]
+      #
       # @param params [Payabli::Bill::Types::BillOutData]
-      # @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_bill
       #
       # @return [Payabli::Bill::Types::EditBillResponse]
       def edit_bill(request_options: {}, **params)
@@ -155,16 +132,9 @@ module Payabli
 
       # Retrieves a file attached to a bill, either as a binary file or as a Base64-encoded string.
       #
-      # @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_bill
-      # @option params [String] :filename
-      # @option params [Boolean, nil] :return_object
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Types::FileContent]
       def get_attached_from_bill(request_options: {}, **params)
@@ -196,14 +166,9 @@ module Payabli
 
       # Retrieves a bill by ID from an entrypoint.
       #
-      # @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_bill
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Bill::Types::GetBillResponse]
       def get_bill(request_options: {}, **params)
@@ -228,19 +193,9 @@ module Payabli
 
       # Retrieve a list of bills for an entrypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
       #
-      # @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] :entry
-      # @option params [Payabli::Types::ExportFormat, nil] :export_format
-      # @option params [Integer, nil] :from_record
-      # @option params [Integer, nil] :limit_record
-      # @option params [Hash[String, String, nil], nil] :parameters
-      # @option params [String, nil] :sort_by
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Types::BillQueryResponse]
       def list_bills(request_options: {}, **params)
@@ -276,19 +231,9 @@ module Payabli
 
       # Retrieve a list of bills for an organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
       #
-      # @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] :org_id
-      # @option params [Payabli::Types::ExportFormat, nil] :export_format
-      # @option params [Integer, nil] :from_record
-      # @option params [Integer, nil] :limit_record
-      # @option params [Hash[String, String, nil], nil] :parameters
-      # @option params [String, nil] :sort_by
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Types::BillQueryResponse]
       def list_bills_org(request_options: {}, **params)
@@ -324,14 +269,9 @@ module Payabli
 
       # Modify the list of users the bill is sent to for approval.
       #
-      # @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_bill
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Bill::Types::ModifyApprovalBillResponse]
       def modify_approval_bill(request_options: {}, **params)
@@ -357,16 +297,9 @@ module Payabli
 
       # Send a bill to a user or list of users to approve.
       #
-      # @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_bill
-      # @option params [Boolean, nil] :autocreate_user
-      # @option params [String, nil] :idempotency_key
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Bill::Types::BillResponse]
       def send_to_approval_bill(request_options: {}, **params)
@@ -399,16 +332,9 @@ module Payabli
 
       # Approve or disapprove a bill by ID.
       #
-      # @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_bill
-      # @option params [String] :approved
-      # @option params [String, nil] :email
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Bill::Types::SetApprovedBillResponse]
       def set_approved_bill(request_options: {}, **params)

data/lib/payabli/boarding/client.rb

@@ -5,20 +5,16 @@ module Payabli
     class Client
       # @param client [Payabli::Internal::Http::RawClient]
       #
-      # @return [void]
+      # @return [Payabli::Boarding::Client]
       def initialize(client:)
         @client = client
       end
 
       # Creates a boarding application in an organization. This endpoint requires an application API token.
       #
-      # @param request_options [Hash]
+      # @param request_options [Payabli::RequestOptions]
+      #
       # @param params [Payabli::Boarding::Types::AddApplicationRequest]
-      # @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
       #
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def add_application(request_options: {}, **params)
@@ -44,14 +40,9 @@ module Payabli
 
       # Deletes a boarding application by ID.
       #
-      # @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] :app_id
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def delete_application(request_options: {}, **params)
@@ -76,14 +67,9 @@ module Payabli
 
       # Retrieves the details for a boarding application by ID.
       #
-      # @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] :app_id
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Types::ApplicationDetailsRecord]
       def get_application(request_options: {}, **params)
@@ -108,14 +94,9 @@ module Payabli
 
       # Gets a boarding application by authentication information. This endpoint requires an `application` API token.
       #
-      # @param request_options [Hash]
+      # @param request_options [Payabli::RequestOptions]
+      #
       # @param params [Payabli::Boarding::Types::RequestAppByAuth]
-      # @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] :x_id
       #
       # @return [Payabli::Types::ApplicationQueryRecord]
       def get_application_by_auth(request_options: {}, **params)
@@ -146,14 +127,9 @@ module Payabli
 
       # Retrieves details for a boarding link, by ID.
       #
-      # @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] :boarding_link_id
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Types::BoardingLinkQueryRecord]
       def get_by_id_link_application(request_options: {}, **params)
@@ -178,14 +154,9 @@ module Payabli
 
       # Get details for a boarding link using the boarding template ID. This endpoint requires an application API token.
       #
-      # @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] :template_id
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Types::BoardingLinkQueryRecord]
       def get_by_template_id_link_application(request_options: {}, **params)
@@ -210,16 +181,9 @@ module Payabli
 
       # Retrieves a link and the verification code used to log into an existing boarding application. You can also use this endpoint to send a link and referenceId for an existing boarding application to an email address. The recipient can use the referenceId and email address to access and edit the application.
       #
-      # @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] :app_id
-      # @option params [String] :mail_2
-      # @option params [Boolean, nil] :send_email
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Types::PayabliApiResponse00]
       def get_external_application(request_options: {}, **params)
@@ -251,14 +215,9 @@ module Payabli
 
       # Retrieves the details for a boarding link, by reference name. This endpoint requires an application API token.
       #
-      # @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] :boarding_link_reference
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Types::BoardingLinkQueryRecord]
       def get_link_application(request_options: {}, **params)
@@ -283,19 +242,9 @@ module Payabli
 
       # Returns a list of boarding applications for an organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
       #
-      # @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] :org_id
-      # @option params [Payabli::Types::ExportFormat, nil] :export_format
-      # @option params [Integer, nil] :from_record
-      # @option params [Integer, nil] :limit_record
-      # @option params [Hash[String, String, nil], nil] :parameters
-      # @option params [String, nil] :sort_by
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Types::QueryBoardingAppsListResponse]
       def list_applications(request_options: {}, **params)
@@ -331,18 +280,9 @@ module Payabli
 
       # Return a list of boarding links for an organization. Use filters to limit results.
       #
-      # @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] :org_id
-      # @option params [Integer, nil] :from_record
-      # @option params [Integer, nil] :limit_record
-      # @option params [Hash[String, String, nil], nil] :parameters
-      # @option params [String, nil] :sort_by
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Types::QueryBoardingLinksResponse]
       def list_boarding_links(request_options: {}, **params)
@@ -377,14 +317,9 @@ module Payabli
 
       # Updates a boarding application by ID. This endpoint requires an application API token.
       #
-      # @param request_options [Hash]
+      # @param request_options [Payabli::RequestOptions]
+      #
       # @param params [Payabli::Types::ApplicationData]
-      # @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] :app_id
       #
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def update_application(request_options: {}, **params)

data/lib/payabli/charge_backs/client.rb

@@ -5,22 +5,16 @@ module Payabli
     class Client
       # @param client [Payabli::Internal::Http::RawClient]
       #
-      # @return [void]
+      # @return [Payabli::ChargeBacks::Client]
       def initialize(client:)
         @client = client
       end
 
       # Add a response to a chargeback or ACH return.
       #
-      # @param request_options [Hash]
+      # @param request_options [Payabli::RequestOptions]
+      #
       # @param params [Payabli::ChargeBacks::Types::ResponseChargeBack]
-      # @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
-      # @option params [String, nil] :idempotency_key
       #
       # @return [Payabli::ChargeBacks::Types::AddResponseResponse]
       def add_response(request_options: {}, **params)
@@ -51,14 +45,9 @@ module Payabli
 
       # Retrieves a chargeback record and its details.
       #
-      # @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
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::ChargeBacks::Types::ChargebackQueryRecords]
       def get_chargeback(request_options: {}, **params)
@@ -81,15 +70,9 @@ module Payabli
         end
       end
 
-      # @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
-      # @option params [String] :file_name
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [String]
       def get_chargeback_attachment(request_options: {}, **params)

data/lib/payabli/check_capture/client.rb

@@ -5,20 +5,16 @@ module Payabli
     class Client
       # @param client [Payabli::Internal::Http::RawClient]
       #
-      # @return [void]
+      # @return [Payabli::CheckCapture::Client]
       def initialize(client:)
         @client = client
       end
 
       # Captures a check for Remote Deposit Capture (RDC) using the provided check images and details. This endpoint handles the OCR extraction of check data including MICR, routing number, account number, and amount. See the [RDC guide](/developers/developer-guides/pay-in-rdc) for more details.
       #
-      # @param request_options [Hash]
+      # @param request_options [Payabli::RequestOptions]
+      #
       # @param params [Payabli::CheckCapture::Types::CheckCaptureRequestBody]
-      # @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
       #
       # @return [Payabli::CheckCapture::Types::CheckCaptureResponse]
       def check_processing(request_options: {}, **params)

data/lib/payabli/client.rb

@@ -2,14 +2,15 @@
 
 module Payabli
   class Client
-    # @param base_url [String, nil]
+    # @param base_url [String | nil]
     # @param api_key [String]
     #
-    # @return [void]
+    # @return [Payabli::Client]
     def initialize(base_url:, api_key:)
       @raw_client = Payabli::Internal::Http::RawClient.new(
         base_url: base_url,
         headers: {
+          "User-Agent": "payabli-sdk/2.0.0",
           "X-Fern-Language": "Ruby",
           requestToken: api_key.to_s
         }

data/lib/payabli/cloud/client.rb

@@ -5,22 +5,16 @@ module Payabli
     class Client
       # @param client [Payabli::Internal::Http::RawClient]
       #
-      # @return [void]
+      # @return [Payabli::Cloud::Client]
       def initialize(client:)
         @client = client
       end
 
       # Register a cloud device to an entrypoint. See [Devices Quickstart](/developers/developer-guides/devices-quickstart#devices-quickstart) for a complete guide.
       #
-      # @param request_options [Hash]
+      # @param request_options [Payabli::RequestOptions]
+      #
       # @param params [Payabli::Cloud::Types::DeviceEntry]
-      # @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
-      # @option params [String, nil] :idempotency_key
       #
       # @return [Payabli::Cloud::Types::AddDeviceResponse]
       def add_device(request_options: {}, **params)
@@ -51,15 +45,9 @@ module Payabli
 
       # Retrieve the registration history for a device.
       #
-      # @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] :entry
-      # @option params [String] :device_id
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Types::CloudQueryApiResponse]
       def history_device(request_options: {}, **params)
@@ -84,15 +72,9 @@ module Payabli
 
       # Get a list of cloud devices registered to an entrypoint.
       #
-      # @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] :entry
-      # @option params [Boolean, nil] :force_refresh
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Types::CloudQueryApiResponse]
       def list_device(request_options: {}, **params)
@@ -124,15 +106,9 @@ module Payabli
 
       # Remove a cloud device from an entrypoint.
       #
-      # @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] :entry
-      # @option params [String] :device_id
+      # @param request_options [Payabli::RequestOptions]
+      #
+      # @param params [Hash[untyped, untyped]]
       #
       # @return [Payabli::Cloud::Types::RemoveDeviceResponse]
       def remove_device(request_options: {}, **params)