payabli 3.0.18 → 3.0.20

data/lib/payabli/businesses/types/create_business_address_request.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Businesses
+    module Types
+      class CreateBusinessAddressRequest < Internal::Types::Model
+        field :business_reference, -> { String }, optional: false, nullable: false, api_name: "businessReference"
+
+        field :type, -> { Payabli::Types::AddressType }, optional: false, nullable: false
+
+        field :location, -> { Payabli::Types::BusinessAddressLocation }, optional: true, nullable: false
+
+        field :address_line_1, -> { String }, optional: false, nullable: false, api_name: "addressLine1"
+
+        field :address_line_2, -> { String }, optional: true, nullable: false, api_name: "addressLine2"
+
+        field :city_locality, -> { String }, optional: false, nullable: false, api_name: "cityLocality"
+
+        field :state_province, -> { String }, optional: false, nullable: false, api_name: "stateProvince"
+
+        field :postal_code, -> { String }, optional: false, nullable: false, api_name: "postalCode"
+
+        field :country, -> { String }, optional: false, nullable: false
+
+        field :floor, -> { String }, optional: true, nullable: false
+
+        field :suite_apart_number, -> { String }, optional: true, nullable: false, api_name: "suiteApartNumber"
+      end
+    end
+  end
+end

data/lib/payabli/businesses/types/deactivate_business_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Businesses
+    module Types
+      class DeactivateBusinessRequest < Internal::Types::Model
+        field :business_reference, -> { String }, optional: false, nullable: false, api_name: "businessReference"
+
+        field :reason, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/payabli/businesses/types/link_business_person_request.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Businesses
+    module Types
+      class LinkBusinessPersonRequest < Internal::Types::Model
+        field :business_reference, -> { String }, optional: false, nullable: false, api_name: "businessReference"
+
+        field :person_reference, -> { String }, optional: false, nullable: false, api_name: "personReference"
+
+        field :person_type, -> { Payabli::Types::PersonType }, optional: true, nullable: false, api_name: "personType"
+
+        field :ownership_percentage, -> { Integer }, optional: true, nullable: false, api_name: "ownershipPercentage"
+
+        field :is_primary_controller, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isPrimaryController"
+
+        field :is_signer, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSigner"
+
+        field :title, -> { String }, optional: true, nullable: false
+
+        field :primary_email, -> { String }, optional: true, nullable: false, api_name: "primaryEmail"
+
+        field :secondary_email, -> { String }, optional: true, nullable: false, api_name: "secondaryEmail"
+
+        field :primary_phone_number, -> { String }, optional: true, nullable: false, api_name: "primaryPhoneNumber"
+
+        field :secondary_phone_number, -> { String }, optional: true, nullable: false, api_name: "secondaryPhoneNumber"
+
+        field :billing_address, -> { Payabli::Types::PersonAddressRequest }, optional: true, nullable: false, api_name: "billingAddress"
+
+        field :mailing_address, -> { Payabli::Types::PersonAddressRequest }, optional: true, nullable: false, api_name: "mailingAddress"
+      end
+    end
+  end
+end

data/lib/payabli/businesses/types/list_businesses_businesses_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Businesses
+    module Types
+      class ListBusinessesBusinessesRequest < Internal::Types::Model
+        field :status, -> { String }, optional: true, nullable: false
+
+        field :name, -> { String }, optional: true, nullable: false
+
+        field :merchant_cat_code, -> { String }, optional: true, nullable: false, api_name: "merchantCatCode"
+
+        field :legal_structure, -> { String }, optional: true, nullable: false, api_name: "legalStructure"
+
+        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/businesses/types/update_business_address_request.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Businesses
+    module Types
+      class UpdateBusinessAddressRequest < Internal::Types::Model
+        field :business_reference, -> { String }, optional: false, nullable: false, api_name: "businessReference"
+
+        field :business_address_reference, -> { String }, optional: false, nullable: false, api_name: "businessAddressReference"
+
+        field :type, -> { Payabli::Types::AddressType }, optional: true, nullable: false
+
+        field :location, -> { Payabli::Types::BusinessAddressLocation }, optional: true, nullable: false
+
+        field :address_line_1, -> { String }, optional: true, nullable: false, api_name: "addressLine1"
+
+        field :address_line_2, -> { String }, optional: true, nullable: false, api_name: "addressLine2"
+
+        field :city_locality, -> { String }, optional: true, nullable: false, api_name: "cityLocality"
+
+        field :state_province, -> { String }, optional: true, nullable: false, api_name: "stateProvince"
+
+        field :postal_code, -> { String }, optional: true, nullable: false, api_name: "postalCode"
+
+        field :country, -> { String }, optional: true, nullable: false
+
+        field :floor, -> { String }, optional: true, nullable: false
+
+        field :suite_apart_number, -> { String }, optional: true, nullable: false, api_name: "suiteApartNumber"
+      end
+    end
+  end
+end

