payabli 3.0.19 → 3.0.21

data/lib/payabli/payment_methods/client.rb

@@ -0,0 +1,254 @@
+# frozen_string_literal: true
+
+module Payabli
+  module PaymentMethods
+    class Client
+      # @param client [Payabli::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Lists payment methods with optional filtering and pagination.
+      #
+      # @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, nil] :account_owner
+      # @option params [Payabli::Types::PaymentMethodOwnerType, nil] :owner_type
+      # @option params [String, nil] :status
+      # @option params [String, nil] :type
+      # @option params [Integer, nil] :limit
+      # @option params [Integer, nil] :page
+      # @option params [String, nil] :sort_by
+      # @option params [String, nil] :sort_order
+      #
+      # @example
+      #   client.payment_methods.list_payment_methods(
+      #     limit: 1,
+      #     page: 1
+      #   )
+      #
+      # @return [Payabli::Types::ListPaymentMethodsEnvelope]
+      def list_payment_methods(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["accountOwner"] = params[:account_owner] if params.key?(:account_owner)
+        query_params["ownerType"] = params[:owner_type] if params.key?(:owner_type)
+        query_params["status"] = params[:status] if params.key?(:status)
+        query_params["type"] = params[:type] if params.key?(:type)
+        query_params["limit"] = params[:limit] if params.key?(:limit)
+        query_params["page"] = params[:page] if params.key?(:page)
+        query_params["sortBy"] = params[:sort_by] if params.key?(:sort_by)
+        query_params["sortOrder"] = params[:sort_order] if params.key?(:sort_order)
+
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }])
+        request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v2/payment-methods",
+          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::ListPaymentMethodsEnvelope.load(response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Creates one or more payment methods for an entity in a single call.
+      # Set each payment method's `accountOwner` to the entity it belongs to.
+      #
+      # @param request_options [Hash]
+      # @param params [Payabli::PaymentMethods::Types::CreatePaymentMethodsRequest]
+      # @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
+      #
+      # @example
+      #   client.payment_methods.create_payment_methods(data: [{
+      #     type: "bank_account",
+      #     account_owner: "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
+      #     owner_type: "business",
+      #     account_type: "checking",
+      #     account_number: "123456789",
+      #     routing_number: "021000021",
+      #     nickname: "Operating account",
+      #     financial_institution: "Bank of Example",
+      #     usage: %w[deposits billing]
+      #   }])
+      #
+      # @return [Payabli::Types::PaymentMethodsCreatedEnvelope]
+      def create_payment_methods(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: "v2/payment-methods",
+          headers: headers,
+          body: Payabli::PaymentMethods::Types::CreatePaymentMethodsRequest.new(params).to_h,
+          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::PaymentMethodsCreatedEnvelope.load(response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Retrieves a payment method by reference. Sensitive fields such as the account and routing numbers are masked.
+      #
+      # @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] :payment_method_reference
+      #
+      # @example
+      #   client.payment_methods.get_payment_method(payment_method_reference: "019ff142-454b-7721-96a3-c8628b9d568f")
+      #
+      # @return [Payabli::Types::PaymentMethodDetailEnvelope]
+      def get_payment_method(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: "GET",
+          path: "v2/payment-methods/#{URI.encode_uri_component(params[:payment_method_reference].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::PaymentMethodDetailEnvelope.load(response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Deactivates a payment method. This is a soft delete: the payment
+      # method moves to `INACTIVE` and the record is kept.
+      #
+      # @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] :payment_method_reference
+      #
+      # @example
+      #   client.payment_methods.deactivate_payment_method(payment_method_reference: "019ff142-454b-7721-96a3-c8628b9d568f")
+      #
+      # @return [Payabli::Types::PaymentMethodDeactivatedEnvelope]
+      def deactivate_payment_method(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: "DELETE",
+          path: "v2/payment-methods/#{URI.encode_uri_component(params[:payment_method_reference].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::PaymentMethodDeactivatedEnvelope.load(response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Applies a partial update to a payment method. Send only the fields you
+      # want to change. Only payment methods in `PENDING` status can be updated.
+      # Once a payment method is active, change it through the bank account
+      # change process instead.
+      #
+      # @param request_options [Hash]
+      # @param params [Payabli::PaymentMethods::Types::UpdatePaymentMethodRequest]
+      # @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] :payment_method_reference
+      #
+      # @example
+      #   client.payment_methods.update_payment_method(
+      #     payment_method_reference: "019ff142-454b-7721-96a3-c8628b9d568f",
+      #     nickname: "Primary operating account",
+      #     usage: %w[deposits billing]
+      #   )
+      #
+      # @return [Payabli::Types::PaymentMethodUpdatedEnvelope]
+      def update_payment_method(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        request_data = Payabli::PaymentMethods::Types::UpdatePaymentMethodRequest.new(params).to_h
+        non_body_param_names = %w[paymentMethodReference]
+        body = request_data.except(*non_body_param_names)
+
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }])
+        request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "PATCH",
+          path: "v2/payment-methods/#{URI.encode_uri_component(params[:payment_method_reference].to_s)}",
+          headers: headers,
+          body: body,
+          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::PaymentMethodUpdatedEnvelope.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/payment_methods/types/create_payment_methods_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Payabli
+  module PaymentMethods
+    module Types
+      class CreatePaymentMethodsRequest < Internal::Types::Model
+        field :data, -> { Internal::Types::Array[Payabli::Types::CreatePaymentMethodRequest] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/payabli/payment_methods/types/list_payment_methods_payment_methods_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Payabli
+  module PaymentMethods
+    module Types
+      class ListPaymentMethodsPaymentMethodsRequest < Internal::Types::Model
+        field :account_owner, -> { String }, optional: true, nullable: false, api_name: "accountOwner"
+
+        field :owner_type, -> { Payabli::Types::PaymentMethodOwnerType }, optional: true, nullable: false, api_name: "ownerType"
+
+        field :status, -> { String }, optional: true, nullable: false
+
+        field :type, -> { String }, optional: true, nullable: false
+
+        field :limit, -> { Integer }, optional: true, nullable: false
+
+        field :page, -> { Integer }, optional: true, nullable: false
+
+        field :sort_by, -> { String }, optional: true, nullable: false, api_name: "sortBy"
+
+        field :sort_order, -> { String }, optional: true, nullable: false, api_name: "sortOrder"
+      end
+    end
+  end
+end

data/lib/payabli/payment_methods/types/update_payment_method_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Payabli
+  module PaymentMethods
+    module Types
+      class UpdatePaymentMethodRequest < Internal::Types::Model
+        field :payment_method_reference, -> { String }, optional: false, nullable: false, api_name: "paymentMethodReference"
+
+        field :nickname, -> { String }, optional: true, nullable: false
+
+        field :financial_institution, -> { String }, optional: true, nullable: false, api_name: "financialInstitution"
+
+        field :account_type, -> { String }, optional: true, nullable: false, api_name: "accountType"
+
+        field :account_number, -> { String }, optional: true, nullable: false, api_name: "accountNumber"
+
+        field :routing_number, -> { String }, optional: true, nullable: false, api_name: "routingNumber"
+
+        field :usage, -> { Internal::Types::Array[Payabli::Types::PaymentMethodUsage] }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/payabli/paypoints/client.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Paypoints
+    class Client
+      # @param client [Payabli::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Lists paypoints with optional filtering and pagination.
+      #
+      # @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, nil] :business_reference
+      # @option params [String, nil] :status
+      # @option params [String, nil] :search
+      # @option params [Integer, nil] :limit
+      # @option params [Integer, nil] :page
+      #
+      # @example
+      #   client.paypoints.list_paypoints(
+      #     limit: 1,
+      #     page: 1
+      #   )
+      #
+      # @return [Payabli::Types::ListPaypointsEnvelope]
+      def list_paypoints(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["businessReference"] = params[:business_reference] if params.key?(:business_reference)
+        query_params["status"] = params[:status] if params.key?(:status)
+        query_params["search"] = params[:search] if params.key?(:search)
+        query_params["limit"] = params[:limit] if params.key?(:limit)
+        query_params["page"] = params[:page] if params.key?(:page)
+
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }])
+        request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v2/paypoints",
+          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::ListPaypointsEnvelope.load(response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Creates a paypoint. New paypoints start in `pending`. Provide exactly
+      # one of `businessReference` (an existing business) or `business` (to
+      # create the business inline).
+      #
+      # @param request_options [Hash]
+      # @param params [Payabli::Paypoints::Types::CreatePaypointPaypointsRequest]
+      # @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
+      #
+      # @example
+      #   client.paypoints.create_paypoint(
+      #     paypoint_type: "merchant",
+      #     doing_business_as: "Rose Gardens",
+      #     description: "Boutique flower shop",
+      #     website: "https://example.com",
+      #     customer_service_phone: "3055551212",
+      #     customer_service_email: "support@example.com",
+      #     timezone: "America/New_York",
+      #     business_reference: "019fed1a-3d6e-75d3-a81e-cba3874b0a55"
+      #   )
+      #
+      # @return [Payabli::Types::PaypointCreatedEnvelope]
+      def create_paypoint(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: "v2/paypoints",
+          headers: headers,
+          body: Payabli::Paypoints::Types::CreatePaypointPaypointsRequest.new(params).to_h,
+          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::PaypointCreatedEnvelope.load(response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Retrieves a paypoint by reference.
+      #
+      # @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] :paypoint_reference
+      #
+      # @example
+      #   client.paypoints.get_paypoint(paypoint_reference: "019ff064-c690-7679-a73e-688418aadc7c")
+      #
+      # @return [Payabli::Types::PaypointDetailEnvelope]
+      def get_paypoint(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: "GET",
+          path: "v2/paypoints/#{URI.encode_uri_component(params[:paypoint_reference].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::PaypointDetailEnvelope.load(response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Applies a partial update to a paypoint. Send only the fields you want to change.
+      #
+      # @param request_options [Hash]
+      # @param params [Payabli::Paypoints::Types::UpdatePaypointRequest]
+      # @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] :paypoint_reference
+      #
+      # @example
+      #   client.paypoints.update_paypoint(
+      #     paypoint_reference: "019ff064-c690-7679-a73e-688418aadc7c",
+      #     description: "Updated description"
+      #   )
+      #
+      # @return [Payabli::Types::PaypointUpdatedEnvelope]
+      def update_paypoint(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        request_data = Payabli::Paypoints::Types::UpdatePaypointRequest.new(params).to_h
+        non_body_param_names = %w[paypointReference]
+        body = request_data.except(*non_body_param_names)
+
+        headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }])
+        request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "PATCH",
+          path: "v2/paypoints/#{URI.encode_uri_component(params[:paypoint_reference].to_s)}",
+          headers: headers,
+          body: body,
+          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::PaypointUpdatedEnvelope.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/paypoints/types/create_paypoint_paypoints_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Paypoints
+    module Types
+      class CreatePaypointPaypointsRequest < Internal::Types::Model
+        extend Payabli::Internal::Types::Union
+
+        member -> { Payabli::Types::CreatePaypointWithBusinessReference }
+
+        member -> { Payabli::Types::CreatePaypointWithInlineBusiness }
+
+        member -> { Payabli::Types::CreatePaypointAllFields }
+      end
+    end
+  end
+end

data/lib/payabli/paypoints/types/list_paypoints_paypoints_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Paypoints
+    module Types
+      class ListPaypointsPaypointsRequest < Internal::Types::Model
+        field :business_reference, -> { String }, optional: true, nullable: false, api_name: "businessReference"
+
+        field :status, -> { String }, optional: true, nullable: false
+
+        field :search, -> { String }, optional: true, nullable: false
+
+        field :limit, -> { Integer }, optional: true, nullable: false
+
+        field :page, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/payabli/paypoints/types/update_paypoint_request.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Paypoints
+    module Types
+      class UpdatePaypointRequest < Internal::Types::Model
+        field :paypoint_reference, -> { String }, optional: false, nullable: false, api_name: "paypointReference"
+
+        field :paypoint_type, -> { String }, optional: true, nullable: false, api_name: "paypointType"
+
+        field :doing_business_as, -> { String }, optional: true, nullable: false, api_name: "doingBusinessAs"
+
+        field :description, -> { String }, optional: true, nullable: false
+
+        field :website, -> { String }, optional: true, nullable: false
+
+        field :customer_service_phone, -> { String }, optional: true, nullable: false, api_name: "customerServicePhone"
+
+        field :customer_service_email, -> { String }, optional: true, nullable: false, api_name: "customerServiceEmail"
+
+        field :timezone, -> { String }, optional: true, nullable: false
+
+        field :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId"
+
+        field :custom_data, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false, api_name: "customData"
+      end
+    end
+  end
+end