payabli 3.0.19 → 3.0.21

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

data/lib/payabli/types/paypoint_summary_response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A paypoint as it appears in a list response.
+    class PaypointSummaryResponse < 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_updated_envelope.rb

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

data/lib/payabli/types/paypoint_updated_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The reference and updated timestamp after a paypoint update.
+    class PaypointUpdatedResponse < Internal::Types::Model
+      field :paypoint_reference, -> { String }, optional: false, nullable: false, api_name: "paypointReference"
+
+      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_writable_fields.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Fields you can set when you create a paypoint.
+    class PaypointWritableFields < Internal::Types::Model
+      field :parent_paypoint_reference, -> { String }, optional: true, nullable: false, api_name: "parentPaypointReference"
+
+      field :paypoint_type, -> { String }, optional: true, nullable: false, api_name: "paypointType"
+
+      field :doing_business_as, -> { String }, optional: false, nullable: false, api_name: "doingBusinessAs"
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :website, -> { 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 :timezone, -> { String }, optional: true, nullable: false
+
+      field :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId"
+
+      field :custom_data, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false, api_name: "customData"
+    end
+  end
+end

data/lib/payabli/types/people_search_envelope.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Standard boarding response envelope wrapping people search results.
+    class PeopleSearchEnvelope < 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::PeopleSearchResultsResponse }, optional: false, nullable: true
+    end
+  end
+end

data/lib/payabli/types/people_search_request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Search criteria for identity matching. Provide at least one of `firstName` or `lastName`.
+    class PeopleSearchRequest < Internal::Types::Model
+      extend Payabli::Internal::Types::Union
+
+      member -> { Object }
+    end
+  end
+end

data/lib/payabli/types/people_search_result_response.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # A single identity match returned by a search.
+    class PeopleSearchResultResponse < Internal::Types::Model
+      field :person_reference, -> { String }, optional: true, nullable: false, api_name: "personReference"
+
+      field :first_name, -> { String }, optional: true, nullable: false, api_name: "firstName"
+
+      field :last_name, -> { String }, optional: true, nullable: false, api_name: "lastName"
+
+      field :date_of_birth, -> { String }, optional: true, nullable: false, api_name: "dateOfBirth"
+
+      field :primary_email, -> { String }, optional: true, nullable: false, api_name: "primaryEmail"
+
+      field :primary_phone, -> { String }, optional: true, nullable: false, api_name: "primaryPhone"
+
+      field :risk_decision, -> { String }, optional: true, nullable: false, api_name: "riskDecision"
+
+      field :match_score, -> { Integer }, optional: true, nullable: false, api_name: "matchScore"
+
+      field :is_top_match, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isTopMatch"
+
+      field :is_from_vendor, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isFromVendor"
+
+      field :phones, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+      field :emails, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+      field :address_count, -> { Integer }, optional: true, nullable: false, api_name: "addressCount"
+
+      field :phone_count, -> { Integer }, optional: true, nullable: false, api_name: "phoneCount"
+
+      field :email_count, -> { Integer }, optional: true, nullable: false, api_name: "emailCount"
+    end
+  end
+end

data/lib/payabli/types/people_search_results_response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The results of a people search.
+    class PeopleSearchResultsResponse < Internal::Types::Model
+      field :results, -> { Internal::Types::Array[Payabli::Types::PeopleSearchResultResponse] }, optional: false, nullable: true
+
+      field :total, -> { Integer }, optional: false, nullable: false
+
+      field :is_enriched_by_vendor, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "isEnrichedByVendor"
+    end
+  end
+end

data/lib/payabli/types/person_address_request.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # An address included in a person request.
+    class PersonAddressRequest < Internal::Types::Model
+      field :address_line_1, -> { String }, optional: true, nullable: false, api_name: "addressLine1"
+
+      field :address_line_2, -> { String }, optional: true, nullable: false, api_name: "addressLine2"
+
+      field :city_locality, -> { String }, optional: true, nullable: false, api_name: "cityLocality"
+
+      field :state_province, -> { String }, optional: true, nullable: false, api_name: "stateProvince"
+
+      field :postal_code, -> { String }, optional: true, nullable: false, api_name: "postalCode"
+
+      field :country, -> { String }, optional: true, nullable: false
+
+      field :type, -> { Payabli::Types::PersonAddressType }, optional: true, nullable: false
+    end
+  end
+end

