payabli 3.0.12 → 3.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0144b8863c13e815b04ac5deeb134ec9ff868dee0f613ebdb32c30f65fcc4e53
-  data.tar.gz: 2480d71e0c0ff34170adf2da7059c19e5ff6e133939639d2e19b4120a70642f5
+  metadata.gz: 147a9430a2f80e4414a0b5809e18fce98312c5345ab53e37ef7a0abcdcbd35b1
+  data.tar.gz: '0882e1a96a2c8cedc591bffb46399be9b10a1e790a66dcaeb0f0b0f793a5b262'
 SHA512:
-  metadata.gz: 4f72da83aae935c0a21d6a95f45547261c3557a06a169c210b26a6ca114eb8f341581be1e6cc805b1ab2ad55afc8294f1348c93c2cb55923bc36f1896531f2c6
-  data.tar.gz: 1018bb7c00bec622ea398c474c8a90ce426a6348375d9a08984c70d8d2f1bca7a1d5389d21cae149d01bd0a713e35ace4ce506884cb2dc744d6adc3f216c315c
+  metadata.gz: 5fbb7ffcd3229b83e79e204bc0148d5d6b79a6c5ca403672f2c53c4e18e4b86afaa80f860dcbc232a2c18a0ce7c4ceba60d3e6b948726e554d6c8bde1442ad30
+  data.tar.gz: 1fa9e94b9e828ce81b0bc446446880eb66e35c9a95c144da155eec8ce5c2227306d28288e3f8324d52cb40ef16bded0ed61dbd1c79f40cdb10bd45a6b397ce12

data/.fern/metadata.json

