payabli 3.0.19 → 3.0.20

data/lib/payabli/types/template.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A boarding template, including its current content version.
+    class Template < Internal::Types::Model
+      field :uuid, -> { String }, optional: false, nullable: false
+
+      field :org_id, -> { Integer }, optional: false, nullable: false, api_name: "orgId"
+
+      field :org_name, -> { String }, optional: false, nullable: true, api_name: "orgName"
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: false, nullable: true
+
+      field :slug, -> { String }, optional: false, nullable: true
+
+      field :status, -> { Payabli::Types::TemplateStatus }, optional: false, nullable: false
+
+      field :current_version_uuid, -> { String }, optional: false, nullable: false, api_name: "currentVersionUuid"
+
+      field :current_version, -> { Payabli::Types::TemplateVersion }, optional: false, nullable: false, api_name: "currentVersion"
+
+      field :is_inherited, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "isInherited"
+
+      field :read_only, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "readOnly"
+
+      field :created_by, -> { String }, optional: false, nullable: false, api_name: "createdBy"
+
+      field :updated_by, -> { String }, optional: false, nullable: false, api_name: "updatedBy"
+
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+
+      field :updated_at, -> { String }, optional: false, nullable: false, api_name: "updatedAt"
+    end
+  end
+end

data/lib/payabli/types/template_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module TemplateStatus
+      extend Payabli::Internal::Types::Enum
+
+      ACTIVE = "active"
+      ARCHIVED = "archived"
+    end
+  end
+end

data/lib/payabli/types/template_version.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # An immutable snapshot of a template's content. Each save in the Payabli
+    # Portal appends a new version; the template's `currentVersionUuid` points at
+    # the active one. The configuration objects (services, documents, devices, and
+    # so on) are authored in the Portal.
+    class TemplateVersion < Internal::Types::Model
+      field :uuid, -> { String }, optional: false, nullable: false
+
+      field :version, -> { Integer }, optional: false, nullable: false
+
+      field :services, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: true
+
+      field :field_configurations, -> { Internal::Types::Array[Object] }, optional: false, nullable: true, api_name: "fieldConfigurations"
+
+      field :conditional_rules, -> { Internal::Types::Array[Object] }, optional: false, nullable: true, api_name: "conditionalRules"
+
+      field :documents, -> { Internal::Types::Array[Object] }, optional: false, nullable: true
+
+      field :devices, -> { Internal::Types::Array[Object] }, optional: false, nullable: true
+
+      field :hidden_sections, -> { Internal::Types::Array[Object] }, optional: false, nullable: true, api_name: "hiddenSections"
+
+      field :allowed_mccs, -> { Internal::Types::Array[Integer] }, optional: false, nullable: true, api_name: "allowedMccs"
+
+      field :underwriting, -> { Payabli::Types::UnderwritingMode }, optional: false, nullable: false
+
+      field :mpa_content, -> { String }, optional: false, nullable: true, api_name: "mpaContent"
+
+      field :payin_pricing_id, -> { Integer }, optional: false, nullable: true, api_name: "payinPricingId"
+
+      field :payout_pricing_id, -> { Integer }, optional: false, nullable: true, api_name: "payoutPricingId"
+
+      field :allow_guided_tour, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "allowGuidedTour"
+
+      field :allow_business_prefill, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "allowBusinessPrefill"
+
+      field :allow_save_for_later, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "allowSaveForLater"
+
+      field :allow_multiple_banks, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "allowMultipleBanks"
+
+      field :allow_service_selection, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "allowServiceSelection"
+
+      field :allow_device_selection, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "allowDeviceSelection"
+
+      field :allow_amigo_chat, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "allowAmigoChat"
+
+      field :allow_user_creation, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "allowUserCreation"
+
+      field :allow_people_prefill, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "allowPeoplePrefill"
+
+      field :vertical_progress, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "verticalProgress"
+
+      field :use_floating_inputs, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "useFloatingInputs"
+
+      field :center_content, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "centerContent"
+
+      field :allow_real_time_bank_verification, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "allowRealTimeBankVerification"
+
+      field :allow_checkbox_signing, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "allowCheckboxSigning"
+
+      field :allow_typed_signature, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "allowTypedSignature"
+
+      field :allow_written_signature, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "allowWrittenSignature"
+
+      field :allow_multi_owner_esign, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "allowMultiOwnerEsign"
+
+      field :allow_confirmation_and_attestation, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "allowConfirmationAndAttestation"
+
+      field :allow_pci_attestation, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "allowPCIAttestation"
+
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+
+      field :created_by, -> { String }, optional: false, nullable: false, api_name: "createdBy"
+    end
+  end
+end

