payabli 3.0.7 → 3.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c348ce0242faa30e0404200b80d1552188c2a6d953bae3308d44365a45a086e5
-  data.tar.gz: 96fd899b2ac2c8bc2ec9193f9ba244ba3b500fd746bd8354a1537f9155887284
+  metadata.gz: ad3502f5cf3111c45acbb8d04c9a32c6fc14f55609f079c90c8d2ca69f731a58
+  data.tar.gz: 40d8407f79b680968de259976c94992a76627d110f4ba53a3c9dff118467077c
 SHA512:
-  metadata.gz: 8d1832ec5c195aeb5ee8ab8c220a8c02c5dc9886146cfa1c76eca077636e9e83f23c87eb797485734d6b72df6299dec8c93eff9562c645e3098597b731a72081
-  data.tar.gz: 4cefd412ad3e15177f5f376e571179c7cbea0ad91ef33b24712a3659262f920eaee66f71150c34b1bcd33c59943ab37a658a5c58307e83d2b3dccc869344f09f
+  metadata.gz: 9290d8e53104b1de9c6fce591411ff014e26dbceb885dcb7944d29a3214be2b9e9c772efc36c2c5851df0ec69a6471bf68c6bf10935b46a5dd60245733139e29
+  data.tar.gz: 7ba662ae69d56a47adfd31406c2ed7adc3b52e35cb791181ae4188cd55e8aa196c2576f54abf983263a8ec7ad510bbcfde3297b708880b041799ea5c1e1602c1

data/.fern/metadata.json

@@ -1,15 +1,16 @@
 {
-  "cliVersion": "5.56.0",
+  "cliVersion": "5.98.1",
   "generatorName": "fernapi/fern-ruby-sdk",
-  "generatorVersion": "1.20.1",
+  "generatorVersion": "1.23.0",
   "generatorConfig": {
     "enableWireTests": true,
-    "rubocopVariableNumberStyle": "snake_case"
+    "rubocopVariableNumberStyle": "snake_case",
+    "respectOptionalRequestBody": true
   },
-  "originGitCommit": "85dc6dd780991f47e9c2d71ad221647a62bccf93",
+  "originGitCommit": "aa2ca5e48aaac43d3a95cb68a4326a796855ec16",
   "originGitCommitIsDirty": true,
   "invokedBy": "ci",
-  "requestedVersion": "3.0.7",
+  "requestedVersion": "3.0.9",
   "ciProvider": "github",
-  "sdkVersion": "3.0.7"
+  "sdkVersion": "3.0.9"
 }

data/lib/payabli/bill/client.rb

@@ -152,13 +152,16 @@ module Payabli
       # @return [Payabli::Types::EditBillResponse]
       def edit_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)
+
         headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "PUT",
           path: "Bill/#{URI.encode_uri_component(params[:id_bill].to_s)}",
           headers: headers,
-          body: Payabli::Types::BillOutData.new(params).to_h,
+          body: Payabli::Types::BillOutData.new(body_params).to_h,
           request_options: request_options
         )
         begin
@@ -389,13 +392,16 @@ module Payabli
       # @return [Payabli::Types::ModifyApprovalBillResponse]
       def modify_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)
+
         headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "PUT",
           path: "Bill/approval/#{URI.encode_uri_component(params[:id_bill].to_s)}",
           headers: headers,
-          body: params,
+          body: body_params,
           request_options: request_options
         )
         begin

