payabli 3.0.19 → 3.0.20

data/lib/payabli/types/document_requirement_source.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module DocumentRequirementSource
+      extend Payabli::Internal::Types::Enum
+
+      TEMPLATE = "template"
+      BUSINESS_RULE = "businessRule"
+    end
+  end
+end

data/lib/payabli/types/document_subject_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module DocumentSubjectType
+      extend Payabli::Internal::Types::Enum
+
+      BUSINESS = "business"
+      PAYPOINT = "paypoint"
+      PERSON = "person"
+    end
+  end
+end

data/lib/payabli/types/enablement_envelope.rb

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

data/lib/payabli/types/enablement_result.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The progress of setting up an approved application's services with their processors.
+    class EnablementResult < Internal::Types::Model
+      field :requests_reference, -> { String }, optional: false, nullable: false, api_name: "requestsReference"
+
+      field :state, -> { String }, optional: false, nullable: true
+
+      field :services, -> { Internal::Types::Array[Payabli::Types::EnablementService] }, optional: false, nullable: false
+
+      field :blocked_on, -> { String }, optional: false, nullable: true, api_name: "blockedOn"
+
+      field :message, -> { String }, optional: false, nullable: true
+
+      field :attempts, -> { Integer }, optional: false, nullable: true
+
+      field :first_attempt_at, -> { String }, optional: false, nullable: true, api_name: "firstAttemptAt"
+
+      field :last_attempt_at, -> { String }, optional: false, nullable: true, api_name: "lastAttemptAt"
+    end
+  end
+end

data/lib/payabli/types/enablement_service.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The enablement progress of one service the application requested.
+    class EnablementService < Internal::Types::Model
+      field :service, -> { String }, optional: false, nullable: false
+
+      field :rail, -> { String }, optional: false, nullable: false
+
+      field :state, -> { String }, optional: false, nullable: false
+
+      field :message, -> { String }, optional: false, nullable: true
+
+      field :missing_fields, -> { Internal::Types::Array[String] }, optional: false, nullable: true, api_name: "missingFields"
+    end
+  end
+end

data/lib/payabli/types/identification_document_request.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A government-issued identification document included in a person request.
+    class IdentificationDocumentRequest < Internal::Types::Model
+      field :type, -> { String }, optional: true, nullable: false
+
+      field :number, -> { String }, optional: true, nullable: false
+
+      field :issuing_state, -> { String }, optional: true, nullable: false, api_name: "issuingState"
+
+      field :issuing_country, -> { String }, optional: true, nullable: false, api_name: "issuingCountry"
+
+      field :expiration_date, -> { String }, optional: true, nullable: false, api_name: "expirationDate"
+    end
+  end
+end

data/lib/payabli/types/identification_document_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A government-issued identification document in a person response.
+    class IdentificationDocumentResponse < Internal::Types::Model
+      field :type, -> { String }, optional: true, nullable: false
+
+      field :number, -> { String }, optional: true, nullable: false
+
+      field :issuing_state, -> { String }, optional: true, nullable: false, api_name: "issuingState"
+
+      field :issuing_country, -> { String }, optional: true, nullable: false, api_name: "issuingCountry"
+
+      field :expiration_date, -> { String }, optional: true, nullable: false, api_name: "expirationDate"
+    end
+  end
+end

data/lib/payabli/types/list_applications_envelope.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping a page of applications.
+    class ListApplicationsEnvelope < 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::ListApplicationsResponse }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/list_applications_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A page of applications.
+    class ListApplicationsResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[Payabli::Types::ApplicationListItem] }, optional: false, nullable: true
+
+      field :total, -> { Integer }, optional: false, nullable: false
+
+      field :page, -> { Integer }, optional: false, nullable: false
+
+      field :page_size, -> { Integer }, optional: false, nullable: false, api_name: "pageSize"
+    end
+  end
+end