@@ -1,5 +1,5 @@
 {
-  "cliVersion": "5.98.1",
+  "cliVersion": "5.128.3",
   "generatorName": "fernapi/fern-ruby-sdk",
   "generatorVersion": "1.24.0",
   "generatorConfig": {
@@ -7,10 +7,10 @@
     "rubocopVariableNumberStyle": "snake_case",
     "respectOptionalRequestBody": true
   },
-  "originGitCommit": "75a6ae666f6df6ac60fb9521709c38d26cb8db9e",
+  "originGitCommit": "1297058d5bfc3ce61ca5d71a9b2bcdf427e20073",
   "originGitCommitIsDirty": true,
   "invokedBy": "ci",
-  "requestedVersion": "3.0.12",
+  "requestedVersion": "3.0.14",
   "ciProvider": "github",
-  "sdkVersion": "3.0.12"
+  "sdkVersion": "3.0.14"
 }

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.12",
+          "User-Agent" => "payabli/3.0.14",
           "X-Fern-Language" => "Ruby"
         },
         auth_provider: Payabli::Internal::RoutingAuthProvider.new(
@@ -128,6 +128,11 @@ module Payabli
       @device ||= Payabli::Device::Client.new(client: @raw_client)
     end
 
+    # @return [Payabli::Taptopay::Client]
+    def taptopay
+      @taptopay ||= Payabli::Taptopay::Client.new(client: @raw_client)
+    end
+
     # @return [Payabli::Cloud::Client]
     def cloud
       @cloud ||= Payabli::Cloud::Client.new(client: @raw_client)

data/lib/payabli/device/client.rb

@@ -11,16 +11,17 @@ module Payabli
       end
 
       # Generates a one-time, 6-digit verification code for activating a
-      # semi-integrated card-present device in a paypoint. After calling this endpoint, an operator enters the returned
-      # code
-      # on the device's terminal, along with a device name, to register the
-      # device to the paypoint resolved from `{entry}`.
+      # semi-integrated card-present device in a paypoint. This endpoint is
+      # for AXIUM devices only. After calling this endpoint, an operator
+      # enters the returned code on the device's terminal, along with a
+      # device name, to register the device to the paypoint resolved from
+      # `{entry}`.
       #
       # A code expires 5 minutes after it's issued. A paypoint can have several
       # codes active at once — for example, when activating a batch of devices —
       # and a code binds to whichever device enters it first.
       #
-      # Authenticate with an OAuth2 Bearer token that has the `device_registry` scope.
+      # Authenticate with an OAuth2 bearer token that has the `device_registry` scope.
       #
       # @param request_options [Hash]
       # @param params [Hash]

data/lib/payabli/money_out/client.rb

@@ -110,7 +110,7 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       #
       # @example
-      #   client.money_out.cancel_all_out(request: %w[2-29 2-28 2-27])
+      #   client.money_out.cancel_all_out(request: %w[129-230 129-219])
       #
       # @return [Payabli::Types::CaptureAllOutResponse]
       def cancel_all_out(request_options: {}, **params)
@@ -230,7 +230,7 @@ module Payabli
       # @option params [String, nil] :idempotency_key
       #
       # @example
-      #   client.money_out.capture_all_out(body: %w[2-29 2-28 2-27])
+      #   client.money_out.capture_all_out(body: %w[129-230 129-219])
       #
       # @return [Payabli::Types::CaptureAllOutResponse]
       def capture_all_out(request_options: {}, **params)

data/lib/payabli/payout_subscription/client.rb

@@ -43,12 +43,12 @@ module Payabli
       #     bill_data: [{
       #       invoice_number: "INV-2345",
       #       net_amount: "500",
-      #       invoice_date: "2025-08-01",
-      #       due_date: "2025-08-15"
+      #       invoice_date: "2027-08-01",
+      #       due_date: "2027-08-15"
       #     }],
       #     schedule_details: {
-      #       start_date: "09/01/2027",
-      #       end_date: "09/01/2026",
+      #       start_date: "01/01/2027",
+      #       end_date: "12/31/2027",
       #       frequency: "monthly"
       #     }
       #   )

data/lib/payabli/statistic/client.rb

@@ -10,8 +10,9 @@ module Payabli
         @client = client
       end
 
-      # Retrieves the basic statistics for an organization or a paypoint, for a given time period, grouped by a
-      # particular frequency.
+      # Retrieves the basic statistics for an organization or a paypoint over a date range, grouped by a frequency. The
+      # response returns one row per time bucket. Counts and volumes cover approved transactions only and leave out
+      # declines. Volumes are net of fees.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -25,7 +26,6 @@ module Payabli
       # @option params [Integer] :level
       # @option params [Integer] :entry_id
       # @option params [String, nil] :end_date
-      # @option params [Hash[String, String, nil], nil] :parameters
       # @option params [String, nil] :start_date
       #
       # @example
@@ -43,7 +43,6 @@ module Payabli
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
         query_params = {}
         query_params["endDate"] = params[:end_date] if params.key?(:end_date)
-        query_params["parameters"] = params[:parameters] if params.key?(:parameters)
         query_params["startDate"] = params[:start_date] if params.key?(:start_date)
 
         headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
@@ -67,7 +66,9 @@ module Payabli
         raise error_class.new(response.body, code: code)
       end
 
-      # Retrieves the basic statistics for a customer for a specific time period, grouped by a selected frequency.
+      # Retrieves the basic statistics for a customer over a date range, grouped by a frequency. This is a Pay In view:
+      # it counts the customer's approved transactions and returns one row per time bucket. Volume here is the gross
+      # amount, before fees.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -79,28 +80,23 @@ module Payabli
       # @option params [String] :mode
       # @option params [String] :freq
       # @option params [Integer] :customer_id
-      # @option params [Hash[String, String, nil], nil] :parameters
       #
       # @example
       #   client.statistic.customer_basic_stats(
-      #     mode: "ytd",
+      #     mode: "m12",
       #     freq: "m",
       #     customer_id: 4440
       #   )
       #
-      # @return [Array[Payabli::Types::SubscriptionStatsQueryRecord]]
+      # @return [Array[Payabli::Types::StatCustomerBasicQueryRecord]]
       def customer_basic_stats(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
-        query_params = {}
-        query_params["parameters"] = params[:parameters] if params.key?(:parameters)
-
         headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "Statistic/customerbasic/#{URI.encode_uri_component(params[:mode].to_s)}/#{URI.encode_uri_component(params[:freq].to_s)}/#{URI.encode_uri_component(params[:customer_id].to_s)}",
           headers: headers,
-          query: query_params,
           request_options: request_options
         )
         begin
@@ -115,7 +111,9 @@ module Payabli
         raise error_class.new(response.body, code: code)
       end
 
-      # Retrieves the subscription statistics for a given interval for a paypoint or organization.
+      # Retrieves subscription statistics for a paypoint or organization, bucketed by how soon active subscriptions are
+      # due to renew. This is a forward-looking forecast of upcoming renewals, not charges already taken. Request a
+      # single window with `interval`, or `all` to return every window in one call.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -127,28 +125,23 @@ module Payabli
       # @option params [String] :interval
       # @option params [Integer] :level
       # @option params [Integer] :entry_id
-      # @option params [Hash[String, String, nil], nil] :parameters
       #
       # @example
       #   client.statistic.sub_stats(
-      #     interval: "30",
+      #     interval: "all",
       #     level: 2,
       #     entry_id: 1000000
       #   )
       #
-      # @return [Array[Payabli::Types::StatBasicQueryRecord]]
+      # @return [Array[Payabli::Types::SubscriptionStatsQueryRecord]]
       def sub_stats(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
-        query_params = {}
-        query_params["parameters"] = params[:parameters] if params.key?(:parameters)
-
         headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "Statistic/subscriptions/#{URI.encode_uri_component(params[:interval].to_s)}/#{URI.encode_uri_component(params[:level].to_s)}/#{URI.encode_uri_component(params[:entry_id].to_s)}",
           headers: headers,
-          query: query_params,
           request_options: request_options
         )
         begin
@@ -163,7 +156,9 @@ module Payabli
         raise error_class.new(response.body, code: code)
       end
 
-      # Retrieve the basic statistics about a vendor for a given time period, grouped by frequency.
+      # Retrieve the basic statistics about a vendor over a date range, grouped by frequency. The response returns one
+      # row per time bucket, breaking the vendor's bills down by bill state (active, sent to approval, approved, in
+      # transit, paid, and so on). Volumes are net of fees.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -175,7 +170,6 @@ module Payabli
       # @option params [String] :mode
       # @option params [String] :freq
       # @option params [Integer] :id_vendor
-      # @option params [Hash[String, String, nil], nil] :parameters
       #
       # @example
       #   client.statistic.vendor_basic_stats(
@@ -187,16 +181,12 @@ module Payabli
       # @return [Array[Payabli::Types::StatisticsVendorQueryRecord]]
       def vendor_basic_stats(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
-        query_params = {}
-        query_params["parameters"] = params[:parameters] if params.key?(:parameters)
-
         headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "Statistic/vendorbasic/#{URI.encode_uri_component(params[:mode].to_s)}/#{URI.encode_uri_component(params[:freq].to_s)}/#{URI.encode_uri_component(params[:id_vendor].to_s)}",
           headers: headers,
-          query: query_params,
           request_options: request_options
         )
         begin

data/lib/payabli/statistic/types/basic_stats_request.rb

@@ -14,8 +14,6 @@ module Payabli
 
         field :end_date, -> { String }, optional: true, nullable: false, api_name: "endDate"
 
-        field :parameters, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
-
         field :start_date, -> { String }, optional: true, nullable: false, api_name: "startDate"
       end
     end

data/lib/payabli/subscription/client.rb

@@ -168,10 +168,10 @@ module Payabli
       #       method_: "card"
       #     },
       #     schedule_details: {
-      #       end_date: "2025-03-20",
+      #       end_date: "2027-12-31",
       #       frequency: "weekly",
       #       plan_id: 1,
-      #       start_date: "2024-09-20"
+      #       start_date: "2027-01-01"
       #     }
       #   )
       #

data/lib/payabli/taptopay/client.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Taptopay
+    class Client
+      # @param client [Payabli::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Issues a short-lived activation code for a Tap to Pay device in the
+      # `Pending` state. This endpoint is for Tap to Pay devices only.
+      # Deliver the code to the device to complete activation.
+      #
+      # A code is valid for 30 minutes after it's issued. Calling this
+      # endpoint again for the same device before the code expires returns
+      # the same code, with `alreadyIssued` set to `true`, instead of
+      # generating a new one. A new code is only generated when no valid
+      # code exists.
+      #
+      # Authenticate with an OAuth2 bearer token that has the `pos_create`
+      # permission. See [Accept Tap to Pay payments](/guides/pay-in-developer-tap-to-pay)
+      # for the full integration guide.
+      #
+      # @param request_options [Hash]
+      # @param params [Payabli::Taptopay::Types::TapToPayActivationChallengeRequest]
+      # @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
+      #
+      # @example
+      #   client.taptopay.activation_challenge(
+      #     entry: "8cfec329267",
+      #     device_id: "499585-389fj484-3jcj8hj3"
+      #   )
+      #
+      # @return [Payabli::Types::TapToPayActivationChallengeResponse]
+      def activation_challenge(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }])
+        request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v2/device/taptopay/activate/challenge",
+          headers: headers,
+          body: Payabli::Taptopay::Types::TapToPayActivationChallengeRequest.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::TapToPayActivationChallengeResponse.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/taptopay/types/tap_to_pay_activation_challenge_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Taptopay
+    module Types
+      class TapToPayActivationChallengeRequest < Internal::Types::Model
+        field :entry, -> { String }, optional: false, nullable: false
+
+        field :device_id, -> { String }, optional: false, nullable: false, api_name: "deviceId"
+      end
+    end
+  end
+end