data/lib/payabli/billing/client.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Billing
+    class Client
+      # @param client [Payabli::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Returns every billing profile that belongs to an organization. This is
+      # the data behind the Profile Library table in the Payabli Portal.
+      #
+      # Requires a token with the `billing_profile_read` permission; a token
+      # without it gets `403 Forbidden`.
+      #
+      # @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 [String, nil] :profile_name
+      # @option params [Integer, nil] :fee_type
+      # @option params [Integer, nil] :service_vertical
+      # @option params [Integer, nil] :profile_id
+      # @option params [Integer, nil] :limit_record
+      # @option params [Integer, nil] :from_record
+      #
+      # @example
+      #   client.billing.list_profiles(
+      #     org_id: 123,
+      #     limit_record: 20,
+      #     from_record: 0
+      #   )
+      #
+      # @return [Payabli::Types::BillingProfileQueryResponse]
+      def list_profiles(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["profileName"] = params[:profile_name] if params.key?(:profile_name)
+        query_params["feeType"] = params[:fee_type] if params.key?(:fee_type)
+        query_params["serviceVertical"] = params[:service_vertical] if params.key?(:service_vertical)
+        query_params["profileId"] = params[:profile_id] if params.key?(:profile_id)
+        query_params["limitRecord"] = params[:limit_record] if params.key?(:limit_record)
+        query_params["fromRecord"] = params[:from_record] if params.key?(:from_record)
+
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
+        request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "billing/configuration/org/#{URI.encode_uri_component(params[:org_id].to_s)}",
+          headers: headers,
+          query: query_params,
+          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::BillingProfileQueryResponse.load(response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Returns the billing profile currently assigned to an entity, including
+      # its billable events and fee schedules. Use it to read the pricing terms
+      # in effect for an organization, paypoint, template, or application.
+      #
+      # Requires a token with the `billing_profile_read` permission and access
+      # to the requested entity; otherwise the call gets `403 Forbidden`.
+      #
+      # If the entity exists but has no profile assigned, the call returns
+      # `404 Not Found`.
+      #
+      # @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 [Payabli::Billing::Types::GetProfileBillingRequestServiceGroup] :service_group
+      # @option params [Payabli::Billing::Types::GetProfileBillingRequestEntityType] :entity_type
+      # @option params [Integer] :entity_id
+      #
+      # @example
+      #   client.billing.get_profile(
+      #     service_group: "PayIn",
+      #     entity_type: "Organization",
+      #     entity_id: 123
+      #   )
+      #
+      # @return [Payabli::Types::BillingProfileResponse]
+      def get_profile(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
+        request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "billing/configuration/#{URI.encode_uri_component(params[:service_group].to_s)}/#{URI.encode_uri_component(params[:entity_type].to_s)}/#{URI.encode_uri_component(params[:entity_id].to_s)}",
+          headers: headers,
+          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::BillingProfileResponse.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/billing/types/get_profile_billing_request_entity_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Billing
+    module Types
+      module GetProfileBillingRequestEntityType
+        extend Payabli::Internal::Types::Enum
+
+        ORGANIZATION = "Organization"
+        PAYPOINT = "Paypoint"
+        TEMPLATE = "Template"
+        APPLICATION = "Application"
+      end
+    end
+  end
+end

data/lib/payabli/billing/types/get_profile_billing_request_service_group.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Billing
+    module Types
+      module GetProfileBillingRequestServiceGroup
+        extend Payabli::Internal::Types::Enum
+
+        PAY_IN = "PayIn"
+        PAY_OUT = "PayOut"
+      end
+    end
+  end
+end

data/lib/payabli/billing/types/list_billing_profiles_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Billing
+    module Types
+      class ListBillingProfilesRequest < Internal::Types::Model
+        field :org_id, -> { Integer }, optional: false, nullable: false, api_name: "orgId"
+
+        field :profile_name, -> { String }, optional: true, nullable: false, api_name: "profileName"
+
+        field :fee_type, -> { Integer }, optional: true, nullable: false, api_name: "feeType"
+
+        field :service_vertical, -> { Integer }, optional: true, nullable: false, api_name: "serviceVertical"
+
+        field :profile_id, -> { Integer }, optional: true, nullable: false, api_name: "profileId"
+
+        field :limit_record, -> { Integer }, optional: true, nullable: false, api_name: "limitRecord"
+
+        field :from_record, -> { Integer }, optional: true, nullable: false, api_name: "fromRecord"
+      end
+    end
+  end
+end

data/lib/payabli/boarding/client.rb

@@ -187,13 +187,16 @@ module Payabli
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def update_application(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        path_param_names = %i[app_id]
+        body_params = params.except(*path_param_names)
+
         headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "PUT",
           path: "Boarding/app/#{URI.encode_uri_component(params[:app_id].to_s)}",
           headers: headers,
-          body: Payabli::Types::ApplicationData.new(params).to_h,
+          body: Payabli::Types::ApplicationData.new(body_params).to_h,
           request_options: request_options
         )
         begin

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.7",
+          "User-Agent" => "payabli/3.0.9",
           "X-Fern-Language" => "Ruby"
         },
         auth_provider: Payabli::Internal::RoutingAuthProvider.new(
@@ -123,6 +123,11 @@ module Payabli
       @notificationlogs ||= Payabli::Notificationlogs::Client.new(client: @raw_client)
     end
 
+    # @return [Payabli::Device::Client]
+    def device
+      @device ||= Payabli::Device::Client.new(client: @raw_client)
+    end
+
     # @return [Payabli::Cloud::Client]
     def cloud
       @cloud ||= Payabli::Cloud::Client.new(client: @raw_client)
@@ -212,5 +217,10 @@ module Payabli
     def case_management
       @case_management ||= Payabli::CaseManagement::Client.new(client: @raw_client)
     end
+
+    # @return [Payabli::Billing::Client]
+    def billing
+      @billing ||= Payabli::Billing::Client.new(client: @raw_client)
+    end
   end
 end

data/lib/payabli/cloud/client.rb

@@ -149,8 +149,8 @@ module Payabli
         end
       end
 
-      # Use [List devices by paypoint](/developers/api-reference/cloud/get-list-of-devices-for-a-paypoint) instead,
-      # which supports filters, sorting, and pagination.
+      # Use [List devices by paypoint](/developers/api-reference/get-list-of-devices-for-a-paypoint) instead, which
+      # supports filters, sorting, and pagination.
       #
       # Get a list of cloud devices registered to an entrypoint.
       #

data/lib/payabli/customer/client.rb

@@ -146,13 +146,16 @@ module Payabli
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def update_customer(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        path_param_names = %i[customer_id]
+        body_params = params.except(*path_param_names)
+
         headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "PUT",
           path: "Customer/#{URI.encode_uri_component(params[:customer_id].to_s)}",
           headers: headers,
-          body: Payabli::Types::CustomerData.new(params).to_h,
+          body: Payabli::Types::CustomerData.new(body_params).to_h,
           request_options: request_options
         )
         begin

data/lib/payabli/device/client.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Device
+    class Client
+      # @param client [Payabli::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      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}`.
+      #
+      # 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.
+      #
+      # @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
+      #
+      # @example
+      #   client.device.challenge(entry: "8cfec329267")
+      #
+      # @return [Payabli::Types::DeviceChallengeResponse]
+      def 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: "Device/challenge/#{URI.encode_uri_component(params[:entry].to_s)}",
+          headers: headers,
+          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::DeviceChallengeResponse.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/funding/client.rb

@@ -23,7 +23,7 @@ module Payabli
       #
       # @example
       #   client.funding.deposit_funds(
-      #     amount: 10,
+      #     amount: 1500,
       #     entrypoint: "48acde49",
       #     account_id: "333"
       #   )

data/lib/payabli/hosted_payment_pages/client.rb

@@ -127,13 +127,16 @@ module Payabli
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def save_page(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        path_param_names = %i[entry subdomain]
+        body_params = params.except(*path_param_names)
+
         headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "PUT",
           path: "Paypoint/#{URI.encode_uri_component(params[:entry].to_s)}/#{URI.encode_uri_component(params[:subdomain].to_s)}",
           headers: headers,
-          body: Payabli::Types::PayabliPages.new(params).to_h,
+          body: Payabli::Types::PayabliPages.new(body_params).to_h,
           request_options: request_options
         )
         begin

data/lib/payabli/internal/http/raw_client.rb

@@ -21,10 +21,13 @@ module Payabli
         # @param max_retries [Integer] The number of times to retry a failed request, defaults to 2.
         # @param timeout [Float] The timeout for the request, defaults to 60.0 seconds.
         # @param headers [Hash] The headers for the request.
+        # @param overridable_headers [Array<String>] The names of the client-level headers a request
+        #   may replace via `additional_headers`. Holds the API's global headers; SDK metadata and
+        #   auth headers are absent from it and so stay protected.
         # @param auth_provider [Object, nil] An optional auth provider responding to
         #   `auth_headers`. When present its headers are resolved on every request so
         #   token-based schemes (e.g. OAuth) can refresh an expired token mid-session.
-        def initialize(base_url:, max_retries: 2, timeout: 60.0, headers: {}, auth_provider: nil)
+        def initialize(base_url:, max_retries: 2, timeout: 60.0, headers: {}, overridable_headers: [], auth_provider: nil)
           @base_url = base_url
           @max_retries = max_retries
           @timeout = timeout
@@ -34,6 +37,7 @@ module Payabli
             "X-Fern-SDK-Name": "payabli",
             "X-Fern-SDK-Version": "0.0.1"
           }.merge(headers)
+          @overridable_headers = overridable_headers.to_set { |name| name.to_s.downcase }
         end
 
         # @param request [Payabli::Internal::Http::BaseRequest] The HTTP request.
@@ -50,7 +54,7 @@ module Payabli
             http_request = build_http_request(
               url:,
               method: request.method,
-              headers: request.encode_headers(protected_keys: @default_headers.keys + auth_headers.keys),
+              headers: request.encode_headers(protected_keys: protected_header_keys + auth_headers.keys),
               body: request.encode_body,
               auth_headers: auth_headers
             )
@@ -73,6 +77,15 @@ module Payabli
           response
         end
 
+        # The client-level header names that `additional_headers` must not replace: every default
+        # header except the API's global headers, which are overridable per request.
+        # @return [Array<Symbol, String>] The protected header names.
+        def protected_header_keys
+          return @default_headers.keys if @overridable_headers.empty?
+
+          @default_headers.keys.reject { |name| @overridable_headers.include?(name.to_s.downcase) }
+        end
+
         # Determines if a request should be retried based on the response status code.
         # @param response [Net::HTTPResponse] The HTTP response.
         # @param attempt [Integer] The current retry attempt (0-indexed).

data/lib/payabli/internal/json/request.rb

@@ -13,21 +13,23 @@ module Payabli
         # @param headers [Hash] Additional headers for the request (optional)
         # @param query [Hash] Query parameters for the request (optional)
         # @param body [Object, nil] The JSON request body (optional)
+        # @param omit_content_type_without_body [Boolean] When true and no body is present, the
+        #   Content-Type header is omitted (used for endpoints whose request body is optional)
         # @param request_options [Payabli::RequestOptions, Hash{Symbol=>Object}, nil]
-        def initialize(base_url:, path:, method:, headers: {}, query: {}, body: nil, request_options: {})
+        def initialize(base_url:, path:, method:, headers: {}, query: {}, body: nil, omit_content_type_without_body: false, request_options: {})
           super(base_url:, path:, method:, headers:, query:, request_options:)
 
           @body = body
+          @omit_content_type_without_body = omit_content_type_without_body
         end
 
         # @return [Hash] The encoded HTTP request headers.
         # @param protected_keys [Array<String>] Header keys set by the SDK client (e.g. auth, metadata)
         #   that must not be overridden by additional_headers from request_options.
         def encode_headers(protected_keys: [])
-          sdk_headers = {
-            "Content-Type" => "application/json",
-            "Accept" => "application/json"
-          }.merge(@headers)
+          sdk_headers = { "Accept" => "application/json" }
+          sdk_headers["Content-Type"] = "application/json" unless @omit_content_type_without_body && @body.nil?
+          sdk_headers = sdk_headers.merge(@headers)
           merge_additional_headers(sdk_headers, protected_keys:)
         end
 

data/lib/payabli/line_item/client.rb

@@ -128,13 +128,16 @@ module Payabli
       # @return [Payabli::Types::PayabliApiResponse6]
       def update_item(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        path_param_names = %i[line_item_id]
+        body_params = params.except(*path_param_names)
+
         headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "PUT",
           path: "LineItem/#{URI.encode_uri_component(params[:line_item_id].to_s)}",
           headers: headers,
-          body: Payabli::Types::LineItem.new(params).to_h,
+          body: Payabli::Types::LineItem.new(body_params).to_h,
           request_options: request_options
         )
         begin