payabli 2.2.30 → 2.2.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f98122afd376d3b8d6603e062521de83c172d88d74ae0c2f9c8751dffb1cd733
-  data.tar.gz: 938bf824a70139fdc3230e53346cf35f869dee2d0153f396478da4f41537f154
+  metadata.gz: 65a6a51b90d2388fcf09b7f0aa9de18cb30ce545459abb58c2372dd8587dab85
+  data.tar.gz: 33889d6badf048b9d3e7e4fad702f5570842587fa68fe3e8c710d4bcbc3b735f
 SHA512:
-  metadata.gz: bf7f55d27df12feda51fa579430da5bf71c830ad039a53dfb83ddeb117227a6b197e32a8e970150ef5b8c6c36ea8903c263838f46d83f5dd8e12dd04f7b846f6
-  data.tar.gz: accc230a43d7b4f3819405aee91286d058ec075eeffc4fbd19fc84d381580f089592376a552048e631ae488a5ce1269eb06727ea26c2423c866936633441f0d3
+  metadata.gz: 2e9ac87020343c7264f274b1df4c23800fbb15070a3b22c1d60112237cbbdfa531d437fa96dfa02acfbeb2dea24e04d69418c12ba746c1c8e28e55a2df94dad6
+  data.tar.gz: 1430e213d0e53e6d67f33f0f03a6423cd4f2055ef7d8c109d97a5032d503252d939062ff456d0244d9e126d62edfd0c81c85edd79e2f2823510624d92292fe81

data/.fern/metadata.json

@@ -6,10 +6,8 @@
     "enableWireTests": true,
     "rubocopVariableNumberStyle": "snake_case"
   },
-  "originGitCommit": "8b5226b68ed23f55f2b2cdf29490c8b0cd0c5a14",
+  "originGitCommit": "59a35aa03f5ab140800723e4add1a7933b8cf351",
   "originGitCommitIsDirty": true,
-  "invokedBy": "ci",
-  "requestedVersion": "2.2.30",
-  "ciProvider": "github",
-  "sdkVersion": "2.2.30"
+  "invokedBy": "manual",
+  "sdkVersion": "2.2.32"
 }

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.30",
+          "User-Agent" => "payabli/2.2.32",
           "X-Fern-Language" => "Ruby",
           requestToken: api_key.to_s
         }

data/lib/payabli/invoice/client.rb

@@ -60,7 +60,7 @@ module Payabli
         end
       end
 
-      # Deletes an invoice that's attached to a file.
+      # Deletes a file attached to an invoice.
       #
       # @param request_options [Hash]
       # @param params [Hash]

data/lib/payabli/management/types/bank_account_verification_details_response.rb

@@ -11,7 +11,7 @@ module Payabli
 
         field :is_valid, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "isValid"
 
-        field :error_message, -> { String }, optional: true, nullable: false, api_name: "errorMessage"
+        field :error_message, -> { String }, optional: false, nullable: true, api_name: "errorMessage"
 
         field :verification_response, -> { String }, optional: true, nullable: false, api_name: "verificationResponse"
 
@@ -21,15 +21,15 @@ module Payabli
 
         field :response_description, -> { String }, optional: true, nullable: false, api_name: "responseDescription"
 
-        field :bank_name, -> { String }, optional: true, nullable: false, api_name: "bankName"
+        field :bank_name, -> { String }, optional: false, nullable: true, api_name: "bankName"
 
-        field :reported_account_type, -> { String }, optional: true, nullable: false, api_name: "reportedAccountType"
+        field :reported_account_type, -> { String }, optional: false, nullable: true, api_name: "reportedAccountType"
 
-        field :account_added_date, -> { String }, optional: true, nullable: false, api_name: "accountAddedDate"
+        field :account_added_date, -> { String }, optional: false, nullable: true, api_name: "accountAddedDate"
 
-        field :account_last_updated_date, -> { String }, optional: true, nullable: false, api_name: "accountLastUpdatedDate"
+        field :account_last_updated_date, -> { String }, optional: false, nullable: true, api_name: "accountLastUpdatedDate"
 