data/lib/payabli/types/person_address_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # An address in a person response.
+    class PersonAddressResponse < Internal::Types::Model
+      field :address_line_1, -> { String }, optional: true, nullable: false, api_name: "addressLine1"
+
+      field :address_line_2, -> { String }, optional: true, nullable: false, api_name: "addressLine2"
+
+      field :city_locality, -> { String }, optional: true, nullable: false, api_name: "cityLocality"
+
+      field :state_province, -> { String }, optional: true, nullable: false, api_name: "stateProvince"
+
+      field :postal_code, -> { String }, optional: true, nullable: false, api_name: "postalCode"
+
+      field :country, -> { String }, optional: true, nullable: false
+
+      field :type, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/payabli/types/person_address_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    module PersonAddressType
+      extend Payabli::Internal::Types::Enum
+
+      LEGAL = "legal"
+      BILLING = "billing"
+      SHIPPING = "shipping"
+      REMITTANCE = "remittance"
+      MAILING = "mailing"
+      PHYSICAL = "physical"
+      RESIDENTIAL = "residential"
+    end
+  end
+end

data/lib/payabli/types/person_detail_envelope.rb

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

data/lib/payabli/types/person_detail_response.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # The full detail of a person. Sensitive fields are masked unless read from the unmasked endpoint.
+    class PersonDetailResponse < Internal::Types::Model
+      field :person_reference, -> { String }, optional: false, nullable: false, api_name: "personReference"
+
+      field :external_id, -> { String }, optional: true, nullable: false, api_name: "externalId"
+
+      field :first_name, -> { String }, optional: false, nullable: true, api_name: "firstName"
+
+      field :middle_name, -> { String }, optional: true, nullable: false, api_name: "middleName"
+
+      field :last_name, -> { String }, optional: false, nullable: true, api_name: "lastName"
+
+      field :primary_email, -> { String }, optional: true, nullable: false, api_name: "primaryEmail"
+
+      field :secondary_email, -> { String }, optional: true, nullable: false, api_name: "secondaryEmail"
+
+      field :primary_phone_number, -> { String }, optional: true, nullable: false, api_name: "primaryPhoneNumber"
+
+      field :secondary_phone_number, -> { String }, optional: true, nullable: false, api_name: "secondaryPhoneNumber"
+
+      field :date_of_birth, -> { String }, optional: true, nullable: false, api_name: "dateOfBirth"
+
+      field :ssn, -> { String }, optional: true, nullable: false
+
+      field :nationality, -> { String }, optional: true, nullable: false
+
+      field :national_id_number, -> { String }, optional: true, nullable: false, api_name: "nationalIdNumber"
+
+      field :national_id_issuer, -> { String }, optional: true, nullable: false, api_name: "nationalIdIssuer"
+
+      field :drivers_license_number, -> { String }, optional: true, nullable: false, api_name: "driversLicenseNumber"
+
+      field :drivers_license_state, -> { String }, optional: true, nullable: false, api_name: "driversLicenseState"
+
+      field :custom_data, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false, api_name: "customData"
+
+      field :verification_status, -> { String }, optional: false, nullable: false, api_name: "verificationStatus"
+
+      field :addresses, -> { Internal::Types::Array[Payabli::Types::PersonAddressResponse] }, optional: true, nullable: false
+
+      field :identification_documents, -> { Internal::Types::Array[Payabli::Types::IdentificationDocumentResponse] }, optional: true, nullable: false, api_name: "identificationDocuments"
+
+      field :business_relationship, -> { Payabli::Types::BusinessRelationshipResponse }, optional: true, nullable: false, api_name: "businessRelationship"
+
+      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::PersonLinks }, optional: false, nullable: false, api_name: "_links"
+    end
+  end
+end

data/lib/payabli/types/person_links.rb

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