data/lib/payabli/types/bill_out_data.rb

@@ -8,7 +8,7 @@ module Payabli
 
       field :accounting_field_2, -> { String }, optional: true, nullable: false, api_name: "accountingField2"
 
-      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"
 
       field :attachments, -> { Internal::Types::Array[Payabli::Types::FileContent] }, optional: true, nullable: false
 

data/lib/payabli/types/bill_pay_out_data.rb

@@ -13,7 +13,7 @@ module Payabli
 
       field :terms, -> { Payabli::Types::Terms }, optional: true, nullable: false, api_name: "Terms"
 
-      field :additional_data, -> { String }, optional: true, nullable: false, api_name: "AdditionalData"
+      field :additional_data, -> { Internal::Types::Hash[String, String] }, optional: false, nullable: true, api_name: "AdditionalData"
 
       field :attachments, -> { Internal::Types::Array[Payabli::Types::FileContent] }, optional: true, nullable: false
 

data/lib/payabli/types/bill_pay_out_data_request.rb

@@ -23,7 +23,7 @@ module Payabli
 
       field :accounting_field_2, -> { String }, optional: true, nullable: false, api_name: "accountingField2"
 
-      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"
 
       field :attachments, -> { Internal::Types::Array[Payabli::Types::FileContent] }, optional: true, nullable: false
     end