data/lib/payabli/types/list_businesses_envelope.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping a page of businesses.
+    class ListBusinessesEnvelope < 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::ListBusinessesResponse }, optional: false, nullable: true
+
+      field :warnings, -> { Internal::Types::Array[Payabli::Types::BoardingWarning] }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/list_businesses_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A page of businesses.
+    class ListBusinessesResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[Payabli::Types::BusinessSummaryResponse] }, optional: false, nullable: true
+
+      field :pagination, -> { Payabli::Types::Pagination }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/list_payment_methods_envelope.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping a page of payment methods.
+    class ListPaymentMethodsEnvelope < 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::ListPaymentMethodsResponse }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/list_payment_methods_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A page of payment methods.
+    class ListPaymentMethodsResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[Payabli::Types::PaymentMethodDetail] }, optional: false, nullable: true
+
+      field :pagination, -> { Payabli::Types::Pagination }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/list_paypoints_envelope.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping a page of paypoints.
+    class ListPaypointsEnvelope < 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::ListPaypointsResponse }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/list_paypoints_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A page of paypoints.
+    class ListPaypointsResponse < Internal::Types::Model
+      field :items, -> { Internal::Types::Array[Payabli::Types::PaypointSummaryResponse] }, optional: false, nullable: true
+
+      field :total, -> { Integer }, optional: false, nullable: false
+
+      field :page, -> { Integer }, optional: false, nullable: false
+
+      field :page_size, -> { Integer }, optional: false, nullable: false, api_name: "pageSize"
+    end
+  end
+end

data/lib/payabli/types/list_people_envelope.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping a page of people.
+    class ListPeopleEnvelope < 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::ListPeopleResponse }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/list_people_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A page of people.
+    class ListPeopleResponse < Internal::Types::Model
+      field :data, -> { Internal::Types::Array[Payabli::Types::PersonSummaryResponse] }, optional: false, nullable: true
+
+      field :pagination, -> { Payabli::Types::Pagination }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/list_templates_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A page of boarding templates.
+    class ListTemplatesResponse < Internal::Types::Model
+      field :summary, -> { Payabli::Types::TemplatesSummary }, optional: false, nullable: false, api_name: "Summary"
+
+      field :records, -> { Internal::Types::Array[Payabli::Types::Template] }, optional: false, nullable: false, api_name: "Records"
+    end
+  end
+end

data/lib/payabli/types/pagination.rb

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

data/lib/payabli/types/payment_method_deactivated_envelope.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping a deactivated payment method.
+    class PaymentMethodDeactivatedEnvelope < 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::PaymentMethodResult }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/payment_method_detail.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A payment method as returned by read and list. Sensitive fields are masked.
+    class PaymentMethodDetail < Internal::Types::Model
+      field :is_default, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isDefault"
+
+      field :payment_method_reference, -> { String }, optional: false, nullable: false, api_name: "paymentMethodReference"
+
+      field :type, -> { String }, optional: false, nullable: false
+
+      field :account_owner, -> { String }, optional: false, nullable: false, api_name: "accountOwner"
+
+      field :owner_type, -> { Payabli::Types::PaymentMethodOwnerType }, optional: false, nullable: false, api_name: "ownerType"
+
+      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 :status, -> { String }, optional: false, nullable: false
+
+      field :usage, -> { Internal::Types::Array[Payabli::Types::PaymentMethodUsage] }, optional: true, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+
+      field :last_updated, -> { String }, optional: false, nullable: false, api_name: "lastUpdated"
+
+      field :links, -> { Payabli::Types::PaymentMethodLinks }, optional: false, nullable: false, api_name: "_links"
+    end
+  end
+end

data/lib/payabli/types/payment_method_detail_envelope.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping a payment method detail.
+    class PaymentMethodDetailEnvelope < 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::PaymentMethodDetail }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/payment_method_links.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Hypermedia links for a payment method resource.
+    class PaymentMethodLinks < Internal::Types::Model
+      field :self_, -> { String }, optional: true, nullable: false, api_name: "self"
+
+      field :owner, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/payabli/types/payment_method_owner_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module PaymentMethodOwnerType
+      extend Payabli::Internal::Types::Enum
+
+      PERSON = "person"
+      BUSINESS = "business"
+    end
+  end
+end

data/lib/payabli/types/payment_method_result.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A payment method as returned by create, update, and deactivate. Sensitive fields are masked.
+    class PaymentMethodResult < Internal::Types::Model
+      field :payment_method_reference, -> { String }, optional: false, nullable: false, api_name: "paymentMethodReference"
+
+      field :type, -> { String }, optional: false, nullable: false
+
+      field :fingerprint, -> { String }, optional: true, nullable: false
+
+      field :token_reference, -> { String }, optional: true, nullable: false, api_name: "tokenReference"
+
+      field :account_owner, -> { String }, optional: false, nullable: false, api_name: "accountOwner"
+
+      field :owner_type, -> { Payabli::Types::PaymentMethodOwnerType }, optional: false, nullable: false, api_name: "ownerType"
+
+      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 :status, -> { String }, optional: false, nullable: false
+
+      field :usage, -> { Internal::Types::Array[Payabli::Types::PaymentMethodUsage] }, optional: true, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+
+      field :last_updated, -> { String }, optional: false, nullable: false, api_name: "lastUpdated"
+
+      field :links, -> { Payabli::Types::PaymentMethodLinks }, optional: false, nullable: false, api_name: "_links"
+    end
+  end
+end

data/lib/payabli/types/payment_method_updated_envelope.rb

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

data/lib/payabli/types/payment_method_usage.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module PaymentMethodUsage
+      extend Payabli::Internal::Types::Enum
+
+      DEPOSITS = "deposits"
+      BILLING = "billing"
+      WITHDRAWALS = "withdrawals"
+      PAY_OUT_FUNDING = "payOutFunding"
+      REFUNDS = "refunds"
+      RETURNS = "returns"
+    end
+  end
+end

data/lib/payabli/types/payment_methods_created_envelope.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping the created payment methods.
+    class PaymentMethodsCreatedEnvelope < 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, -> { Internal::Types::Array[Payabli::Types::PaymentMethodResult] }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/payout_metrics.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Expected Pay Out profile for the business.
+    class PayoutMetrics < Internal::Types::Model
+      field :monthly_payables_volume, -> { Integer }, optional: true, nullable: false, api_name: "monthlyPayablesVolume"
+
+      field :average_payables_size, -> { Integer }, optional: true, nullable: false, api_name: "averagePayablesSize"
+
+      field :largest_payables_size, -> { Integer }, optional: true, nullable: false, api_name: "largestPayablesSize"
+
+      field :number_of_transactions, -> { Integer }, optional: true, nullable: false, api_name: "numberOfTransactions"
+    end
+  end
+end

data/lib/payabli/types/paypoint_created_envelope.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping a created paypoint.
+    class PaypointCreatedEnvelope < 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::PaypointCreatedResponse }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/paypoint_created_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The reference and initial status of a newly created paypoint.
+    class PaypointCreatedResponse < Internal::Types::Model
+      field :paypoint_reference, -> { String }, optional: false, nullable: false, api_name: "paypointReference"
+
+      field :business_reference, -> { String }, optional: true, nullable: false, api_name: "businessReference"
+
+      field :doing_business_as, -> { String }, optional: true, nullable: false, api_name: "doingBusinessAs"
+
+      field :paypoint_status, -> { String }, optional: false, nullable: false, api_name: "paypointStatus"
+
+      field :timezone, -> { String }, optional: true, nullable: false
+
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+
+      field :links, -> { Payabli::Types::PaypointLinks }, optional: false, nullable: false, api_name: "_links"
+    end
+  end
+end

data/lib/payabli/types/paypoint_detail_envelope.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping a paypoint detail.
+    class PaypointDetailEnvelope < 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::PaypointDetailResponse }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/paypoint_detail_response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The full detail of a paypoint.
+    class PaypointDetailResponse < Internal::Types::Model
+      field :paypoint_reference, -> { String }, optional: false, nullable: false, api_name: "paypointReference"
+
+      field :business_reference, -> { String }, optional: true, nullable: false, api_name: "businessReference"
+
+      field :parent_paypoint_reference, -> { String }, optional: false, nullable: false, api_name: "parentPaypointReference"
+
+      field :paypoint_type, -> { String }, optional: true, nullable: false, api_name: "paypointType"
+
+      field :paypoint_status, -> { String }, optional: false, nullable: false, api_name: "paypointStatus"
+
+      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 :timezone, -> { 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 :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId"
+
+      field :entry_name, -> { String }, optional: false, nullable: false, api_name: "entryName"
+
+      field :created_at, -> { String }, optional: false, nullable: false, api_name: "createdAt"
+
+      field :updated_at, -> { String }, optional: false, nullable: false, api_name: "updatedAt"
+
+      field :links, -> { Payabli::Types::PaypointLinks }, optional: false, nullable: false, api_name: "_links"
+    end
+  end
+end

data/lib/payabli/types/paypoint_links.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Hypermedia links for a paypoint resource.
+    class PaypointLinks < Internal::Types::Model
+      field :self_, -> { String }, optional: true, nullable: false, api_name: "self"
+
+      field :business, -> { String }, optional: true, nullable: false
+    end
+  end
+end