payabli 3.0.5 → 3.0.7

data/lib/payabli/case_management/types/create_bank_account_change_case_request.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Payabli
+  module CaseManagement
+    module Types
+      class CreateBankAccountChangeCaseRequest < Internal::Types::Model
+        field :paypoint_id, -> { Integer }, optional: false, nullable: false, api_name: "paypointId"
+
+        field :nickname, -> { String }, optional: false, nullable: false
+
+        field :bank_name, -> { String }, optional: false, nullable: false, api_name: "bankName"
+
+        field :routing_number, -> { String }, optional: false, nullable: false, api_name: "routingNumber"
+
+        field :account_number, -> { String }, optional: false, nullable: false, api_name: "accountNumber"
+
+        field :account_type, -> { String }, optional: false, nullable: false, api_name: "accountType"
+
+        field :bank_account_holder_type, -> { String }, optional: false, nullable: false, api_name: "bankAccountHolderType"
+
+        field :bank_account_function, -> { Payabli::Types::CaseManagementBankAccountFunction }, optional: false, nullable: false, api_name: "bankAccountFunction"
+
+        field :services, -> { Payabli::Types::BankAccountServices }, optional: false, nullable: false
+
+        field :default, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+        field :schedule_for, -> { String }, optional: true, nullable: false, api_name: "scheduleFor"
+      end
+    end
+  end
+end

data/lib/payabli/case_management/types/list_cases_case_management_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Payabli
+  module CaseManagement
+    module Types
+      class ListCasesCaseManagementRequest < Internal::Types::Model
+        field :organization_id, -> { Integer }, optional: false, nullable: false, api_name: "organizationId"
+
+        field :from_record, -> { Integer }, optional: true, nullable: false, api_name: "fromRecord"
+
+        field :limit_record, -> { Integer }, optional: true, nullable: false, api_name: "limitRecord"
+
+        field :sort_by, -> { String }, optional: true, nullable: false, api_name: "sortBy"
+      end
+    end
+  end
+end

data/lib/payabli/case_management/types/list_messages_case_management_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Payabli
+  module CaseManagement
+    module Types
+      class ListMessagesCaseManagementRequest < Internal::Types::Model
+        field :case_uuid, -> { String }, optional: false, nullable: false, api_name: "caseUuid"
+
+        field :limit, -> { Integer }, optional: true, nullable: false
+
+        field :cursor, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/payabli/case_management/types/post_case_message_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module CaseManagement
+    module Types
+      class PostCaseMessageRequest < Internal::Types::Model
+        field :case_uuid, -> { String }, optional: false, nullable: false, api_name: "caseUuid"
+
+        field :content, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/payabli/case_management/types/transition_case_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Payabli
+  module CaseManagement
+    module Types
+      class TransitionCaseRequest < Internal::Types::Model
+        field :uuid, -> { String }, optional: false, nullable: false
+
+        field :trigger, -> { Payabli::Types::CaseTrigger }, optional: false, nullable: false
+
+        field :reason, -> { String }, optional: false, nullable: false
+
+        field :decline_reason, -> { Payabli::Types::BankReviewDecisionReason }, optional: true, nullable: false, api_name: "declineReason"
+      end
+    end
+  end
+end

data/lib/payabli/case_management/types/upload_attachment_case_management_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Payabli
+  module CaseManagement
+    module Types
+      class UploadAttachmentCaseManagementRequest < Internal::Types::Model
+        field :case_uuid, -> { String }, optional: false, nullable: false, api_name: "caseUuid"
+      end
+    end
+  end
+end

data/lib/payabli/case_management/types/validate_bank_account_change_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module CaseManagement
+    module Types
+      class ValidateBankAccountChangeRequest < Internal::Types::Model
+        field :paypoint_id, -> { Integer }, optional: false, nullable: false, api_name: "paypointId"
+
+        field :routing_number, -> { String }, optional: false, nullable: false, api_name: "routingNumber"
+
+        field :account_number, -> { String }, optional: false, nullable: false, api_name: "accountNumber"
+
+        field :account_type, -> { String }, optional: false, nullable: false, api_name: "accountType"
+
+        field :bank_account_holder_type, -> { String }, optional: false, nullable: false, api_name: "bankAccountHolderType"
+
+        field :bank_account_function, -> { Payabli::Types::CaseManagementBankAccountFunction }, optional: false, nullable: false, api_name: "bankAccountFunction"
+
+        field :services, -> { Payabli::Types::BankAccountServices }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/payabli/charge_backs/client.rb

@@ -22,6 +22,12 @@ module Payabli
       # @option params [Integer] :id
       # @option params [String, nil] :idempotency_key
       #