data/lib/payabli/types/templates_summary.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Pagination metadata for a template list response.
+    class TemplatesSummary < Internal::Types::Model
+      field :total_pages, -> { Integer }, optional: false, nullable: false, api_name: "totalPages"
+
+      field :total_records, -> { Integer }, optional: false, nullable: false, api_name: "totalRecords"
+
+      field :page_size, -> { Integer }, optional: false, nullable: false, api_name: "pageSize"
+    end
+  end
+end

data/lib/payabli/types/transition_result.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The result of a lifecycle action, with the application's new status.
+    class TransitionResult < Internal::Types::Model
+      field :requests_reference, -> { String }, optional: false, nullable: false, api_name: "requestsReference"
+
+      field :application_status, -> { String }, optional: false, nullable: false, api_name: "applicationStatus"
+
+      field :allowed_actions, -> { Internal::Types::Array[String] }, optional: false, nullable: false, api_name: "allowedActions"
+    end
+  end
+end

data/lib/payabli/types/transition_result_envelope.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping a lifecycle-action result.
+    class TransitionResultEnvelope < Internal::Types::Model
+      field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :message, -> { String }, optional: false, nullable: true
+
+      field :trace_id, -> { String }, optional: false, nullable: true, api_name: "traceId"
+
+      field :data, -> { Payabli::Types::TransitionResult }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/underwriting_mode.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module UnderwritingMode
+      extend Payabli::Internal::Types::Enum
+
+      AUTOMATIC = "automatic"
+      MANUAL = "manual"
+      BYPASS = "bypass"
+    end
+  end
+end

data/lib/payabli/types/validation_missing_field.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A field that's missing or invalid for the requested services.
+    class ValidationMissingField < Internal::Types::Model
+      field :field, -> { String }, optional: false, nullable: false
+
+      field :label, -> { String }, optional: false, nullable: false
+
+      field :reason, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/payabli/types/validation_result.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Whether the application's stored records meet the requirements for the services it requests.
+    class ValidationResult < Internal::Types::Model
+      field :valid, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :services_evaluated, -> { Internal::Types::Array[String] }, optional: false, nullable: false, api_name: "servicesEvaluated"
+
+      field :sections, -> { Payabli::Types::ValidationSections }, optional: false, nullable: false
+    end
+  end
+end

data/lib/payabli/types/validation_result_envelope.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping a validation result.
+    class ValidationResultEnvelope < Internal::Types::Model
+      field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :message, -> { String }, optional: false, nullable: true
+
+      field :trace_id, -> { String }, optional: false, nullable: true, api_name: "traceId"
+
+      field :data, -> { Payabli::Types::ValidationResult }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/validation_section.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The validation result for one section of the application.
+    class ValidationSection < Internal::Types::Model
+      field :complete, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :missing_fields, -> { Internal::Types::Array[Payabli::Types::ValidationMissingField] }, optional: false, nullable: false, api_name: "missingFields"
+    end
+  end
+end

data/lib/payabli/types/validation_sections.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The validation result for each section of the application.
+    class ValidationSections < Internal::Types::Model
+      field :business, -> { Payabli::Types::ValidationSection }, optional: false, nullable: false
+
+      field :sales_and_payments, -> { Payabli::Types::ValidationSection }, optional: false, nullable: false, api_name: "salesAndPayments"
+
+      field :banking, -> { Payabli::Types::ValidationSection }, optional: false, nullable: false
+
+      field :people, -> { Payabli::Types::ValidationSection }, optional: false, nullable: false
+    end
+  end
+end

data/lib/payabli/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Payabli
-  VERSION = "3.0.19"
+  VERSION = "3.0.20"
 end

data/lib/payabli.rb

@@ -35,6 +35,23 @@ require_relative "payabli/internal/iterators/cursor_item_iterator"
 require_relative "payabli/internal/iterators/offset_item_iterator"
 require_relative "payabli/internal/iterators/cursor_page_iterator"
 require_relative "payabli/internal/iterators/offset_page_iterator"
+require_relative "payabli/businesses/types/update_business_request_legal_structure"
+require_relative "payabli/businesses/types/update_business_request_operating_seasons_item"
+require_relative "payabli/types/address_type"
+require_relative "payabli/types/business_address_location"
+require_relative "payabli/types/business_address"
+require_relative "payabli/types/business_address_create"
+require_relative "payabli/types/business_payment_method"
+require_relative "payabli/types/processing_metrics"
+require_relative "payabli/types/payout_metrics"
+require_relative "payabli/types/create_business_request_legal_structure"
+require_relative "payabli/types/create_business_request_operating_seasons_item"
+require_relative "payabli/types/create_business_request"
+require_relative "payabli/types/paypoint_writable_fields"
+require_relative "payabli/types/create_paypoint_with_business_reference"
+require_relative "payabli/types/create_paypoint_with_inline_business"
+require_relative "payabli/types/create_paypoint_all_fields"
+require_relative "payabli/paypoints/types/create_paypoint_paypoints_request"
 require_relative "payabli/billing/types/get_profile_billing_request_service_group"
 require_relative "payabli/billing/types/get_profile_billing_request_entity_type"
 require_relative "payabli/types/idempotency_key"