-        field :account_closed_date, -> { String }, optional: true, nullable: false, api_name: "accountClosedDate"
+        field :account_closed_date, -> { String }, optional: false, nullable: true, api_name: "accountClosedDate"
       end
     end
   end

data/lib/payabli/notification/client.rb

@@ -10,7 +10,7 @@ module Payabli
         @client = client
       end
 
-      # Create a new notification or autogenerated report.
+      # Create a new notification or auto-generated report.
       #
       # @param request_options [Hash]
       # @param params [Payabli::Notification::Types::AddNotificationRequest]
@@ -44,7 +44,7 @@ module Payabli
         end
       end
 
-      # Deletes a single notification or autogenerated report.
+      # Deletes a single notification or auto-generated report.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -78,7 +78,7 @@ module Payabli
         end
       end
 
-      # Retrieves a single notification or autogenerated report's details.
+      # Retrieves a single notification or auto-generated report's details.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -112,7 +112,7 @@ module Payabli
         end
       end
 
-      # Update a notification or autogenerated report.
+      # Update a notification or auto-generated report.
       #
       # @param request_options [Hash]
       # @param params [Payabli::Notification::Types::UpdateNotificationRequest]

data/lib/payabli/organization/client.rb

@@ -160,7 +160,7 @@ module Payabli
         end
       end
 
-      # Gets an organizations basic details by org ID.
+      # Gets an organization's basic details by org ID.
       #
       # @param request_options [Hash]
       # @param params [Hash]

data/lib/payabli/paypoint/client.rb

@@ -117,7 +117,7 @@ module Payabli
         end
       end
 
-      # Gets the details for single payment page for a paypoint.
+      # Gets the details for a single payment page for a paypoint.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -222,7 +222,7 @@ module Payabli
         end
       end
 
-      # Retrieves an paypoint's basic settings like custom fields, identifiers, and invoicing settings.
+      # Retrieves a paypoint's basic settings like custom fields, identifiers, and invoicing settings.
       #
       # @param request_options [Hash]
       # @param params [Hash]

data/lib/payabli/query/client.rb

@@ -77,7 +77,7 @@ module Payabli
       # @option params [Hash[String, String, nil], nil] :parameters
       # @option params [String, nil] :sort_by
       #
-      # @return [Payabli::Types::QueryResponseSettlements]
+      # @return [Payabli::QueryTypes::Types::QueryBatchesDetailResponse]
       def list_batch_details_org(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
         query_params = {}
@@ -101,7 +101,7 @@ module Payabli
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Payabli::Types::QueryResponseSettlements.load(response.body)
+          Payabli::QueryTypes::Types::QueryBatchesDetailResponse.load(response.body)
         else
           error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)

data/lib/payabli/types/apple_wallet_data.rb

@@ -12,7 +12,7 @@ module Payabli
 
       field :paypoint_name, -> { String }, optional: true, nullable: false, api_name: "paypointName"
 
-      field :paypoint_url, -> { String }, optional: true, nullable: false, api_name: "paypointUrl"
+      field :paypoint_url, -> { String }, optional: false, nullable: true, api_name: "paypointUrl"
 
       field :marked_for_deletion_at, -> { String }, optional: true, nullable: false, api_name: "markedForDeletionAt"
 

data/lib/payabli/types/configure_apple_paypoint_api_response.rb

@@ -13,7 +13,7 @@ module Payabli
 
       field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
 
-      field :room_id, -> { Integer }, optional: true, nullable: false, api_name: "roomId"
+      field :room_id, -> { Integer }, optional: false, nullable: true, api_name: "roomId"
     end
   end
 end

data/lib/payabli/types/configure_google_paypoint_api_response.rb

@@ -13,7 +13,7 @@ module Payabli
 
       field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
 
-      field :room_id, -> { Integer }, optional: true, nullable: false, api_name: "roomId"
+      field :room_id, -> { Integer }, optional: false, nullable: true, api_name: "roomId"
     end
   end
 end

data/lib/payabli/types/general_events.rb

