payabli 3.0.18 → 3.0.20

data/lib/payabli/applications/types/create_application_request.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Applications
+    module Types
+      class CreateApplicationRequest < Internal::Types::Model
+        field :business_reference, -> { String }, optional: false, nullable: false, api_name: "businessReference"
+
+        field :paypoint_reference, -> { String }, optional: true, nullable: false, api_name: "paypointReference"
+
+        field :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId"
+
+        field :entity_type, -> { String }, optional: true, nullable: false, api_name: "entityType"
+
+        field :request_template, -> { String }, optional: true, nullable: false, api_name: "requestTemplate"
+
+        field :tags, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+        field :representatives, -> { Internal::Types::Array[Payabli::Types::RepresentativeInput] }, optional: true, nullable: false
+
+        field :configurations, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
+
+        field :services, -> { Payabli::Types::RequestedServices }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/payabli/applications/types/list_applications_applications_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Applications
+    module Types
+      class ListApplicationsApplicationsRequest < Internal::Types::Model
+        field :page, -> { Integer }, optional: true, nullable: false
+
+        field :limit, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/payabli/applications/types/submit_application_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Applications
+    module Types
+      class SubmitApplicationRequest < Internal::Types::Model
+        field :requests_reference, -> { String }, optional: false, nullable: false, api_name: "requestsReference"
+
+        field :signer, -> { Payabli::Types::SubmitSigner }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/payabli/applications/types/update_application_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Applications
+    module Types
+      class UpdateApplicationRequest < Internal::Types::Model
+        field :requests_reference, -> { String }, optional: false, nullable: false, api_name: "requestsReference"
+
+        field :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId"
+
+        field :entity_type, -> { String }, optional: true, nullable: false, api_name: "entityType"
+
+        field :request_template, -> { String }, optional: true, nullable: false, api_name: "requestTemplate"
+
+        field :tags, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+        field :representatives, -> { Internal::Types::Array[Payabli::Types::RepresentativeInput] }, optional: true, nullable: false
+
+        field :configurations, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
+
+        field :services, -> { Payabli::Types::RequestedServices }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/payabli/applications/types/upload_application_document_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Applications
+    module Types
+      class UploadApplicationDocumentRequest < Internal::Types::Model
+        field :requests_reference, -> { String }, optional: false, nullable: false, api_name: "requestsReference"
+      end
+    end
+  end
+end

data/lib/payabli/applications/types/withdraw_application_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Applications
+    module Types
+      class WithdrawApplicationRequest < Internal::Types::Model
+        field :requests_reference, -> { String }, optional: false, nullable: false, api_name: "requestsReference"
+
+        field :reason, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/payabli/boarding/client.rb

@@ -10,6 +10,14 @@ module Payabli
         @client = client
       end
 
+      # <Warning>
+      # Legacy boarding is deprecated and will be sunset in Q2 2027. Use [Create an
+      # application](/developers/api-reference/applications/create-an-application) instead. One legacy call becomes
+      # several intelligent boarding calls, one for each record. See [Map legacy calls to new
+      # endpoints](/guides/pay-ops-developer-boarding-legacy-migrate#map-legacy-calls-to-new-endpoints).
+      # </Warning>
+      #
+      #
       # Creates a boarding application in an organization. This endpoint requires an application API token.
       #
       # @param request_options [Hash]
@@ -170,6 +178,15 @@ module Payabli
         end
       end
 
+      # <Warning>
+      # Legacy boarding is deprecated and will be sunset in Q2 2027. Update the record that holds the data instead, such
+      # as [the business](/developers/api-reference/businesses/update-a-business) or [a
+      # person](/developers/api-reference/people/update-a-person). Use [Update an
+      # application](/developers/api-reference/applications/update-an-application) only for the application's own
+      # fields.
+      # </Warning>
+      #
+      #
       # Updates a boarding application by ID. This endpoint requires an application API token.
       #
       # @param request_options [Hash]
@@ -213,6 +230,12 @@ module Payabli
         end
       end
 
+      # <Warning>
+      # Legacy boarding is deprecated and will be sunset in Q2 2027. Use [Withdraw an
+      # application](/developers/api-reference/applications/withdraw-an-application) instead.
+      # </Warning>
+      #
+      #
       # Deletes a boarding application by ID.
       #
       # @param request_options [Hash]
@@ -252,6 +275,12 @@ module Payabli
         end
       end
 
+      # <Warning>
+      # Legacy boarding is deprecated and will be sunset in Q2 2027. Use [Get an
+      # application](/developers/api-reference/applications/get-an-application) instead.
+      # </Warning>
+      #
+      #
       # Retrieves the details for a boarding application by ID.
       #
       # @param request_options [Hash]