@@ -687,6 +704,118 @@ require_relative "payabli/types/line_item_query_record"
 require_relative "payabli/types/delete_item_response"
 require_relative "payabli/types/query_response_items_records_item"
 require_relative "payabli/types/query_response_items"
+require_relative "payabli/types/business_links"
+require_relative "payabli/types/business_summary_response"
+require_relative "payabli/types/pagination"
+require_relative "payabli/types/list_businesses_response"
+require_relative "payabli/types/boarding_warning"
+require_relative "payabli/types/list_businesses_envelope"
+require_relative "payabli/types/business_created_response"
+require_relative "payabli/types/business_created_envelope"
+require_relative "payabli/types/certification_detail"
+require_relative "payabli/types/business_detail_response_legal_structure"
+require_relative "payabli/types/business_detail_response_operating_seasons_item"
+require_relative "payabli/types/business_detail_response"
+require_relative "payabli/types/business_detail_envelope"
+require_relative "payabli/types/business_deactivated_response"
+require_relative "payabli/types/business_deactivated_envelope"
+require_relative "payabli/types/business_updated_response"
+require_relative "payabli/types/business_updated_envelope"
+require_relative "payabli/types/business_address_links"
+require_relative "payabli/types/business_address_response"
+require_relative "payabli/types/business_address_list_envelope"
+require_relative "payabli/types/business_address_envelope"
+require_relative "payabli/types/business_address_deleted_response"
+require_relative "payabli/types/business_address_deleted_envelope"
+require_relative "payabli/types/business_person_links"
+require_relative "payabli/types/business_person_link"
+require_relative "payabli/types/business_person_list_envelope"
+require_relative "payabli/types/person_type"
+require_relative "payabli/types/person_address_type"
+require_relative "payabli/types/person_address_request"
+require_relative "payabli/types/business_person_envelope"
+require_relative "payabli/types/person_links"
+require_relative "payabli/types/person_summary_response"
+require_relative "payabli/types/list_people_response"
+require_relative "payabli/types/list_people_envelope"
+require_relative "payabli/types/identification_document_request"
+require_relative "payabli/types/business_relationship_request"
+require_relative "payabli/types/person_address_response"
+require_relative "payabli/types/identification_document_response"
+require_relative "payabli/types/business_relationship_response"
+require_relative "payabli/types/person_detail_response"
+require_relative "payabli/types/person_detail_envelope"
+require_relative "payabli/types/person_updated_response"
+require_relative "payabli/types/person_updated_envelope"
+require_relative "payabli/types/people_search_request"
+require_relative "payabli/types/people_search_result_response"
+require_relative "payabli/types/people_search_results_response"
+require_relative "payabli/types/people_search_envelope"
+require_relative "payabli/types/paypoint_links"
+require_relative "payabli/types/paypoint_summary_response"
+require_relative "payabli/types/list_paypoints_response"
+require_relative "payabli/types/list_paypoints_envelope"
+require_relative "payabli/types/paypoint_created_response"
+require_relative "payabli/types/paypoint_created_envelope"
+require_relative "payabli/types/paypoint_detail_response"
+require_relative "payabli/types/paypoint_detail_envelope"
+require_relative "payabli/types/paypoint_updated_response"
+require_relative "payabli/types/paypoint_updated_envelope"
+require_relative "payabli/types/payment_method_owner_type"
+require_relative "payabli/types/payment_method_usage"
+require_relative "payabli/types/payment_method_links"
+require_relative "payabli/types/payment_method_detail"
+require_relative "payabli/types/list_payment_methods_response"
+require_relative "payabli/types/list_payment_methods_envelope"
+require_relative "payabli/types/create_payment_method_request_type"
+require_relative "payabli/types/create_payment_method_request"
+require_relative "payabli/types/payment_method_result"
+require_relative "payabli/types/payment_methods_created_envelope"
+require_relative "payabli/types/payment_method_detail_envelope"
+require_relative "payabli/types/payment_method_deactivated_envelope"
+require_relative "payabli/types/payment_method_updated_envelope"
+require_relative "payabli/types/template_status"
+require_relative "payabli/types/templates_summary"
+require_relative "payabli/types/underwriting_mode"
+require_relative "payabli/types/template_version"
+require_relative "payabli/types/template"
+require_relative "payabli/types/list_templates_response"
+require_relative "payabli/types/money_in_service"
+require_relative "payabli/types/money_out_service"
+require_relative "payabli/types/requested_services"
+require_relative "payabli/types/representative_response"
+require_relative "payabli/types/application_links"
+require_relative "payabli/types/application_common"
+require_relative "payabli/types/application_list_item"
+require_relative "payabli/types/list_applications_response"
+require_relative "payabli/types/list_applications_envelope"
+require_relative "payabli/types/representative_input"
+require_relative "payabli/types/application"
+require_relative "payabli/types/application_envelope"
+require_relative "payabli/types/validation_missing_field"
+require_relative "payabli/types/validation_section"
+require_relative "payabli/types/validation_sections"
+require_relative "payabli/types/validation_result"
+require_relative "payabli/types/validation_result_envelope"
+require_relative "payabli/types/signature_type"
+require_relative "payabli/types/submit_signer"
+require_relative "payabli/types/transition_result"
+require_relative "payabli/types/transition_result_envelope"
+require_relative "payabli/types/submit_application_error"
+require_relative "payabli/types/status_history_entry"
+require_relative "payabli/types/status_history_result"
+require_relative "payabli/types/status_history_envelope"
+require_relative "payabli/types/enablement_service"
+require_relative "payabli/types/enablement_result"
+require_relative "payabli/types/enablement_envelope"
+require_relative "payabli/types/document_subject_type"
+require_relative "payabli/types/document_requirement_source"
+require_relative "payabli/types/document_requirement"
+require_relative "payabli/types/document_requirement_list_envelope"
+require_relative "payabli/types/application_document_error"
+require_relative "payabli/types/application_document"
+require_relative "payabli/types/application_document_list_envelope"
+require_relative "payabli/types/application_document_envelope"
 require_relative "payabli/types/application_data_pay_in_services_ach"
 require_relative "payabli/types/application_data_pay_in_services_card"
 require_relative "payabli/types/application_data_pay_in_services"
