payabli 3.0.4 → 3.0.6

data/lib/payabli/payment_method_domain/client.rb

@@ -20,13 +20,28 @@ module Payabli
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       #
+      # @example
+      #   client.payment_method_domain.add_payment_method_domain(
+      #     apple_pay: {
+      #       is_enabled: true
+      #     },
+      #     google_pay: {
+      #       is_enabled: true
+      #     },
+      #     domain_name: "checkout.example.com",
+      #     entity_id: 109,
+      #     entity_type: "paypoint"
+      #   )
+      #
       # @return [Payabli::Types::AddPaymentMethodDomainApiResponse]
       def add_payment_method_domain(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: "POST",
           path: "PaymentMethodDomain",
+          headers: headers,
           body: Payabli::PaymentMethodDomain::Types::AddPaymentMethodDomainRequest.new(params).to_h,
           request_options: request_options
         )
@@ -56,13 +71,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :domain_id
       #
+      # @example
+      #   client.payment_method_domain.cascade_payment_method_domain(domain_id: "pmd_b8237fa45c964d8a9ef27160cd42b8c5")
+      #
       # @return [Payabli::Types::PaymentMethodDomainGeneralResponse]
       def cascade_payment_method_domain(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: "POST",
           path: "PaymentMethodDomain/#{URI.encode_uri_component(params[:domain_id].to_s)}/cascade",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -90,13 +110,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :domain_id
       #
+      # @example
+      #   client.payment_method_domain.get_payment_method_domain(domain_id: "pmd_b8237fa45c964d8a9ef27160cd42b8c5")
+      #
       # @return [Payabli::Types::PaymentMethodDomainApiResponse]
       def get_payment_method_domain(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: "PaymentMethodDomain/#{URI.encode_uri_component(params[:domain_id].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -125,13 +150,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :domain_id
       #
+      # @example
+      #   client.payment_method_domain.delete_payment_method_domain(domain_id: "pmd_b8237fa45c964d8a9ef27160cd42b8c5")
+      #
       # @return [Payabli::Types::DeletePaymentMethodDomainResponse]
       def delete_payment_method_domain(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: "DELETE",
           path: "PaymentMethodDomain/#{URI.encode_uri_component(params[:domain_id].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -159,6 +189,17 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :domain_id
       #
+      # @example
+      #   client.payment_method_domain.update_payment_method_domain(
+      #     domain_id: "pmd_b8237fa45c964d8a9ef27160cd42b8c5",
+      #     apple_pay: {
+      #       is_enabled: false
+      #     },
+      #     google_pay: {
+      #       is_enabled: false
+      #     }
+      #   )
+      #
       # @return [Payabli::Types::PaymentMethodDomainGeneralResponse]
       def update_payment_method_domain(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
@@ -166,10 +207,12 @@ module Payabli
         non_body_param_names = %w[domainId]
         body = request_data.except(*non_body_param_names)
 
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "PATCH",
           path: "PaymentMethodDomain/#{URI.encode_uri_component(params[:domain_id].to_s)}",
+          headers: headers,
           body: body,
           request_options: request_options
         )
@@ -201,6 +244,12 @@ module Payabli
       # @option params [Integer, nil] :from_record
       # @option params [Integer, nil] :limit_record
       #
+      # @example
+      #   client.payment_method_domain.list_payment_method_domains(
+      #     entity_id: 1147,
+      #     entity_type: "paypoint"
+      #   )
+      #
       # @return [Payabli::Types::ListPaymentMethodDomainsResponse]
       def list_payment_method_domains(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
@@ -210,10 +259,12 @@ module Payabli
         query_params["fromRecord"] = params[:from_record] if params.key?(:from_record)
         query_params["limitRecord"] = params[:limit_record] if params.key?(:limit_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: "PaymentMethodDomain/list",
+          headers: headers,
           query: query_params,
           request_options: request_options
         )
@@ -243,13 +294,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :domain_id
       #
+      # @example
+      #   client.payment_method_domain.verify_payment_method_domain(domain_id: "pmd_b8237fa45c964d8a9ef27160cd42b8c5")
+      #
       # @return [Payabli::Types::PaymentMethodDomainGeneralResponse]
       def verify_payment_method_domain(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: "POST",
           path: "PaymentMethodDomain/#{URI.encode_uri_component(params[:domain_id].to_s)}/verify",
+          headers: headers,
           request_options: request_options
         )
         begin

data/lib/payabli/payout_subscription/client.rb

@@ -22,6 +22,37 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String, nil] :idempotency_key
       #
+      # @example
+      #   client.payout_subscription.create_payout_subscription(
+      #     entry_point: "8cfec329267",
+      #     payment_method: {
+      #       method_: "ach",
+      #       ach_holder: "Herman Coatings",
+      #       ach_routing: "021000021",
+      #       ach_account: "3453445666",
+      #       ach_account_type: "checking"
+      #     },
+      #     payment_details: {
+      #       total_amount: 500,
+      #       service_fee: 0,
+      #       currency: "USD"
+      #     },
+      #     vendor_data: {
+      #       vendor_id: 456
+      #     },
+      #     bill_data: [{
+      #       invoice_number: "INV-2345",
+      #       net_amount: "500",
+      #       invoice_date: "2025-08-01",
+      #       due_date: "2025-08-15"
+      #     }],
+      #     schedule_details: {
+      #       start_date: "09/01/2027",
+      #       end_date: "09/01/2026",
+      #       frequency: "monthly"
+      #     }
+      #   )
+      #
       # @return [Payabli::Types::AddPayoutSubscriptionResponse]
       def create_payout_subscription(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
@@ -32,6 +63,7 @@ module Payabli
         headers = {}
         headers["idempotencyKey"] = params[:idempotency_key] if params[:idempotency_key]
 
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }]).merge(headers)
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "POST",
@@ -66,13 +98,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :id
       #
+      # @example
+      #   client.payout_subscription.get_payout_subscription(id: 42)
+      #
       # @return [Payabli::Types::GetPayoutSubscriptionResponse]
       def get_payout_subscription(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: "PayoutSubscription/#{URI.encode_uri_component(params[:id].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -101,6 +138,12 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :id
       #
+      # @example
+      #   client.payout_subscription.update_payout_subscription(
+      #     id: 42,
+      #     set_pause: true
+      #   )
+      #
       # @return [Payabli::Types::UpdatePayoutSubscriptionResponse]
       def update_payout_subscription(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
@@ -108,10 +151,12 @@ module Payabli
         non_body_param_names = %w[id]
         body = request_data.except(*non_body_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: "PayoutSubscription/#{URI.encode_uri_component(params[:id].to_s)}",
+          headers: headers,
           body: body,
           request_options: request_options
         )
@@ -141,13 +186,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :id
       #
+      # @example
+      #   client.payout_subscription.delete_payout_subscription(id: 42)
+      #
       # @return [Payabli::Types::DeletePayoutSubscriptionResponse]
       def delete_payout_subscription(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: "DELETE",
           path: "PayoutSubscription/#{URI.encode_uri_component(params[:id].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin

data/lib/payabli/paypoint/client.rb

@@ -21,13 +21,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :entry
       #
+      # @example
+      #   client.paypoint.get_basic_entry(entry: "8cfec329267")
+      #
       # @return [Payabli::Types::GetBasicEntryResponse]
       def get_basic_entry(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: "Paypoint/basic/#{URI.encode_uri_component(params[:entry].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -55,13 +60,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :id_paypoint
       #
+      # @example
+      #   client.paypoint.get_basic_entry_by_id(id_paypoint: "198")
+      #
       # @return [Payabli::Types::GetBasicEntryByIdResponse]
       def get_basic_entry_by_id(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: "Paypoint/basicById/#{URI.encode_uri_component(params[:id_paypoint].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -89,13 +99,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :entry
       #
+      # @example
+      #   client.paypoint.save_logo(entry: "8cfec329267")
+      #
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def save_logo(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: "PUT",
           path: "Paypoint/logo/#{URI.encode_uri_component(params[:entry].to_s)}",
+          headers: headers,
           body: Payabli::Types::FileContent.new(params).to_h,
           request_options: request_options
         )
@@ -123,13 +138,28 @@ module Payabli
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       #
+      # @example
+      #   client.paypoint.migrate(
+      #     entry_point: "8cfec329267",
+      #     new_parent_organization_id: 123,
+      #     notification_request: {
+      #       notification_url: "https://webhook-test.yoursie.com",
+      #       web_header_parameters: [{
+      #         key: "testheader",
+      #         value: "1234567890"
+      #       }]
+      #     }
+      #   )
+      #
       # @return [Payabli::Types::MigratePaypointResponse]
       def migrate(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: "POST",
           path: "Paypoint/migrate",
+          headers: headers,
           body: Payabli::Paypoint::Types::PaypointMoveRequest.new(params).to_h,
           request_options: request_options
         )
@@ -158,13 +188,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :entry
       #
+      # @example
+      #   client.paypoint.settings_page(entry: "8cfec329267")
+      #
       # @return [Payabli::Types::SettingsQueryRecord]
       def settings_page(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: "Paypoint/settings/#{URI.encode_uri_component(params[:entry].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -193,16 +228,21 @@ module Payabli
       # @option params [String] :entry
       # @option params [String, nil] :entrypages
       #
+      # @example
+      #   client.paypoint.get_entry_config(entry: "8cfec329267")
+      #
       # @return [Payabli::Types::GetEntryConfigResponse]
       def get_entry_config(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
         query_params = {}
         query_params["entrypages"] = params[:entrypages] if params.key?(:entrypages)
 
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "Paypoint/#{URI.encode_uri_component(params[:entry].to_s)}",
+          headers: headers,
           query: query_params,
           request_options: request_options
         )
@@ -232,13 +272,21 @@ module Payabli
       # @option params [String] :entry
       # @option params [String] :subdomain
       #
+      # @example
+      #   client.paypoint.get_page(
+      #     entry: "8cfec329267",
+      #     subdomain: "pay-your-fees-1"
+      #   )
+      #
       # @return [Payabli::Types::PayabliPages]
       def get_page(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: "Paypoint/#{URI.encode_uri_component(params[:entry].to_s)}/#{URI.encode_uri_component(params[:subdomain].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -267,13 +315,21 @@ module Payabli
       # @option params [String] :entry
       # @option params [String] :subdomain
       #
+      # @example
+      #   client.paypoint.remove_page(
+      #     entry: "8cfec329267",
+      #     subdomain: "pay-your-fees-1"
+      #   )
+      #
       # @return [Payabli::Types::PayabliApiResponseGeneric2Part]
       def remove_page(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: "DELETE",
           path: "Paypoint/#{URI.encode_uri_component(params[:entry].to_s)}/#{URI.encode_uri_component(params[:subdomain].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin