payabli 3.0.19 → 3.0.21

data/lib/payabli/types/person_summary_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A person as it appears in a list response.
+    class PersonSummaryResponse < Internal::Types::Model
+      field :links, -> { Payabli::Types::PersonLinks }, optional: false, nullable: false, api_name: "_links"
+
+      field :person_reference, -> { String }, optional: false, nullable: false, api_name: "personReference"
+
+      field :first_name, -> { String }, optional: false, nullable: true, api_name: "firstName"
+
+      field :last_name, -> { String }, optional: false, nullable: true, api_name: "lastName"
+
+      field :email, -> { String }, optional: true, nullable: false
+
+      field :verification_status, -> { String }, optional: false, nullable: false, api_name: "verificationStatus"
+
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+
+      field :last_updated, -> { String }, optional: false, nullable: false, api_name: "lastUpdated"
+    end
+  end
+end

data/lib/payabli/types/person_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module PersonType
+      extend Payabli::Internal::Types::Enum
+
+      OWNER = "Owner"
+      DIRECTOR = "Director"
+      CONTACT = "Contact"
+      SIGNER = "Signer"
+      AUTHORIZED_USER = "AuthorizedUser"
+      EMPLOYEE = "Employee"
+    end
+  end
+end

data/lib/payabli/types/person_updated_envelope.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping an updated person.
+    class PersonUpdatedEnvelope < 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::PersonUpdatedResponse }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/person_updated_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The reference and updated timestamp after a person update.
+    class PersonUpdatedResponse < Internal::Types::Model
+      field :person_reference, -> { String }, optional: false, nullable: false, api_name: "personReference"
+
+      field :last_updated, -> { String }, optional: false, nullable: false, api_name: "lastUpdated"
+
+      field :links, -> { Payabli::Types::PersonLinks }, optional: false, nullable: false, api_name: "_links"
+    end
+  end
+end

data/lib/payabli/types/processing_metrics.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Expected Pay In processing profile for the business.
+    class ProcessingMetrics < Internal::Types::Model
+      field :monthly_receivables_volume, -> { Integer }, optional: true, nullable: false, api_name: "monthlyReceivablesVolume"
+
+      field :average_receivable_size, -> { Integer }, optional: true, nullable: false, api_name: "averageReceivableSize"
+
+      field :largest_receivable_size, -> { Integer }, optional: true, nullable: false, api_name: "largestReceivableSize"
+
+      field :inbound_present_percent, -> { Integer }, optional: true, nullable: false, api_name: "inboundPresentPercent"
+
+      field :inbound_online_percent, -> { Integer }, optional: true, nullable: false, api_name: "inboundOnlinePercent"
+
+      field :inbound_moto_percent, -> { Integer }, optional: true, nullable: false, api_name: "inboundMotoPercent"
+
+      field :refund_policy, -> { String }, optional: true, nullable: false, api_name: "refundPolicy"
+
+      field :advanced_delivery, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "advancedDelivery"
+
+      field :percent_advanced_delivery, -> { Integer }, optional: true, nullable: false, api_name: "percentAdvancedDelivery"
+
+      field :advanced_delivery_days, -> { Integer }, optional: true, nullable: false, api_name: "advancedDeliveryDays"
+
+      field :number_of_transactions, -> { Integer }, optional: true, nullable: false, api_name: "numberOfTransactions"
+    end
+  end
+end

data/lib/payabli/types/representative_input.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A sales or service representative assigned to the application.
+    class RepresentativeInput < Internal::Types::Model
+      field :user_id, -> { String }, optional: true, nullable: false, api_name: "userId"
+
+      field :rep_code, -> { Integer }, optional: true, nullable: false, api_name: "repCode"
+
+      field :first_name, -> { String }, optional: true, nullable: false, api_name: "firstName"
+
+      field :last_name, -> { String }, optional: true, nullable: false, api_name: "lastName"
+
+      field :location, -> { String }, optional: true, nullable: false
+
+      field :team, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/payabli/types/representative_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A sales or service representative assigned to the application.
+    class RepresentativeResponse < Internal::Types::Model
+      field :user_id, -> { String }, optional: true, nullable: false, api_name: "userId"
+
+      field :rep_code, -> { Integer }, optional: true, nullable: false, api_name: "repCode"
+
+      field :first_name, -> { String }, optional: true, nullable: false, api_name: "firstName"
+
+      field :last_name, -> { String }, optional: true, nullable: false, api_name: "lastName"
+
+      field :location, -> { String }, optional: true, nullable: false
+
+      field :team, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/payabli/types/requested_services.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The services the application requests, grouped by direction. Values are
+    # case-insensitive on input and returned in the casing shown.
+    class RequestedServices < Internal::Types::Model
+      field :money_in, -> { Internal::Types::Array[Payabli::Types::MoneyInService] }, optional: true, nullable: false, api_name: "moneyIn"
+
+      field :money_out, -> { Internal::Types::Array[Payabli::Types::MoneyOutService] }, optional: true, nullable: false, api_name: "moneyOut"
+    end
+  end
+end

data/lib/payabli/types/signature_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module SignatureType
+      extend Payabli::Internal::Types::Enum
+
+      TYPE = "type"
+      DRAW = "draw"
+      CHECKBOX = "checkbox"
+    end
+  end
+end

data/lib/payabli/types/status_history_entry.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A single transition in an application's status history.
+    class StatusHistoryEntry < Internal::Types::Model
+      field :from_status, -> { String }, optional: false, nullable: false, api_name: "fromStatus"
+
+      field :to_status, -> { String }, optional: false, nullable: false, api_name: "toStatus"
+
+      field :trigger, -> { String }, optional: false, nullable: false
+
+      field :actor, -> { String }, optional: false, nullable: true
+
+      field :reason, -> { String }, optional: false, nullable: true
+
+      field :metadata, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: true
+
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+    end
+  end
+end

data/lib/payabli/types/status_history_envelope.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping an application's status history.
+    class StatusHistoryEnvelope < 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::StatusHistoryResult }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/status_history_result.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # An application's status history.
+    class StatusHistoryResult < Internal::Types::Model
+      field :requests_reference, -> { String }, optional: false, nullable: false, api_name: "requestsReference"
+
+      field :history, -> { Internal::Types::Array[Payabli::Types::StatusHistoryEntry] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/payabli/types/submit_application_error.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The error body when an application can't be submitted.
+    class SubmitApplicationError < Internal::Types::Model
+      field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :error, -> { String }, optional: false, nullable: false
+
+      field :message, -> { String }, optional: false, nullable: false
+
+      field :trace_id, -> { String }, optional: false, nullable: true, api_name: "traceId"
+    end
+  end
+end

data/lib/payabli/types/submit_signer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The signature details for the application. The signer is the person flagged
+    # with `isSigner` on the business, and Payabli records the signer's identity
+    # from their person record and business link. Keep the signer's details
+    # current with the people endpoints before you submit, because you can't
+    # correct them here. Provide a signature with `signature` and
+    # `signatureType`, or, if the signer signed in your own e-sign tool, send
+    # `signedDocumentReference` instead. Signer identity fields such as `name`,
+    # `email`, `ssn`, and `address` aren't part of this object, and Payabli
+    # ignores them if you send them.
+    class SubmitSigner < Internal::Types::Model
+      field :person_reference, -> { String }, optional: true, nullable: false, api_name: "personReference"
+
+      field :signature, -> { String }, optional: true, nullable: false
+
+      field :signature_type, -> { Payabli::Types::SignatureType }, optional: true, nullable: false, api_name: "signatureType"
+
+      field :signed_document_reference, -> { String }, optional: true, nullable: false, api_name: "signedDocumentReference"
+
+      field :acceptance, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :pci_attestation, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "pciAttestation"
+
+      field :reported_signer_ip, -> { String }, optional: true, nullable: false, api_name: "reportedSignerIp"
+
+      field :additional_data, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false, api_name: "additionalData"
+    end
+  end
+end

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.21"
 end