@@ -291,6 +320,13 @@ module Payabli
         end
       end
 
+      # <Warning>
+      # Legacy boarding is deprecated and will be sunset in Q2 2027. Intelligent boarding has no matching endpoint. Each
+      # application has its own hosted form link instead. See [Send merchants a boarding
+      # link](/guides/pay-ops-developer-boarding-legacy-migrate#send-merchants-a-boarding-link).
+      # </Warning>
+      #
+      #
       # Gets a boarding application by authentication information. This endpoint requires an `application` API token.
       #
       # @param request_options [Hash]
@@ -339,6 +375,13 @@ module Payabli
         end
       end
 
+      # <Warning>
+      # Legacy boarding is deprecated and will be sunset in Q2 2027. Intelligent boarding has no matching endpoint. Each
+      # application has its own hosted form link instead. See [Send merchants a boarding
+      # link](/guides/pay-ops-developer-boarding-legacy-migrate#send-merchants-a-boarding-link).
+      # </Warning>
+      #
+      #
       # Retrieves details for a boarding link, by ID.
       #
       # @param request_options [Hash]
@@ -378,6 +421,13 @@ module Payabli
         end
       end
 
+      # <Warning>
+      # Legacy boarding is deprecated and will be sunset in Q2 2027. Intelligent boarding has no matching endpoint. Each
+      # application has its own hosted form link instead. See [Send merchants a boarding
+      # link](/guides/pay-ops-developer-boarding-legacy-migrate#send-merchants-a-boarding-link).
+      # </Warning>
+      #
+      #
       # Get details for a boarding link using the boarding template ID. This endpoint requires an application API token.
       #
       # @param request_options [Hash]
@@ -417,6 +467,13 @@ module Payabli
         end
       end
 
+      # <Warning>
+      # Legacy boarding is deprecated and will be sunset in Q2 2027. Intelligent boarding has no matching endpoint. Each
+      # application has its own hosted form link instead. See [Send merchants a boarding
+      # link](/guides/pay-ops-developer-boarding-legacy-migrate#send-merchants-a-boarding-link).
+      # </Warning>
+      #
+      #
       # Retrieves a link and the verification code used to log into an existing boarding application. You can also use
       # this endpoint to send a link and referenceId for an existing boarding application to an email address. The
       # recipient can use the referenceId and email address to access and edit the application.
@@ -467,6 +524,13 @@ module Payabli
         end
       end
 
+      # <Warning>
+      # Legacy boarding is deprecated and will be sunset in Q2 2027. Intelligent boarding has no matching endpoint. Each
+      # application has its own hosted form link instead. See [Send merchants a boarding
+      # link](/guides/pay-ops-developer-boarding-legacy-migrate#send-merchants-a-boarding-link).
+      # </Warning>
+      #
+      #
       # Retrieves the details for a boarding link, by reference name. This endpoint requires an application API token.
       #
       # @param request_options [Hash]
@@ -506,6 +570,12 @@ module Payabli
         end
       end
 
+      # <Warning>
+      # Legacy boarding is deprecated and will be sunset in Q2 2027. Use [List
+      # applications](/developers/api-reference/applications/list-applications) instead.
+      # </Warning>
+      #
+      #
       # Returns a list of boarding applications for an organization. Use filters to limit results. Include the
       # `exportFormat` query parameter to return the results as a file instead of a JSON response.
       #
@@ -564,6 +634,13 @@ module Payabli
         end
       end
 
+      # <Warning>
+      # Legacy boarding is deprecated and will be sunset in Q2 2027. Intelligent boarding has no matching endpoint. Each
+      # application has its own hosted form link instead. See [Send merchants a boarding
+      # link](/guides/pay-ops-developer-boarding-legacy-migrate#send-merchants-a-boarding-link).
+      # </Warning>
+      #
+      #
       # Return a list of boarding links for an organization. Use filters to limit results.
       #
       # @param request_options [Hash]
@@ -619,6 +696,13 @@ module Payabli
         end
       end
 
+      # <Warning>
+      # Legacy boarding is deprecated and will be sunset in Q2 2027. Use [Create an
+      # application](/developers/api-reference/applications/create-an-application) for a paypoint that's already boarded
+      # instead. See [Request more services with the API](/guides/pay-ops-developer-boarding-add-services).
+      # </Warning>
+      #
+      #
       # Creates a new boarding application linked to an existing paypoint as part of the multi-product boarding flow.
       # Use this endpoint to add new services to a paypoint without creating a duplicate record. The system copies
       # eligible business, contact, banking, and address data from the paypoint to the new application based on 1:1