@@ -7,7 +7,7 @@ module Payabli
 
       field :event_time, -> { String }, optional: true, nullable: false, api_name: "eventTime"
 
-      field :extra_data, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false, api_name: "extraData"
+      field :extra_data, -> { String }, optional: true, nullable: false, api_name: "extraData"
 
       field :ref_data, -> { String }, optional: true, nullable: false, api_name: "refData"
 

data/lib/payabli/types/notification_standard_request.rb

@@ -2,7 +2,7 @@
 
 module Payabli
   module Types
-    # Information about the standard notification configuration (email, sms, web).
+    # Information about the standard notification configuration (email, SMS, web).
     class NotificationStandardRequest < Internal::Types::Model
       field :content, -> { Payabli::Types::NotificationStandardRequestContent }, optional: true, nullable: false
 

data/lib/payabli/version.rb

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

data/reference.md

@@ -168,22 +168,9 @@ client.bill.delete_attached_from_bill(
 
 **filename:** `String` 
 
-The filename in Payabli. Filename is `zipName` in response to a
-request to `/api/Invoice/{idInvoice}`. Here, the filename is
-`0_Bill.pdf`. 
-
-```json
-  "DocumentsRef": {
-    "zipfile": "inva_269.zip",
-    "filelist": [
-      {
-        "originalName": "Bill.pdf",
-        "zipName": "0_Bill.pdf",
-        "descriptor": null
-      }
-    ]
-  }
-  ```
+The filename in Payabli. Get this from the `zipName` field
+in the `DocumentsRef.filelist` array returned by
+`/api/Bill/{idBill}`. Example: `0_Bill.pdf`.
     
 </dd>
 </dl>
@@ -191,7 +178,7 @@ request to `/api/Invoice/{idInvoice}`. Here, the filename is
 <dl>
 <dd>
 
-**return_object:** `Internal::Types::Boolean` — When `true`, the request returns the file content as a Base64-encoded string.
+**return_object:** `Internal::Types::Boolean` — When `true`, the response includes the full bill object.
     
 </dd>
 </dl>
@@ -403,17 +390,9 @@ client.bill.get_attached_from_bill(
 
 **filename:** `String` 
 
-The filename in Payabli. Filename is `zipName` in response to a request to `/api/Invoice/{idInvoice}`. Here, the filename is `0_Bill.pdf``. 
-"DocumentsRef": {
-  "zipfile": "inva_269.zip",
-  "filelist": [
-    {
-      "originalName": "Bill.pdf",
-      "zipName": "0_Bill.pdf",
-      "descriptor": null
-    }
-  ]
-}
+The filename in Payabli. Get this from the `zipName` field
+in the `DocumentsRef.filelist` array returned by
+`/api/Bill/{idBill}`. Example: `0_Bill.pdf`.
     
 </dd>
 </dl>
@@ -834,7 +813,7 @@ Modify the list of users the bill is sent to for approval.
 ```ruby
 client.bill.modify_approval_bill(
   id_bill: 285,
-  request: ["string"]
+  request: %w[approver1@example.com approver2@example.com]
 )
 ```
 </dd>
@@ -2328,7 +2307,7 @@ client.charge_backs.get_chargeback(id: 1000000)
 <dl>
 <dd>
 
-**id:** `Integer` — ID of the chargeback or return record. This is returned as `chargebackId` in the [RecievedChargeback](/developers/developer-guides/webhook-payloads#receivedChargeback) and [ReceivedAchReturn](/developers/developer-guides/webhook-payloads#receivedachreturn) webhook notifications.
+**id:** `Integer` — ID of the chargeback or return record. This is returned as `chargebackID` in the [ReceivedChargeBack](/guides/pay-ops-webhooks-payloads#receivedchargeback) and [ReceivedAchReturn](/guides/pay-ops-webhooks-payloads#receivedachreturn) webhook notifications.
     
 </dd>
 </dl>
@@ -8511,7 +8490,7 @@ client.hosted_payment_pages.load_page(
 <dl>
 <dd>
 
-**subdomain:** `String` — Payment page identifier. The subdomain value is the last part of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
+**subdomain:** `String` — Payment page identifier. The subdomain value is the last part of the payment page URL. For example, in `https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
     
 </dd>
 </dl>
@@ -8667,7 +8646,7 @@ client.hosted_payment_pages.save_page(
 <dl>
 <dd>
 
-**subdomain:** `String` — Payment page identifier. The subdomain value is the last part of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
+**subdomain:** `String` — Payment page identifier. The subdomain value is the last part of the payment page URL. For example, in `https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
     
 </dd>
 </dl>
@@ -9019,7 +8998,7 @@ client.invoice.add_invoice(
 <dl>
 <dd>
 
-Deletes an invoice that's attached to a file.
+Deletes a file attached to an invoice.
 </dd>
 </dl>
 </dd>
@@ -9062,17 +9041,9 @@ client.invoice.delete_attached_from_invoice(
 
 **filename:** `String` 
 
-The filename in Payabli. Filename is `zipName` in response to a request to `/api/Invoice/{idInvoice}`. Here, the filename is `0_Bill.pdf``. 
-"DocumentsRef": {
-  "zipfile": "inva_269.zip",
-  "filelist": [
-    {
-      "originalName": "Bill.pdf",
-      "zipName": "0_Bill.pdf",
-      "descriptor": null
-    }
-  ]
-}
+The filename in Payabli. Get this from the `zipName` field
+in the `DocumentsRef.filelist` array returned by
+`/api/Invoice/{idInvoice}`. Example: `0_Bill.pdf`.
     
 </dd>
 </dl>
@@ -9300,19 +9271,9 @@ client.invoice.get_attached_file_from_invoice(
 
 **filename:** `String` 
 
-The filename in Payabli. Filename is `zipName` in the response to a request to `/api/Invoice/{idInvoice}`. Here, the filename is `0_Bill.pdf``. 
-```
-  "DocumentsRef": {
-    "zipfile": "inva_269.zip",
-    "filelist": [
-      {
-        "originalName": "Bill.pdf",
-        "zipName": "0_Bill.pdf",
-        "descriptor": null
-      }
-    ]
-  }
-  ```
+The filename in Payabli. Get this from the `zipName` field
+in the `DocumentsRef.filelist` array returned by
+`/api/Invoice/{idInvoice}`. Example: `0_Bill.pdf`.
     
 </dd>
 </dl>
@@ -13132,7 +13093,7 @@ client.money_out.reissue_out(
 <dl>
 <dd>
 
-Create a new notification or autogenerated report. 
+Create a new notification or auto-generated report. 
 </dd>
 </dl>
 </dd>
@@ -13204,7 +13165,7 @@ client.notification.add_notification(
 <dl>
 <dd>
 
-Deletes a single notification or autogenerated report.
+Deletes a single notification or auto-generated report.
 </dd>
 </dl>
 </dd>
@@ -13266,7 +13227,7 @@ client.notification.delete_notification(n_id: "1717")
 <dl>
 <dd>
 
-Retrieves a single notification or autogenerated report's details.
+Retrieves a single notification or auto-generated report's details.
 </dd>
 </dl>
 </dd>
@@ -13328,7 +13289,7 @@ client.notification.get_notification(n_id: "1717")
 <dl>
 <dd>
 
-Update a notification or autogenerated report. 
+Update a notification or auto-generated report. 
 </dd>
 </dl>
 </dd>
@@ -14504,7 +14465,7 @@ client.organization.get_basic_organization(entry: "8cfec329267")
 <dl>
 <dd>
 
-Gets an organizations basic details by org ID.
+Gets an organization's basic details by org ID.
 </dd>
 </dl>
 </dd>
@@ -16487,7 +16448,7 @@ client.payout_subscription.create_payout_subscription(
     due_date: "2025-08-15"
   }],
   schedule_details: {
-    start_date: "09/01/2025",
+    start_date: "09/01/2027",
     end_date: "09/01/2026",
     frequency: "monthly"
   }
@@ -16938,7 +16899,7 @@ client.paypoint.get_entry_config(entry: "8cfec329267")
 <dl>
 <dd>
 
-Gets the details for single payment page for a paypoint. 
+Gets the details for a single payment page for a paypoint. 
 </dd>
 </dl>
 </dd>
@@ -16979,7 +16940,7 @@ client.paypoint.get_page(
 <dl>
 <dd>
 
-**subdomain:** `String` — Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
+**subdomain:** `String` — Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in `https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
     
 </dd>
 </dl>
@@ -17052,7 +17013,7 @@ client.paypoint.remove_page(
 <dl>
 <dd>
 
-**subdomain:** `String` — Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
+**subdomain:** `String` — Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in `https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
     
 </dd>
 </dl>
@@ -17154,7 +17115,7 @@ client.paypoint.save_logo(entry: "8cfec329267")
 <dl>
 <dd>
 
-Retrieves an paypoint's basic settings like custom fields, identifiers, and invoicing settings.
+Retrieves a paypoint's basic settings like custom fields, identifiers, and invoicing settings.
 </dd>
 </dl>
 </dd>
@@ -17462,7 +17423,7 @@ Example: `settledAmount(gt)=20` returns all records with a `settledAmount` great
 </dl>
 </details>
 
-<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batch_details_org</a>(org_id) -> Payabli::Types::QueryResponseSettlements</code></summary>
+<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batch_details_org</a>(org_id) -> Payabli::QueryTypes::Types::QueryBatchesDetailResponse</code></summary>
 <dl>
 <dd>
 
@@ -24161,10 +24122,10 @@ Retrieves the basic statistics for an organization or a paypoint, for a given ti
 client.statistic.basic_stats(
   entry_id: 1000000,
   freq: "m",
-  level: 1,
-  mode: "ytd",
-  end_date: "2025-11-01",
-  start_date: "2025-11-30"
+  level: 2,
+  mode: "custom",
+  start_date: "2025-11-01",
+  end_date: "2025-11-30"
 )
 ```
 </dd>
@@ -24434,7 +24395,7 @@ Retrieves the subscription statistics for a given interval for a paypoint or org
 client.statistic.sub_stats(
   entry_id: 1000000,
   interval: "30",
-  level: 1
+  level: 2
 )
 ```
 </dd>
@@ -24978,7 +24939,7 @@ client.templates.delete_template(template_id: 80)
 <dl>
 <dd>
 
-**template_id:** `Integer` — The boarding template ID. Can be found at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
+**template_id:** `Integer` — The boarding template ID. You can find this at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
     
 </dd>
 </dl>
@@ -25043,7 +25004,7 @@ client.templates.getlink_template(
 <dl>
 <dd>
 
-**template_id:** `Integer` — The boarding template ID. Can be found at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
+**template_id:** `Integer` — The boarding template ID. You can find this at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
     
 </dd>
 </dl>
@@ -25051,7 +25012,7 @@ client.templates.getlink_template(
 <dl>
 <dd>
 
-**ignore_empty:** `Internal::Types::Boolean` — Ignore read-only and empty fields Default is `false`. If `ignoreEmpty` = `false` and any field is empty, then the request returns a failure response. If `ignoreEmpty` = `true`, the request returns the boarding link name regardless of whether fields are empty.
+**ignore_empty:** `Internal::Types::Boolean` — Ignore read-only and empty fields. Default is `false`. If `ignoreEmpty` = `false` and any field is empty, then the request returns a failure response. If `ignoreEmpty` = `true`, the request returns the boarding link name regardless of whether fields are empty.
     
 </dd>
 </dl>
@@ -25113,7 +25074,7 @@ client.templates.get_template(template_id: 80)
 <dl>
 <dd>
 
-**template_id:** `Integer` — The boarding template ID. Can be found at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
+**template_id:** `Integer` — The boarding template ID. You can find this at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
     
 </dd>
 </dl>
@@ -25881,7 +25842,7 @@ client.user.auth_user(provider: "provider")
 <dl>
 <dd>
 
-**provider:** `String` — Auth provider. This fields is optional and defaults to null for the built-in provider.
+**provider:** `String` — Auth provider. Pass `null` to use the built-in provider.
     
 </dd>
 </dl>