@@ -953,8 +1082,8 @@ require_relative "payabli/types/charge_back_response"
 require_relative "payabli/types/chargeback_message"
 require_relative "payabli/types/chargeback_query_records"
 require_relative "payabli/types/case_management_bank_account_function"
-require_relative "payabli/types/money_in_service"
-require_relative "payabli/types/money_out_service"
+require_relative "payabli/types/case_management_money_in_service"
+require_relative "payabli/types/case_management_money_out_service"
 require_relative "payabli/types/bank_account_services"
 require_relative "payabli/types/pre_creation_validation_result"
 require_relative "payabli/types/case_state"
@@ -1118,6 +1247,36 @@ require_relative "payabli/cloud/types/list_device_request"
 require_relative "payabli/line_item/client"
 require_relative "payabli/line_item/types/add_item_request"
 require_relative "payabli/line_item/types/list_line_items_request"
+require_relative "payabli/businesses/client"
+require_relative "payabli/businesses/types/list_businesses_businesses_request"
+require_relative "payabli/businesses/types/deactivate_business_request"
+require_relative "payabli/businesses/types/update_business_request"
+require_relative "payabli/businesses/types/create_business_address_request"
+require_relative "payabli/businesses/types/update_business_address_request"
+require_relative "payabli/businesses/types/link_business_person_request"
+require_relative "payabli/businesses/types/update_business_person_request"
+require_relative "payabli/people/client"
+require_relative "payabli/people/types/list_people_people_request"
+require_relative "payabli/people/types/create_person_request"
+require_relative "payabli/people/types/update_person_request"
+require_relative "payabli/people/types/search_people_request"
+require_relative "payabli/people/types/search_people_unmasked_request"
+require_relative "payabli/paypoints/client"
+require_relative "payabli/paypoints/types/list_paypoints_paypoints_request"
+require_relative "payabli/paypoints/types/update_paypoint_request"
+require_relative "payabli/payment_methods/client"
+require_relative "payabli/payment_methods/types/list_payment_methods_payment_methods_request"
+require_relative "payabli/payment_methods/types/create_payment_methods_request"
+require_relative "payabli/payment_methods/types/update_payment_method_request"
+require_relative "payabli/boarding_templates/client"
+require_relative "payabli/boarding_templates/types/list_templates_boarding_templates_request"
+require_relative "payabli/applications/client"
+require_relative "payabli/applications/types/list_applications_applications_request"
+require_relative "payabli/applications/types/create_application_request"
+require_relative "payabli/applications/types/update_application_request"
+require_relative "payabli/applications/types/submit_application_request"
+require_relative "payabli/applications/types/withdraw_application_request"
+require_relative "payabli/applications/types/upload_application_document_request"
 require_relative "payabli/boarding/client"
 require_relative "payabli/boarding/types/request_app_by_auth"
 require_relative "payabli/boarding/types/get_external_application_request"