@@ -668,6 +752,12 @@ module Payabli
         end
       end
 
+      # <Warning>
+      # Legacy boarding is deprecated and will be sunset in Q2 2027. Use [List
+      # applications](/developers/api-reference/applications/list-applications) instead. It doesn't filter by paypoint.
+      # </Warning>
+      #
+      #
       # Returns all boarding applications associated with a specific paypoint, including those created through the
       # multi-product boarding flow. Use this endpoint to track underwriting progress across multiple service additions
       # or to build reporting views. See the [Multi-product boarding](/guides/pay-ops-developer-boarding-multi-product)

data/lib/payabli/boarding_templates/client.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+module Payabli
+  module BoardingTemplates
+    class Client
+      # @param client [Payabli::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Lists the boarding templates an organization owns, plus templates
+      # inherited from ancestor organizations. Scope the listing with the
+      # required `orgId` query parameter. You can filter by `status`, `name`,
+      # `slug`, `orgName`, and `inherited`, and page through results.
+      #
+      # @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] :org_id
+      # @option params [Payabli::Types::TemplateStatus, nil] :status
+      # @option params [String, nil] :name
+      # @option params [String, nil] :slug
+      # @option params [String, nil] :org_name
+      # @option params [Boolean, nil] :inherited
+      # @option params [Integer, nil] :from_record
+      # @option params [Integer, nil] :limit_record
+      #
+      # @example
+      #   client.boarding_templates.list_templates(org_id: 123)
+      #
+      # @return [Payabli::Types::ListTemplatesResponse]
+      def list_templates(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["orgId"] = params[:org_id] if params.key?(:org_id)
+        query_params["status"] = params[:status] if params.key?(:status)
+        query_params["name"] = params[:name] if params.key?(:name)
+        query_params["slug"] = params[:slug] if params.key?(:slug)
+        query_params["orgName"] = params[:org_name] if params.key?(:org_name)
+        query_params["inherited"] = params[:inherited] if params.key?(:inherited)
+        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" => [] }])
+        request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v2/templates",
+          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::ListTemplatesResponse.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 boarding template by UUID, including its current content version.
+      #
+      # @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] :uuid
+      #
+      # @example
+      #   client.boarding_templates.get_template(uuid: "019ff129-d393-7761-9a31-e5afe85b4081")
+      #
+      # @return [Payabli::Types::Template]
+      def get_template(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/templates/#{URI.encode_uri_component(params[:uuid].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::Template.load(response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Archives a boarding template by UUID. Archiving is a soft delete: the
+      # template stays readable with `status: archived`, so archiving an
+      # already-archived template returns `409`, not another success. Unknown
+      # templates return `404`.
+      #
+      # @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] :uuid
+      #
+      # @example
+      #   client.boarding_templates.archive_template(uuid: "019ff129-d393-7761-9a31-e5afe85b4081")
+      #
+      # @return [untyped]
+      def archive_template(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/templates/#{URI.encode_uri_component(params[:uuid].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
+        return if code.between?(200, 299)
+
+        error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+        raise error_class.new(response.body, code: code)
+      end
+
+      # Retrieves a specific immutable content version of a template.
+      #
+      # @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] :uuid
+      # @option params [String] :version_uuid
+      #
+      # @example
+      #   client.boarding_templates.get_template_version(
+      #     uuid: "019ff129-d393-7761-9a31-e5afe85b4081",
+      #     version_uuid: "019ff129-d396-74c4-86da-ae3d082d7ef9"
+      #   )
+      #
+      # @return [Payabli::Types::TemplateVersion]
+      def get_template_version(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/templates/#{URI.encode_uri_component(params[:uuid].to_s)}/versions/#{URI.encode_uri_component(params[:version_uuid].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::TemplateVersion.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/boarding_templates/types/list_templates_boarding_templates_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Payabli
+  module BoardingTemplates
+    module Types
+      class ListTemplatesBoardingTemplatesRequest < Internal::Types::Model
+        field :org_id, -> { Integer }, optional: false, nullable: false, api_name: "orgId"
+
+        field :status, -> { Payabli::Types::TemplateStatus }, optional: true, nullable: false
+
+        field :name, -> { String }, optional: true, nullable: false
+
+        field :slug, -> { String }, optional: true, nullable: false
+
+        field :org_name, -> { String }, optional: true, nullable: false, api_name: "orgName"
+
+        field :inherited, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+        field :from_record, -> { Integer }, optional: true, nullable: false, api_name: "fromRecord"
+
+        field :limit_record, -> { Integer }, optional: true, nullable: false, api_name: "limitRecord"
+      end
+    end
+  end
+end