data/lib/payabli/businesses/types/update_business_person_request.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Businesses
+    module Types
+      class UpdateBusinessPersonRequest < Internal::Types::Model
+        field :business_reference, -> { String }, optional: false, nullable: false, api_name: "businessReference"
+
+        field :person_reference, -> { String }, optional: false, nullable: false, api_name: "personReference"
+
+        field :person_type, -> { Payabli::Types::PersonType }, optional: true, nullable: false, api_name: "personType"
+
+        field :ownership_percentage, -> { Integer }, optional: true, nullable: false, api_name: "ownershipPercentage"
+
+        field :is_primary_controller, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isPrimaryController"
+
+        field :is_signer, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSigner"
+
+        field :title, -> { String }, optional: true, nullable: false
+
+        field :primary_email, -> { String }, optional: true, nullable: false, api_name: "primaryEmail"
+
+        field :secondary_email, -> { String }, optional: true, nullable: false, api_name: "secondaryEmail"
+
+        field :primary_phone_number, -> { String }, optional: true, nullable: false, api_name: "primaryPhoneNumber"
+
+        field :secondary_phone_number, -> { String }, optional: true, nullable: false, api_name: "secondaryPhoneNumber"
+
+        field :billing_address, -> { Payabli::Types::PersonAddressRequest }, optional: true, nullable: false, api_name: "billingAddress"
+
+        field :mailing_address, -> { Payabli::Types::PersonAddressRequest }, optional: true, nullable: false, api_name: "mailingAddress"
+      end
+    end
+  end
+end

data/lib/payabli/businesses/types/update_business_request.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Businesses
+    module Types
+      class UpdateBusinessRequest < Internal::Types::Model
+        field :business_reference, -> { String }, optional: false, nullable: false, api_name: "businessReference"
+
+        field :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId"
+
+        field :legal_name, -> { String }, optional: true, nullable: false, api_name: "legalName"
+
+        field :description, -> { String }, optional: true, nullable: false
+
+        field :legal_structure, -> { Payabli::Businesses::Types::UpdateBusinessRequestLegalStructure }, optional: true, nullable: false, api_name: "legalStructure"
+
+        field :stock_symbol, -> { String }, optional: true, nullable: false, api_name: "stockSymbol"
+
+        field :incorporation_state, -> { String }, optional: true, nullable: false, api_name: "incorporationState"
+
+        field :tax_id_country, -> { String }, optional: true, nullable: false, api_name: "taxIdCountry"
+
+        field :established_date, -> { String }, optional: true, nullable: false, api_name: "establishedDate"
+
+        field :number_of_employees, -> { Integer }, optional: true, nullable: false, api_name: "numberOfEmployees"
+
+        field :annual_revenue, -> { Integer }, optional: true, nullable: false, api_name: "annualRevenue"
+
+        field :website, -> { String }, optional: true, nullable: false
+
+        field :merchant_cat_code, -> { String }, optional: true, nullable: false, api_name: "merchantCatCode"
+
+        field :timezone, -> { String }, optional: true, nullable: false
+
+        field :phone, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+        field :emails, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+        field :operating_seasons, -> { Internal::Types::Array[Payabli::Businesses::Types::UpdateBusinessRequestOperatingSeasonsItem] }, optional: true, nullable: false, api_name: "operatingSeasons"
+
+        field :address_details, -> { Internal::Types::Array[Payabli::Types::BusinessAddress] }, optional: true, nullable: false, api_name: "addressDetails"
+
+        field :payment_methods, -> { Internal::Types::Array[Payabli::Types::BusinessPaymentMethod] }, optional: true, nullable: false, api_name: "paymentMethods"
+
+        field :custom_data, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false, api_name: "customData"
+
+        field :is_foreign_owned, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isForeignOwned"
+
+        field :is_tax_exempt, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isTaxExempt"
+
+        field :tax_exempt_classification, -> { String }, optional: true, nullable: false, api_name: "taxExemptClassification"
+
+        field :processing_metrics, -> { Payabli::Types::ProcessingMetrics }, optional: true, nullable: false, api_name: "processingMetrics"
+
+        field :payout_metrics, -> { Payabli::Types::PayoutMetrics }, optional: true, nullable: false, api_name: "payoutMetrics"
+
+        field :license, -> { String }, optional: true, nullable: false
+
+        field :license_state, -> { String }, optional: true, nullable: false, api_name: "licenseState"
+      end
+    end
+  end
+end

