lithic 0.1.0.pre.alpha.1

data/rbi/lib/lithic/models/kyb.rbi

@@ -0,0 +1,464 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class KYB < Lithic::BaseModel
+      # List of all entities with >25% ownership in the company. If no entity or
+      #   individual owns >25% of the company, and the largest shareholder is an entity,
+      #   please identify them in this field. See
+      #   [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+      #   (Section I) for more background. If no business owner is an entity, pass in an
+      #   empty list. However, either this parameter or `beneficial_owner_individuals`
+      #   must be populated. on entities that should be included.
+      sig { returns(T::Array[Lithic::Models::KYB::BeneficialOwnerEntity]) }
+      attr_accessor :beneficial_owner_entities
+
+      # List of all direct and indirect individuals with >25% ownership in the company.
+      #   If no entity or individual owns >25% of the company, and the largest shareholder
+      #   is an individual, please identify them in this field. See
+      #   [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+      #   (Section I) for more background on individuals that should be included. If no
+      #   individual is an entity, pass in an empty list. However, either this parameter
+      #   or `beneficial_owner_entities` must be populated.
+      sig { returns(T::Array[Lithic::Models::KYB::BeneficialOwnerIndividual]) }
+      attr_accessor :beneficial_owner_individuals
+
+      # Information for business for which the account is being opened and KYB is being
+      #   run.
+      sig { returns(Lithic::Models::KYB::BusinessEntity) }
+      attr_reader :business_entity
+
+      sig { params(business_entity: T.any(Lithic::Models::KYB::BusinessEntity, Lithic::Util::AnyHash)).void }
+      attr_writer :business_entity
+
+      # An individual with significant responsibility for managing the legal entity
+      #   (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
+      #   Officer, Managing Member, General Partner, President, Vice President, or
+      #   Treasurer). This can be an executive, or someone who will have program-wide
+      #   access to the cards that Lithic will provide. In some cases, this individual
+      #   could also be a beneficial owner listed above. See
+      #   [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+      #   (Section II) for more background.
+      sig { returns(Lithic::Models::KYB::ControlPerson) }
+      attr_reader :control_person
+
+      sig { params(control_person: T.any(Lithic::Models::KYB::ControlPerson, Lithic::Util::AnyHash)).void }
+      attr_writer :control_person
+
+      # Short description of the company's line of business (i.e., what does the company
+      #   do?).
+      sig { returns(String) }
+      attr_accessor :nature_of_business
+
+      # An RFC 3339 timestamp indicating when the account holder accepted the applicable
+      #   legal agreements (e.g., cardholder terms) as agreed upon during API customer's
+      #   implementation with Lithic.
+      sig { returns(String) }
+      attr_accessor :tos_timestamp
+
+      # Specifies the type of KYB workflow to run.
+      sig { returns(Lithic::Models::KYB::Workflow::OrSymbol) }
+      attr_accessor :workflow
+
+      # A user provided id that can be used to link an account holder with an external
+      #   system
+      sig { returns(T.nilable(String)) }
+      attr_reader :external_id
+
+      sig { params(external_id: String).void }
+      attr_writer :external_id
+
+      # An RFC 3339 timestamp indicating when precomputed KYC was completed on the
+      #   business with a pass result.
+      #
+      #   This field is required only if workflow type is `KYB_BYO`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :kyb_passed_timestamp
+
+      sig { params(kyb_passed_timestamp: String).void }
+      attr_writer :kyb_passed_timestamp
+
+      # Company website URL.
+      sig { returns(T.nilable(String)) }
+      attr_reader :website_url
+
+      sig { params(website_url: String).void }
+      attr_writer :website_url
+
+      sig do
+        params(
+          beneficial_owner_entities: T::Array[T.any(Lithic::Models::KYB::BeneficialOwnerEntity, Lithic::Util::AnyHash)],
+          beneficial_owner_individuals: T::Array[T.any(Lithic::Models::KYB::BeneficialOwnerIndividual, Lithic::Util::AnyHash)],
+          business_entity: T.any(Lithic::Models::KYB::BusinessEntity, Lithic::Util::AnyHash),
+          control_person: T.any(Lithic::Models::KYB::ControlPerson, Lithic::Util::AnyHash),
+          nature_of_business: String,
+          tos_timestamp: String,
+          workflow: Lithic::Models::KYB::Workflow::OrSymbol,
+          external_id: String,
+          kyb_passed_timestamp: String,
+          website_url: String
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        beneficial_owner_entities:,
+        beneficial_owner_individuals:,
+        business_entity:,
+        control_person:,
+        nature_of_business:,
+        tos_timestamp:,
+        workflow:,
+        external_id: nil,
+        kyb_passed_timestamp: nil,
+        website_url: nil
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              beneficial_owner_entities: T::Array[Lithic::Models::KYB::BeneficialOwnerEntity],
+              beneficial_owner_individuals: T::Array[Lithic::Models::KYB::BeneficialOwnerIndividual],
+              business_entity: Lithic::Models::KYB::BusinessEntity,
+              control_person: Lithic::Models::KYB::ControlPerson,
+              nature_of_business: String,
+              tos_timestamp: String,
+              workflow: Lithic::Models::KYB::Workflow::OrSymbol,
+              external_id: String,
+              kyb_passed_timestamp: String,
+              website_url: String
+            }
+          )
+      end
+      def to_hash
+      end
+
+      class BeneficialOwnerEntity < Lithic::BaseModel
+        # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
+        #   acceptable; APO/FPO are acceptable.
+        sig { returns(Lithic::Models::Address) }
+        attr_reader :address
+
+        sig { params(address: T.any(Lithic::Models::Address, Lithic::Util::AnyHash)).void }
+        attr_writer :address
+
+        # Government-issued identification number. US Federal Employer Identification
+        #   Numbers (EIN) are currently supported, entered as full nine-digits, with or
+        #   without hyphens.
+        sig { returns(String) }
+        attr_accessor :government_id
+
+        # Legal (formal) business name.
+        sig { returns(String) }
+        attr_accessor :legal_business_name
+
+        # One or more of the business's phone number(s), entered as a list in E.164
+        #   format.
+        sig { returns(T::Array[String]) }
+        attr_accessor :phone_numbers
+
+        # Any name that the business operates under that is not its legal business name
+        #   (if applicable).
+        sig { returns(T.nilable(String)) }
+        attr_reader :dba_business_name
+
+        sig { params(dba_business_name: String).void }
+        attr_writer :dba_business_name
+
+        # Parent company name (if applicable).
+        sig { returns(T.nilable(String)) }
+        attr_reader :parent_company
+
+        sig { params(parent_company: String).void }
+        attr_writer :parent_company
+
+        sig do
+          params(
+            address: T.any(Lithic::Models::Address, Lithic::Util::AnyHash),
+            government_id: String,
+            legal_business_name: String,
+            phone_numbers: T::Array[String],
+            dba_business_name: String,
+            parent_company: String
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          address:,
+          government_id:,
+          legal_business_name:,
+          phone_numbers:,
+          dba_business_name: nil,
+          parent_company: nil
+        )
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                address: Lithic::Models::Address,
+                government_id: String,
+                legal_business_name: String,
+                phone_numbers: T::Array[String],
+                dba_business_name: String,
+                parent_company: String
+              }
+            )
+        end
+        def to_hash
+        end
+      end
+
+      class BeneficialOwnerIndividual < Lithic::BaseModel
+        # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
+        #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+        sig { returns(Lithic::Models::Address) }
+        attr_reader :address
+
+        sig { params(address: T.any(Lithic::Models::Address, Lithic::Util::AnyHash)).void }
+        attr_writer :address
+
+        # Individual's date of birth, as an RFC 3339 date.
+        sig { returns(String) }
+        attr_accessor :dob
+
+        # Individual's email address. If utilizing Lithic for chargeback processing, this
+        #   customer email address may be used to communicate dispute status and resolution.
+        sig { returns(String) }
+        attr_accessor :email
+
+        # Individual's first name, as it appears on government-issued identity documents.
+        sig { returns(String) }
+        attr_accessor :first_name
+
+        # Government-issued identification number (required for identity verification and
+        #   compliance with banking regulations). Social Security Numbers (SSN) and
+        #   Individual Taxpayer Identification Numbers (ITIN) are currently supported,
+        #   entered as full nine-digits, with or without hyphens
+        sig { returns(String) }
+        attr_accessor :government_id
+
+        # Individual's last name, as it appears on government-issued identity documents.
+        sig { returns(String) }
+        attr_accessor :last_name
+
+        # Individual's phone number, entered in E.164 format.
+        sig { returns(T.nilable(String)) }
+        attr_reader :phone_number
+
+        sig { params(phone_number: String).void }
+        attr_writer :phone_number
+
+        # Individuals associated with a KYB application. Phone number is optional.
+        sig do
+          params(
+            address: T.any(Lithic::Models::Address, Lithic::Util::AnyHash),
+            dob: String,
+            email: String,
+            first_name: String,
+            government_id: String,
+            last_name: String,
+            phone_number: String
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil)
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                address: Lithic::Models::Address,
+                dob: String,
+                email: String,
+                first_name: String,
+                government_id: String,
+                last_name: String,
+                phone_number: String
+              }
+            )
+        end
+        def to_hash
+        end
+      end
+
+      class BusinessEntity < Lithic::BaseModel
+        # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
+        #   acceptable; APO/FPO are acceptable.
+        sig { returns(Lithic::Models::Address) }
+        attr_reader :address
+
+        sig { params(address: T.any(Lithic::Models::Address, Lithic::Util::AnyHash)).void }
+        attr_writer :address
+
+        # Government-issued identification number. US Federal Employer Identification
+        #   Numbers (EIN) are currently supported, entered as full nine-digits, with or
+        #   without hyphens.
+        sig { returns(String) }
+        attr_accessor :government_id
+
+        # Legal (formal) business name.
+        sig { returns(String) }
+        attr_accessor :legal_business_name
+
+        # One or more of the business's phone number(s), entered as a list in E.164
+        #   format.
+        sig { returns(T::Array[String]) }
+        attr_accessor :phone_numbers
+
+        # Any name that the business operates under that is not its legal business name
+        #   (if applicable).
+        sig { returns(T.nilable(String)) }
+        attr_reader :dba_business_name
+
+        sig { params(dba_business_name: String).void }
+        attr_writer :dba_business_name
+
+        # Parent company name (if applicable).
+        sig { returns(T.nilable(String)) }
+        attr_reader :parent_company
+
+        sig { params(parent_company: String).void }
+        attr_writer :parent_company
+
+        # Information for business for which the account is being opened and KYB is being
+        #   run.
+        sig do
+          params(
+            address: T.any(Lithic::Models::Address, Lithic::Util::AnyHash),
+            government_id: String,
+            legal_business_name: String,
+            phone_numbers: T::Array[String],
+            dba_business_name: String,
+            parent_company: String
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(
+          address:,
+          government_id:,
+          legal_business_name:,
+          phone_numbers:,
+          dba_business_name: nil,
+          parent_company: nil
+        )
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                address: Lithic::Models::Address,
+                government_id: String,
+                legal_business_name: String,
+                phone_numbers: T::Array[String],
+                dba_business_name: String,
+                parent_company: String
+              }
+            )
+        end
+        def to_hash
+        end
+      end
+
+      class ControlPerson < Lithic::BaseModel
+        # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
+        #   acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+        sig { returns(Lithic::Models::Address) }
+        attr_reader :address
+
+        sig { params(address: T.any(Lithic::Models::Address, Lithic::Util::AnyHash)).void }
+        attr_writer :address
+
+        # Individual's date of birth, as an RFC 3339 date.
+        sig { returns(String) }
+        attr_accessor :dob
+
+        # Individual's email address. If utilizing Lithic for chargeback processing, this
+        #   customer email address may be used to communicate dispute status and resolution.
+        sig { returns(String) }
+        attr_accessor :email
+
+        # Individual's first name, as it appears on government-issued identity documents.
+        sig { returns(String) }
+        attr_accessor :first_name
+
+        # Government-issued identification number (required for identity verification and
+        #   compliance with banking regulations). Social Security Numbers (SSN) and
+        #   Individual Taxpayer Identification Numbers (ITIN) are currently supported,
+        #   entered as full nine-digits, with or without hyphens
+        sig { returns(String) }
+        attr_accessor :government_id
+
+        # Individual's last name, as it appears on government-issued identity documents.
+        sig { returns(String) }
+        attr_accessor :last_name
+
+        # Individual's phone number, entered in E.164 format.
+        sig { returns(T.nilable(String)) }
+        attr_reader :phone_number
+
+        sig { params(phone_number: String).void }
+        attr_writer :phone_number
+
+        # An individual with significant responsibility for managing the legal entity
+        #   (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
+        #   Officer, Managing Member, General Partner, President, Vice President, or
+        #   Treasurer). This can be an executive, or someone who will have program-wide
+        #   access to the cards that Lithic will provide. In some cases, this individual
+        #   could also be a beneficial owner listed above. See
+        #   [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+        #   (Section II) for more background.
+        sig do
+          params(
+            address: T.any(Lithic::Models::Address, Lithic::Util::AnyHash),
+            dob: String,
+            email: String,
+            first_name: String,
+            government_id: String,
+            last_name: String,
+            phone_number: String
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number: nil)
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                address: Lithic::Models::Address,
+                dob: String,
+                email: String,
+                first_name: String,
+                government_id: String,
+                last_name: String,
+                phone_number: String
+              }
+            )
+        end
+        def to_hash
+        end
+      end
+
+      # Specifies the type of KYB workflow to run.
+      module Workflow
+        extend Lithic::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Lithic::Models::KYB::Workflow) }
+        OrSymbol = T.type_alias { T.any(Symbol, Lithic::Models::KYB::Workflow::TaggedSymbol) }
+
+        KYB_BASIC = T.let(:KYB_BASIC, Lithic::Models::KYB::Workflow::TaggedSymbol)
+        KYB_BYO = T.let(:KYB_BYO, Lithic::Models::KYB::Workflow::TaggedSymbol)
+
+        sig { override.returns(T::Array[Lithic::Models::KYB::Workflow::TaggedSymbol]) }
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/lib/lithic/models/kyb_business_entity.rbi