+      # @example
+      #   client.charge_backs.add_response(
+      #     id: 1000000,
+      #     idempotency_key: "6B29FC40-CA47-1067-B31D-00DD010662DA"
+      #   )
+      #
       # @return [Payabli::Types::AddResponseResponse]
       def add_response(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
@@ -32,6 +38,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",
@@ -65,13 +72,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :id
       #
+      # @example
+      #   client.charge_backs.get_chargeback(id: 1000000)
+      #
       # @return [Payabli::Types::ChargebackQueryRecords]
       def get_chargeback(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: "ChargeBacks/read/#{URI.encode_uri_component(params[:id].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -100,13 +112,21 @@ module Payabli
       # @option params [Integer] :id
       # @option params [String] :file_name
       #
+      # @example
+      #   client.charge_backs.get_chargeback_attachment(
+      #     id: 1000000,
+      #     file_name: "fileName"
+      #   )
+      #
       # @return [String]
       def get_chargeback_attachment(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: "ChargeBacks/getChargebackAttachments/#{URI.encode_uri_component(params[:id].to_s)}/#{URI.encode_uri_component(params[:file_name].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin

data/lib/payabli/check_capture/client.rb

@@ -22,13 +22,23 @@ module Payabli
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       #
+      # @example
+      #   client.check_capture.check_processing(
+      #     entry_point: "8cfec329267",
+      #     front_image: "/9j/4AAQSkZJRgABAQEASABIAAD...",
+      #     rear_image: "/9j/4AAQSkZJRgABAQEASABIAAD...",
+      #     check_amount: 12550
+      #   )
+      #
       # @return [Payabli::Types::CheckCaptureResponse]
       def check_processing(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: "CheckCapture/CheckProcessing",
+          headers: headers,
           body: Payabli::CheckCapture::Types::CheckCaptureRequestBody.new(params).to_h,
           request_options: request_options
         )

data/lib/payabli/client.rb

@@ -2,19 +2,43 @@
 
 module Payabli
   class Client
-    # @param api_key [String]
     # @param base_url [String, nil]
+    # @param client_id [String, nil]
+    # @param client_secret [String, nil]
+    # @param api_key [String]
     # @param max_retries [Integer]
     #
     # @return [void]
-    def initialize(api_key:, base_url: nil, max_retries: 2)
+    def initialize(base_url: nil, client_id: ENV.fetch("OAUTH_CLIENT_ID", nil), client_secret: ENV.fetch("OAUTH_CLIENT_SECRET", nil), api_key: nil, max_retries: 2)
+      if !client_id.to_s.empty? && !client_secret.to_s.empty?
+        # Create an unauthenticated client for the auth endpoint
+        auth_raw_client = Payabli::Internal::Http::RawClient.new(
+          base_url: base_url || Payabli::Environment::SANDBOX,
+          headers: {
+            "X-Fern-Language" => "Ruby"
+          }
+        )
+
+        # Create the auth client for token retrieval
+        auth_client = Payabli::Token::Client.new(client: auth_raw_client)
+
+        # Create the OAuth provider with the auth client and credentials
+        @oauth_provider = Payabli::Internal::OAuthProvider.new(
+          auth_client: auth_client,
+          options: { base_url: base_url, client_id: client_id, client_secret: client_secret }
+        )
+      end
+
       @raw_client = Payabli::Internal::Http::RawClient.new(
         base_url: base_url || Payabli::Environment::SANDBOX,
         headers: {
-          "User-Agent" => "payabli/3.0.5",
-          "X-Fern-Language" => "Ruby",
-          requestToken: api_key.to_s
+          "User-Agent" => "payabli/3.0.7",
+          "X-Fern-Language" => "Ruby"
         },
+        auth_provider: Payabli::Internal::RoutingAuthProvider.new(
+          api_key: api_key,
+          oauth_provider: @oauth_provider
+        ),
         max_retries: max_retries
       )
     end
@@ -183,5 +207,10 @@ module Payabli
     def charge_backs
       @charge_backs ||= Payabli::ChargeBacks::Client.new(client: @raw_client)
     end
+
+    # @return [Payabli::CaseManagement::Client]
+    def case_management
+      @case_management ||= Payabli::CaseManagement::Client.new(client: @raw_client)
+    end
   end
 end

data/lib/payabli/cloud/client.rb

@@ -23,6 +23,13 @@ module Payabli
       # @option params [String] :entry
       # @option params [String, nil] :idempotency_key
       #
+      # @example
+      #   client.cloud.add_device(
+      #     entry: "8cfec329267",
+      #     description: "Front Desk POS",
+      #     registration_code: "YS7DS5"
+      #   )
+      #
       # @return [Payabli::Types::AddDeviceResponse]
       def add_device(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
@@ -33,6 +40,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",
@@ -67,13 +75,21 @@ module Payabli
       # @option params [String] :entry
       # @option params [String] :device_id
       #
+      # @example
+      #   client.cloud.remove_device(
+      #     entry: "8cfec329267",
+      #     device_id: "499585-389fj484-3jcj8hj3"
+      #   )
+      #
       # @return [Payabli::Types::RemoveDeviceResponse]
       def remove_device(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: "Cloud/register/#{URI.encode_uri_component(params[:entry].to_s)}/#{URI.encode_uri_component(params[:device_id].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -102,13 +118,21 @@ module Payabli
       # @option params [String] :entry
       # @option params [String] :device_id
       #
+      # @example
+      #   client.cloud.history_device(
+      #     entry: "8cfec329267",
+      #     device_id: "499585-389fj484-3jcj8hj3"
+      #   )
+      #
       # @return [Payabli::Types::CloudQueryApiResponse]
       def history_device(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: "Cloud/history/#{URI.encode_uri_component(params[:entry].to_s)}/#{URI.encode_uri_component(params[:device_id].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -140,16 +164,21 @@ module Payabli
       # @option params [String] :entry
       # @option params [Boolean, nil] :force_refresh
       #
+      # @example
+      #   client.cloud.list_device(entry: "8cfec329267")
+      #
       # @return [Payabli::Types::CloudQueryApiResponse]
       def list_device(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
         query_params = {}
         query_params["forceRefresh"] = params[:force_refresh] if params.key?(:force_refresh)
 
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
         request = Payabli::Internal::JSON::Request.new(
           base_url: request_options[:base_url],
           method: "GET",
           path: "Cloud/list/#{URI.encode_uri_component(params[:entry].to_s)}",
+          headers: headers,
           query: query_params,
           request_options: request_options
         )

data/lib/payabli/customer/client.rb

@@ -26,6 +26,22 @@ module Payabli
       # @option params [Integer, nil] :replace_existing
       # @option params [String, nil] :idempotency_key
       #
+      # @example
+      #   client.customer.add_customer(
+      #     entry: "8cfec329267",
+      #     customer_number: "C-90010",
+      #     firstname: "Irene",
+      #     lastname: "Canizales",
+      #     email: "irene@canizalesconcrete.com",
+      #     address_1: "123 Bishop's Trail",
+      #     city: "Mountain City",
+      #     state: "TN",
+      #     zip: "37612",
+      #     country: "US",
+      #     time_zone: -5,
+      #     identifier_fields: ["email"]
+      #   )
+      #
       # @return [Payabli::Types::PayabliApiResponseCustomerQuery]
       def add_customer(request_options: {}, **params)
         params = Payabli::Internal::Types::Utils.normalize_keys(params)
@@ -41,6 +57,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",
@@ -75,13 +92,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :customer_id
       #
+      # @example
+      #   client.customer.get_customer(customer_id: 4440)
+      #
       # @return [Payabli::Types::CustomerQueryRecords]
       def get_customer(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: "Customer/#{URI.encode_uri_component(params[:customer_id].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -109,13 +131,27 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :customer_id
       #
+      # @example
+      #   client.customer.update_customer(
+      #     customer_id: 4440,
+      #     firstname: "Irene",
+      #     lastname: "Canizales",
+      #     address_1: "145 Bishop's Trail",
+      #     city: "Mountain City",
+      #     state: "TN",
+      #     zip: "37612",
+      #     country: "US"
+      #   )
+      #
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def update_customer(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: "Customer/#{URI.encode_uri_component(params[:customer_id].to_s)}",
+          headers: headers,
           body: Payabli::Types::CustomerData.new(params).to_h,
           request_options: request_options
         )
@@ -144,13 +180,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :customer_id
       #
+      # @example
+      #   client.customer.delete_customer(customer_id: 4440)
+      #
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def delete_customer(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: "Customer/#{URI.encode_uri_component(params[:customer_id].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -178,13 +219,18 @@ module Payabli
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [Integer] :customer_id
       #
+      # @example
+      #   client.customer.request_consent(customer_id: 4440)
+      #
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def request_consent(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: "Customer/#{URI.encode_uri_component(params[:customer_id].to_s)}/consent",
+          headers: headers,
           request_options: request_options
         )
         begin
@@ -213,13 +259,21 @@ module Payabli
       # @option params [Integer] :customer_id
       # @option params [String] :trans_id
       #
+      # @example
+      #   client.customer.link_customer_transaction(
+      #     customer_id: 4440,
+      #     trans_id: "45-as456777hhhhhhhhhh77777777-324"
+      #   )
+      #
       # @return [Payabli::Types::PayabliApiResponse00Responsedatanonobject]
       def link_customer_transaction(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: "Customer/link/#{URI.encode_uri_component(params[:customer_id].to_s)}/#{URI.encode_uri_component(params[:trans_id].to_s)}",
+          headers: headers,
           request_options: request_options
         )
         begin