data/lib/payabli/businesses/types/update_business_request_legal_structure.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Businesses
+    module Types
+      module UpdateBusinessRequestLegalStructure
+        extend Payabli::Internal::Types::Enum
+
+        LIMITED_LIABILITY_COMPANY = "limited-liability-company"
+        LLC = "llc"
+        CORPORATION = "corporation"
+        PARTNERSHIP = "partnership"
+        SOLE_PROPRIETORSHIP = "sole-proprietorship"
+        NON_PROFIT = "non-profit"
+        GOVERNMENT = "government"
+        S_CORP = "s-corp"
+        S_CORPORATION = "s-corporation"
+      end
+    end
+  end
+end

data/lib/payabli/businesses/types/update_business_request_operating_seasons_item.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Businesses
+    module Types
+      module UpdateBusinessRequestOperatingSeasonsItem
+        extend Payabli::Internal::Types::Enum
+
+        SPRING = "Spring"
+        SUMMER = "Summer"
+        FALL = "Fall"
+        WINTER = "Winter"
+      end
+    end
+  end
+end

data/lib/payabli/client.rb

@@ -32,7 +32,7 @@ module Payabli
       @raw_client = Payabli::Internal::Http::RawClient.new(
         base_url: base_url || Payabli::Environment::SANDBOX,
         headers: {
-          "User-Agent" => "payabli/3.0.18",
+          "User-Agent" => "payabli/3.0.20",
           "X-Fern-Language" => "Ruby"
         },
         auth_provider: Payabli::Internal::RoutingAuthProvider.new(
@@ -143,6 +143,36 @@ module Payabli
       @line_item ||= Payabli::LineItem::Client.new(client: @raw_client)
     end
 
+    # @return [Payabli::Businesses::Client]
+    def businesses
+      @businesses ||= Payabli::Businesses::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::People::Client]
+    def people
+      @people ||= Payabli::People::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Paypoints::Client]
+    def paypoints
+      @paypoints ||= Payabli::Paypoints::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::PaymentMethods::Client]
+    def payment_methods
+      @payment_methods ||= Payabli::PaymentMethods::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::BoardingTemplates::Client]
+    def boarding_templates
+      @boarding_templates ||= Payabli::BoardingTemplates::Client.new(client: @raw_client)
+    end
+
+    # @return [Payabli::Applications::Client]
+    def applications
+      @applications ||= Payabli::Applications::Client.new(client: @raw_client)
+    end
+
     # @return [Payabli::Boarding::Client]
     def boarding
       @boarding ||= Payabli::Boarding::Client.new(client: @raw_client)

data/lib/payabli/export/client.rb

@@ -11,9 +11,8 @@ module Payabli
       end
 
       # <Warning>
-      # This endpoint is deprecated. To export this data, use [List all apps for
-      # org](/developers/api-reference/boarding/get-list-of-applications-for-an-organization) with the `exportFormat`
-      # query parameter instead.
+      # Legacy boarding is deprecated and will be sunset in Q2 2027. Use [List
+      # applications](/developers/api-reference/applications/list-applications) instead. It doesn't export files.
       # </Warning>
       #
       # Export a list of boarding applications for an organization. Use filters to limit results.