data/lib/payabli/types/bill_response_data.rb

@@ -41,7 +41,7 @@ module Payabli
 
       field :source, -> { String }, optional: true, nullable: false, api_name: "Source"
 
-      field :additional_data, -> { String }, optional: true, nullable: false, api_name: "AdditionalData"
+      field :additional_data, -> { Internal::Types::Hash[String, String] }, optional: false, nullable: true, api_name: "AdditionalData"
 
       field :vendor, -> { Payabli::Types::VendorDataResponse }, optional: true, nullable: false, api_name: "Vendor"
 

data/lib/payabli/types/{stat_basic_query_record.rb → stat_customer_basic_query_record.rb}

@@ -2,16 +2,12 @@
 
 module Payabli
   module Types
-    class StatBasicQueryRecord < Internal::Types::Model
+    class StatCustomerBasicQueryRecord < Internal::Types::Model
       field :stat_x, -> { String }, optional: false, nullable: false, api_name: "statX"
 
       field :in_transactions, -> { Integer }, optional: false, nullable: false, api_name: "inTransactions"
 
       field :in_transactions_volume, -> { Integer }, optional: false, nullable: false, api_name: "inTransactionsVolume"
-
-      field :in_wallet_transactions, -> { Integer }, optional: false, nullable: false, api_name: "inWalletTransactions"
-
-      field :in_wallet_volume, -> { Integer }, optional: false, nullable: false, api_name: "inWalletVolume"
     end
   end
 end

