payabli 3.0.4 → 3.0.6

data/lib/payabli/statistic/client.rb

@@ -28,6 +28,16 @@ module Payabli
       # @option params [Hash[String, String, nil], nil] :parameters
       # @option params [String, nil] :start_date
       #
+      # @example
+      #   client.statistic.basic_stats(
+      #     mode: "custom",
+      #     freq: "m",
+      #     level: 2,
+      #     entry_id: 1000000,
+      #     end_date: "2025-11-30",
+      #     start_date: "2025-11-01"
+      #   )
+      #
       # @return [Array[Payabli::Types::StatBasicExtendedQueryRecord]]
       def basic_stats(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
@@ -36,10 +46,12 @@ module Payabli
         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" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "Statistic/basic/#{URI.encode_uri_component(params[:mode].to_s)}/#{URI.encode_uri_component(params[:freq].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
         )
@@ -69,16 +81,25 @@ module Payabli
       # @option params [Integer] :customer_id
       # @option params [Hash[String, String, nil], nil] :parameters
       #
+      # @example
+      #   client.statistic.customer_basic_stats(
+      #     mode: "ytd",
+      #     freq: "m",
+      #     customer_id: 4440
+      #   )
+      #
       # @return [Array[Payabli::Types::SubscriptionStatsQueryRecord]]
       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
         )
@@ -108,16 +129,25 @@ module Payabli
       # @option params [Integer] :entry_id
       # @option params [Hash[String, String, nil], nil] :parameters
       #
+      # @example
+      #   client.statistic.sub_stats(
+      #     interval: "30",
+      #     level: 2,
+      #     entry_id: 1000000
+      #   )
+      #
       # @return [Array[Payabli::Types::StatBasicQueryRecord]]
       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
         )
@@ -147,16 +177,25 @@ module Payabli
       # @option params [Integer] :id_vendor
       # @option params [Hash[String, String, nil], nil] :parameters
       #
+      # @example
+      #   client.statistic.vendor_basic_stats(
+      #     mode: "ytd",
+      #     freq: "m",
+      #     id_vendor: 1
+      #   )
+      #
       # @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
         )

data/lib/payabli/subscription/client.rb

@@ -21,13 +21,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :sub_id
       #
+      # @example
+      #   client.subscription.get_subscription(sub_id: 231)
+      #
       # @return [Payabli::Types::SubscriptionQueryRecords]
       def get_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: "Subscription/#{URI.encode_uri_component(params[:sub_id].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -55,6 +60,12 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :sub_id
       #
+      # @example
+      #   client.subscription.update_subscription(
+      #     sub_id: 231,
+      #     set_pause: true
+      #   )
+      #
       # @return [Payabli::Types::UpdateSubscriptionResponse]
       def update_subscription(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
@@ -62,10 +73,12 @@ module Payabli
         non_body_param_names = %w[subId]
         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: "Subscription/#{URI.encode_uri_component(params[:sub_id].to_s)}",
+          headers: headers,
           body: body,
           request_options: request_options
         )
@@ -94,13 +107,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :sub_id
       #
+      # @example
+      #   client.subscription.remove_subscription(sub_id: 231)
+      #
       # @return [Payabli::Types::RemoveSubscriptionResponse]
       def remove_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: "Subscription/#{URI.encode_uri_component(params[:sub_id].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -130,6 +148,33 @@ module Payabli
       # @option params [Boolean, nil] :force_customer_creation
       # @option params [String, nil] :idempotency_key
       #
+      # @example
+      #   client.subscription.new_subscription(
+      #     customer_data: {
+      #       customer_id: 4440
+      #     },
+      #     entry_point: "8cfec329267",
+      #     payment_details: {
+      #       service_fee: 0,
+      #       total_amount: 100
+      #     },
+      #     payment_method: {
+      #       cardcvv: "123",
+      #       cardexp: "12/29",
+      #       card_holder: "John Cassian",
+      #       cardnumber: "4111111111111111",
+      #       cardzip: "37615",
+      #       initiator: "payor",
+      #       method_: "card"
+      #     },
+      #     schedule_details: {
+      #       end_date: "2025-03-20",
+      #       frequency: "weekly",
+      #       plan_id: 1,
+      #       start_date: "2024-09-20"
+      #     }
+      #   )
+      #
       # @return [Payabli::Types::AddSubscriptionResponse]
       def new_subscription(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
@@ -143,6 +188,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",

data/lib/payabli/templates/client.rb

@@ -21,13 +21,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :template_id
       #
+      # @example
+      #   client.templates.delete_template(template_id: 80)
+      #
       # @return [Payabli::Types::PayabliApiResponseTemplateId]
       def delete_template(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: "Templates/#{URI.encode_uri_component(params[:template_id].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -56,13 +61,21 @@ module Payabli
       # @option params [Integer] :template_id
       # @option params [Boolean] :ignore_empty
       #
+      # @example
+      #   client.templates.getlink_template(
+      #     template_id: 80,
+      #     ignore_empty: true
+      #   )
+      #
       # @return [Payabli::Types::BoardingLinkApiResponse]
       def getlink_template(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: "Templates/getlink/#{URI.encode_uri_component(params[:template_id].to_s)}/#{URI.encode_uri_component(params[:ignore_empty].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -90,13 +103,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :template_id
       #
+      # @example
+      #   client.templates.get_template(template_id: 80)
+      #
       # @return [Payabli::Types::TemplateQueryRecord]
       def get_template(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: "Templates/get/#{URI.encode_uri_component(params[:template_id].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -130,6 +148,14 @@ module Payabli
       # @option params [Hash[String, String, nil], nil] :parameters
       # @option params [String, nil] :sort_by
       #
+      # @example
+      #   client.templates.list_templates(
+      #     org_id: 123,
+      #     from_record: 251,
+      #     limit_record: 0,
+      #     sort_by: "desc(field_name)"
+      #   )
+      #
       # @return [Payabli::Types::TemplateQueryResponse]
       def list_templates(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
@@ -139,10 +165,12 @@ module Payabli
         query_params["parameters"] = params[:parameters] if params.key?(:parameters)
         query_params["sortBy"] = params[:sort_by] if params.key?(:sort_by)
 
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "Query/templates/#{URI.encode_uri_component(params[:org_id].to_s)}",
+          headers: headers,
           query: query_params,
           request_options: request_options
         )

data/lib/payabli/token/client.rb

@@ -23,13 +23,21 @@ module Payabli
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       #
+      # @example
+      #   client.token.create_server_side_token(
+      #     client_id: "YOUR_CLIENT_ID",
+      #     client_secret: "YOUR_CLIENT_SECRET"
+      #   )
+      #
       # @return [Payabli::Types::PayabliAccessTokenResponse]
       def create_server_side_token(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        headers = @client.auth_headers_for_endpoint(security: nil)
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "POST",
           path: "v2/Token/serverside",
+          headers: headers,
           body: Payabli::Token::Types::CreateServerSideTokenRequest.new(params).to_h,
           request_options: request_options
         )

data/lib/payabli/token_storage/client.rb

@@ -27,6 +27,26 @@ module Payabli
       # @option params [Boolean, nil] :temporary
       # @option params [String, nil] :idempotency_key
       #
+      # @example
+      #   client.token_storage.add_method(
+      #     customer_data: {
+      #       customer_id: 4440
+      #     },
+      #     entry_point: "8cfec329267",
+      #     fallback_auth: true,
+      #     fallback_auth_amount: 100,
+      #     method_description: "Primary Visa card",
+      #     payment_method: {
+      #       cardcvv: "123",
+      #       cardexp: "12/29",
+      #       card_holder: "John Doe",
+      #       cardnumber: "4111111111111111",
+      #       cardzip: "12345",
+      #       method_: "card"
+      #     },
+      #     source: "api"
+      #   )
+      #
       # @return [Payabli::Types::AddMethodResponse]
       def add_method(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
@@ -41,6 +61,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",
@@ -77,6 +98,13 @@ module Payabli
       # @option params [Integer, nil] :card_expiration_format
       # @option params [Boolean, nil] :include_temporary
       #
+      # @example
+      #   client.token_storage.get_method(
+      #     method_id: "32-8877drt00045632-678",
+      #     card_expiration_format: 1,
+      #     include_temporary: false
+      #   )
+      #
       # @return [Payabli::Types::GetMethodResponse]
       def get_method(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
@@ -84,10 +112,12 @@ module Payabli
         query_params["cardExpirationFormat"] = params[:card_expiration_format] if params.key?(:card_expiration_format)
         query_params["includeTemporary"] = params[:include_temporary] if params.key?(:include_temporary)
 
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "TokenStorage/#{URI.encode_uri_component(params[:method_id].to_s)}",
+          headers: headers,
           query: query_params,
           request_options: request_options
         )
@@ -117,6 +147,24 @@ module Payabli
       # @option params [String] :method_id
       # @option params [Boolean, nil] :ach_validation
       #
+      # @example
+      #   client.token_storage.update_method(
+      #     method_id: "32-8877drt00045632-678",
+      #     customer_data: {
+      #       customer_id: 4440
+      #     },
+      #     entry_point: "8cfec329267",
+      #     fallback_auth: true,
+      #     payment_method: {
+      #       cardcvv: "123",
+      #       cardexp: "12/29",
+      #       card_holder: "John Doe",
+      #       cardnumber: "4111111111111111",
+      #       cardzip: "12345",
+      #       method_: "card"
+      #     }
+      #   )
+      #
       # @return [Payabli::Types::PayabliApiResponsePaymethodDelete]
       def update_method(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
@@ -128,10 +176,12 @@ module Payabli
         query_params["achValidation"] = params[:ach_validation] if params.key?(:ach_validation)
         params = params.except(*query_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: "TokenStorage/#{URI.encode_uri_component(params[:method_id].to_s)}",
+          headers: headers,
           query: query_params,
           body: Payabli::Types::RequestTokenStorage.new(body_params).to_h,
           request_options: request_options
@@ -161,13 +211,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :method_id
       #
+      # @example
+      #   client.token_storage.remove_method(method_id: "32-8877drt00045632-678")
+      #
       # @return [Payabli::Types::PayabliApiResponsePaymethodDelete]
       def remove_method(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: "TokenStorage/#{URI.encode_uri_component(params[:method_id].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin

data/lib/payabli/types/application_data.rb

@@ -113,7 +113,7 @@ module Payabli
 
       field :rep_office, -> { String }, optional: true, nullable: false, api_name: "RepOffice"
 
-      field :on_create, -> { String }, optional: true, nullable: false, api_name: "onCreate"
+      field :on_create, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "onCreate"
     end
   end
 end

data/lib/payabli/types/application_data_managed.rb

@@ -83,7 +83,7 @@ module Payabli
 
       field :rep_office, -> { String }, optional: true, nullable: false, api_name: "RepOffice"
 
-      field :on_create, -> { String }, optional: true, nullable: false, api_name: "onCreate"
+      field :on_create, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "onCreate"
     end
   end
 end

data/lib/payabli/types/application_data_odp.rb

@@ -95,7 +95,7 @@ module Payabli
 
       field :rep_office, -> { String }, optional: true, nullable: false, api_name: "RepOffice"
 
-      field :on_create, -> { String }, optional: true, nullable: false, api_name: "onCreate"
+      field :on_create, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "onCreate"
     end
   end
 end

data/lib/payabli/types/application_data_pay_in.rb

@@ -116,7 +116,7 @@ module Payabli
 
       field :rep_office, -> { String }, optional: true, nullable: false, api_name: "RepOffice"
 
-      field :on_create, -> { String }, optional: true, nullable: false, api_name: "onCreate"
+      field :on_create, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "onCreate"
     end
   end
 end

data/lib/payabli/types/on_create.rb

@@ -3,7 +3,7 @@
 module Payabli
   module Types
     module OnCreate
-      # OnCreate is an alias for String
+      # OnCreate is an alias for Array
 
       # @option str [String]
       #

data/lib/payabli/types/pay_method_body_all_fields.rb

@@ -26,7 +26,7 @@ module Payabli
 
       field :device, -> { String }, optional: true, nullable: false
 
-      field :initator, -> { String }, optional: true, nullable: false
+      field :initiator, -> { String }, optional: true, nullable: false
 
       field :method_, -> { Payabli::Types::Methodall }, optional: true, nullable: false, api_name: "method"