data/lib/payabli/ghost_card/client.rb

@@ -16,8 +16,9 @@ module Payabli
       # payout. They're issued directly to a vendor and can be reused up to a configurable number of times within the
       # card's spending limits.
       #
-      # Only one ghost card can exist per vendor per paypoint. To issue a new card to the same vendor, cancel the
-      # existing card first.
+      # Only one active ghost card can exist per vendor per paypoint. If the vendor already has one, the request fails
+      # with error `7067`. To issue a new card to the same vendor, cancel the existing card first. Canceled and expired
+      # cards don't count toward this limit. See [Cancel ghost card](/developers/api-reference/cards/cancel-ghost-card).
       #
       # @param request_options [Hash]
       # @param params [Payabli::GhostCard::Types::CreateGhostCardRequestBody]
@@ -78,6 +79,51 @@ module Payabli
         end
       end
 
+      # Cancels a ghost card. This is always a soft delete: Payabli keeps the card record, including its transaction
+      # history.
+      #
+      # Canceling a ghost card frees the vendor's slot, so you can issue a new ghost card to the same vendor. A card
+      # canceled with this endpoint can't be used, reactivated, or canceled again.
+      #
+      # Requires the `vcard_delete` permission.
+      #
+      # @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] :card_token
+      #
+      # @example
+      #   client.ghost_card.delete_ghost_card(card_token: "gc_abc123def456")
+      #
+      # @return [Payabli::Types::DeleteGhostCardResponse]
+      def delete_ghost_card(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: "MoneyOutCard/GhostCard/#{URI.encode_uri_component(params[:card_token].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::DeleteGhostCardResponse.load(response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
       # Updates the status of a virtual card (including ghost cards) under a paypoint.
       #
       # @param request_options [Hash]

data/lib/payabli/money_out/client.rb

@@ -673,11 +673,65 @@ module Payabli
         end
       end
 
+      # Returns a suggested check number for the next check payout from a paypoint's funding account. Payabli suggests
+      # the highest check number on the account's check payouts plus one, or `1` if the account has no check history.
+      # Canceled check payouts don't count toward the highest number.
+      #
+      #
+      # Use the suggested value with the `checkNumber` field when you reissue a check, or when you create a new check
+      # payout.
+      #
+      #
+      # Errors return HTTP `400`: `3005` when the paypoint ID is invalid or inactive, and `3758` when the account ID
+      # isn't valid for the paypoint.
+      #
+      # @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] :paypoint_id
+      # @option params [String] :account_id
+      #
+      # @example
+      #   client.money_out.get_next_check_number(
+      #     paypoint_id: 3040,
+      #     account_id: "123-456"
+      #   )
+      #
+      # @return [Payabli::Types::NextCheckNumberResponse]
+      def get_next_check_number(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: "MoneyOut/nextCheckNumber/#{URI.encode_uri_component(params[:paypoint_id].to_s)}/#{URI.encode_uri_component(params[:account_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::NextCheckNumberResponse.load(response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
       # Reissues a payout transaction with a new payment method. This creates a new transaction linked to the original
       # and marks the original transaction as reissued.
       #
-      # The original transaction must be in **Processing** or **Processed** status. The payment method in the request
-      # body is used directly. The endpoint doesn't fall back to vendor-managed payment methods.
+      # The original transaction must be in **Processing** or **Processed** status. An ACH payout with a **Returned**
+      # status can also be reissued. The payment method in the request body is used directly. The endpoint doesn't fall
+      # back to vendor-managed payment methods.
       #
       # The new transaction goes through the standard authorize-and-capture flow automatically. Both the original and
       # new transactions are linked through their event histories for audit purposes.

data/lib/payabli/money_out/types/reissue_out_request.rb

@@ -9,6 +9,8 @@ module Payabli
         field :idempotency_key, -> { String }, optional: true, nullable: false, api_name: "idempotencyKey"
 
         field :payment_method, -> { Payabli::Types::ReissuePaymentMethod }, optional: false, nullable: false, api_name: "paymentMethod"
+
+        field :check_number, -> { String }, optional: true, nullable: false, api_name: "checkNumber"
       end
     end
   end