payabli 3.0.6 → 3.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4be50a5d248c6bead3079413803be2b8dc5633066dde2d0cf30aeabb022dc22b
-  data.tar.gz: 0a41703fb012562d9bdc614c4046d32cbe16952bffc4bed7dd94a44cfb97a718
+  metadata.gz: 7cea61d10b3cafacb06c10380c78c3614ef5567afe7daeca9b59b6395da35140
+  data.tar.gz: 2583dd669a4c9927bbd4d70cde26346ae9fc8767e1cffe63e51392cc377305e6
 SHA512:
-  metadata.gz: cf9edd3022ddf76cb022e634ffb7c90ce56e665ce11bd79ea8649d3d70dc4a01e47ccc2c372e173e9b91e6af0a669006e44b8e35677c6344cea475c141d48556
-  data.tar.gz: 3a08c3b7d29ae04ec8eadaed4afb2f26aa7d18b940b64c5720d923b9cb2b9d26fc11b629e505bb05dabf5b522ba021045c8c3085e6645bee5f017c1646d35117
+  metadata.gz: 1c9f0e871ea5bea7767c60a3adc6a3aef47e847288bf9a956500219b65e11f5154a826ecc67f8a52d017e01a3258fb945b7ae4cd22370a7cb02de6c719f363f1
+  data.tar.gz: f2bea200f260b7ab5b473647131f29711b24bee0cf42cb9ebffbb73a45a4895b4ff4c7271a3f97437e45317e583b288b54d1d212905af8fe2af9ab760dd2873f

data/.fern/metadata.json

@@ -1,15 +1,16 @@
 {
-  "cliVersion": "5.56.0",
+  "cliVersion": "5.95.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": "bba6b6215757725a8aada77eabcb84166221f24e",
+  "originGitCommit": "c0d928adb5a06dd2f0f02ec1e68e0159c230e3b6",
   "originGitCommitIsDirty": true,
   "invokedBy": "ci",
-  "requestedVersion": "3.0.6",
+  "requestedVersion": "3.0.8",
   "ciProvider": "github",
-  "sdkVersion": "3.0.6"
+  "sdkVersion": "3.0.8"
 }

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