data/lib/payabli/types/tap_to_pay_activation_challenge_data.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The issued activation code, its expiration, and whether it was reused.
+    class TapToPayActivationChallengeData < Internal::Types::Model
+      field :code, -> { String }, optional: false, nullable: false
+
+      field :expires_at, -> { String }, optional: false, nullable: false, api_name: "expiresAt"
+
+      field :already_issued, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "alreadyIssued"
+    end
+  end
+end

data/lib/payabli/types/tap_to_pay_activation_challenge_error_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Error response for a Tap to Pay activation challenge request.
+    # `responseData` carries the same status code as the HTTP response
+    # and a message describing the refusal.
+    class TapToPayActivationChallengeErrorResponse < Internal::Types::Model
+      field :is_success, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "isSuccess"
+
+      field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
+
+      field :response_data, -> { Payabli::Types::TapToPayActivationChallengeErrorResponseResponseData }, optional: false, nullable: false, api_name: "responseData"
+    end
+  end
+end

data/lib/payabli/types/tap_to_pay_activation_challenge_error_response_response_data.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    class TapToPayActivationChallengeErrorResponseResponseData < Internal::Types::Model
+      field :result_code, -> { Integer }, optional: false, nullable: false, api_name: "resultCode"
+
+      field :result_text, -> { String }, optional: false, nullable: false, api_name: "resultText"
+    end
+  end
+end

data/lib/payabli/types/tap_to_pay_activation_challenge_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Response to a Tap to Pay activation code request. On success,
+    # `responseData` carries the activation code, its expiration, and
+    # whether an existing code was reused.
+    class TapToPayActivationChallengeResponse < Internal::Types::Model
+      field :response_code, -> { Integer }, optional: true, nullable: false, api_name: "responseCode"
+
+      field :page_identifier, -> { String }, optional: true, nullable: false, api_name: "pageIdentifier"
+
+      field :room_id, -> { Integer }, optional: true, nullable: false, api_name: "roomId"
+
+      field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
+
+      field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
+
+      field :response_data, -> { Payabli::Types::TapToPayActivationChallengeData }, optional: false, nullable: false, api_name: "responseData"
+    end
+  end
+end

data/lib/payabli/types/user_data.rb

@@ -5,7 +5,7 @@ module Payabli
     class UserData < Internal::Types::Model
       field :access, -> { Internal::Types::Array[Payabli::Types::UsrAccess] }, optional: true, nullable: false
 
-      field :additional_data, -> { Internal::Types::Hash[String, Internal::Types::Hash[String, Object]] }, optional: true, nullable: false, api_name: "additionalData"
+      field :additional_data, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false, api_name: "additionalData"
 
       field :email, -> { String }, optional: true, nullable: false
 

data/lib/payabli/types/user_query_record.rb

@@ -5,7 +5,7 @@ module Payabli
     class UserQueryRecord < Internal::Types::Model
       field :access, -> { Internal::Types::Array[Payabli::Types::UsrAccess] }, optional: true, nullable: false, api_name: "Access"
 
-      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"
 
       field :created_at, -> { String }, optional: true, nullable: false, api_name: "createdAt"
 

data/lib/payabli/types/v_card_get_response_associated_vendor.rb

@@ -86,7 +86,7 @@ module Payabli
 
       field :internal_reference_id, -> { Integer }, optional: true, nullable: false, api_name: "InternalReferenceId"
 
-      field :additional_data, -> { String }, optional: true, nullable: false, api_name: "additionalData"
+      field :additional_data, -> { Internal::Types::Hash[String, String] }, optional: false, nullable: true, api_name: "additionalData"
 
       field :external_paypoint_id, -> { String }, optional: true, nullable: false, api_name: "externalPaypointID"