@@ -0,0 +1,146 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class KYBBusinessEntity < Lithic::BaseModel
+      # Business''s physical address - PO boxes, UPS drops, and FedEx drops are not
+      #   acceptable; APO/FPO are acceptable.
+      sig { returns(Lithic::Models::KYBBusinessEntity::Address) }
+      attr_reader :address
+
+      sig { params(address: T.any(Lithic::Models::KYBBusinessEntity::Address, Lithic::Util::AnyHash)).void }
+      attr_writer :address
+
+      # Government-issued identification number. US Federal Employer Identification
+      #   Numbers (EIN) are currently supported, entered as full nine-digits, with or
+      #   without hyphens.
+      sig { returns(String) }
+      attr_accessor :government_id
+
+      # Legal (formal) business name.
+      sig { returns(String) }
+      attr_accessor :legal_business_name
+
+      # One or more of the business's phone number(s), entered as a list in E.164
+      #   format.
+      sig { returns(T::Array[String]) }
+      attr_accessor :phone_numbers
+
+      # Any name that the business operates under that is not its legal business name
+      #   (if applicable).
+      sig { returns(T.nilable(String)) }
+      attr_reader :dba_business_name
+
+      sig { params(dba_business_name: String).void }
+      attr_writer :dba_business_name
+
+      # Parent company name (if applicable).
+      sig { returns(T.nilable(String)) }
+      attr_reader :parent_company
+
+      sig { params(parent_company: String).void }
+      attr_writer :parent_company
+
+      sig do
+        params(
+          address: T.any(Lithic::Models::KYBBusinessEntity::Address, Lithic::Util::AnyHash),
+          government_id: String,
+          legal_business_name: String,
+          phone_numbers: T::Array[String],
+          dba_business_name: String,
+          parent_company: String
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        address:,
+        government_id:,
+        legal_business_name:,
+        phone_numbers:,
+        dba_business_name: nil,
+        parent_company: nil
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              address: Lithic::Models::KYBBusinessEntity::Address,
+              government_id: String,
+              legal_business_name: String,
+              phone_numbers: T::Array[String],
+              dba_business_name: String,
+              parent_company: String
+            }
+          )
+      end
+      def to_hash
+      end
+
+      class Address < Lithic::BaseModel
+        # Valid deliverable address (no PO boxes).
+        sig { returns(String) }
+        attr_accessor :address1
+
+        # Name of city.
+        sig { returns(String) }
+        attr_accessor :city
+
+        # Valid country code. Only USA is currently supported, entered in uppercase ISO
+        #   3166-1 alpha-3 three-character format.
+        sig { returns(String) }
+        attr_accessor :country
+
+        # Valid postal code. Only USA ZIP codes are currently supported, entered as a
+        #   five-digit ZIP or nine-digit ZIP+4.
+        sig { returns(String) }
+        attr_accessor :postal_code
+
+        # Valid state code. Only USA state codes are currently supported, entered in
+        #   uppercase ISO 3166-2 two-character format.
+        sig { returns(String) }
+        attr_accessor :state
+
+        # Unit or apartment number (if applicable).
+        sig { returns(T.nilable(String)) }
+        attr_reader :address2
+
+        sig { params(address2: String).void }
+        attr_writer :address2
+
+        # Business''s physical address - PO boxes, UPS drops, and FedEx drops are not
+        #   acceptable; APO/FPO are acceptable.
+        sig do
+          params(
+            address1: String,
+            city: String,
+            country: String,
+            postal_code: String,
+            state: String,
+            address2: String
+          )
+            .returns(T.attached_class)
+        end
+        def self.new(address1:, city:, country:, postal_code:, state:, address2: nil)
+        end
+
+        sig do
+          override
+            .returns(
+              {
+                address1: String,
+                city: String,
+                country: String,
+                postal_code: String,
+                state: String,
+                address2: String
+              }
+            )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end