finch-api 0.1.0.pre.alpha.5 → 0.1.0.pre.alpha.14

data/rbi/finch_api/models/sandbox/company_update_params.rbi

@@ -0,0 +1,500 @@
+# typed: strong
+
+module FinchAPI
+  module Models
+    module Sandbox
+      class CompanyUpdateParams < FinchAPI::Internal::Type::BaseModel
+        extend FinchAPI::Internal::Type::RequestParameters::Converter
+        include FinchAPI::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
+        # An array of bank account objects associated with the payroll/HRIS system.
+        sig do
+          returns(
+            T.nilable(T::Array[FinchAPI::Sandbox::CompanyUpdateParams::Account])
+          )
+        end
+        attr_accessor :accounts
+
+        # The array of company departments.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                T.nilable(FinchAPI::Sandbox::CompanyUpdateParams::Department)
+              ]
+            )
+          )
+        end
+        attr_accessor :departments
+
+        # The employer identification number.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :ein
+
+        # The entity type object.
+        sig do
+          returns(T.nilable(FinchAPI::Sandbox::CompanyUpdateParams::Entity))
+        end
+        attr_reader :entity
+
+        sig do
+          params(
+            entity:
+              T.nilable(FinchAPI::Sandbox::CompanyUpdateParams::Entity::OrHash)
+          ).void
+        end
+        attr_writer :entity
+
+        # The legal name of the company.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :legal_name
+
+        sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Location)])) }
+        attr_accessor :locations
+
+        # The email of the main administrator on the account.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :primary_email
+
+        # The phone number of the main administrator on the account. Format: E.164, with
+        # extension where applicable, e.g. `+NNNNNNNNNNN xExtension`
+        sig { returns(T.nilable(String)) }
+        attr_accessor :primary_phone_number
+
+        sig do
+          params(
+            accounts:
+              T.nilable(
+                T::Array[
+                  FinchAPI::Sandbox::CompanyUpdateParams::Account::OrHash
+                ]
+              ),
+            departments:
+              T.nilable(
+                T::Array[
+                  T.nilable(
+                    FinchAPI::Sandbox::CompanyUpdateParams::Department::OrHash
+                  )
+                ]
+              ),
+            ein: T.nilable(String),
+            entity:
+              T.nilable(FinchAPI::Sandbox::CompanyUpdateParams::Entity::OrHash),
+            legal_name: T.nilable(String),
+            locations:
+              T.nilable(T::Array[T.nilable(FinchAPI::Location::OrHash)]),
+            primary_email: T.nilable(String),
+            primary_phone_number: T.nilable(String),
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # An array of bank account objects associated with the payroll/HRIS system.
+          accounts:,
+          # The array of company departments.
+          departments:,
+          # The employer identification number.
+          ein:,
+          # The entity type object.
+          entity:,
+          # The legal name of the company.
+          legal_name:,
+          locations:,
+          # The email of the main administrator on the account.
+          primary_email:,
+          # The phone number of the main administrator on the account. Format: E.164, with
+          # extension where applicable, e.g. `+NNNNNNNNNNN xExtension`
+          primary_phone_number:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              accounts:
+                T.nilable(
+                  T::Array[FinchAPI::Sandbox::CompanyUpdateParams::Account]
+                ),
+              departments:
+                T.nilable(
+                  T::Array[
+                    T.nilable(
+                      FinchAPI::Sandbox::CompanyUpdateParams::Department
+                    )
+                  ]
+                ),
+              ein: T.nilable(String),
+              entity: T.nilable(FinchAPI::Sandbox::CompanyUpdateParams::Entity),
+              legal_name: T.nilable(String),
+              locations: T.nilable(T::Array[T.nilable(FinchAPI::Location)]),
+              primary_email: T.nilable(String),
+              primary_phone_number: T.nilable(String),
+              request_options: FinchAPI::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Account < FinchAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
+          # The name of the bank associated in the payroll/HRIS system.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :account_name
+
+          # 10-12 digit number to specify the bank account
+          sig { returns(T.nilable(String)) }
+          attr_accessor :account_number
+
+          # The type of bank account.
+          sig do
+            returns(
+              T.nilable(
+                FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol
+              )
+            )
+          end
+          attr_accessor :account_type
+
+          # Name of the banking institution.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :institution_name
+
+          # A nine-digit code that's based on the U.S. Bank location where your account was
+          # opened.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :routing_number
+
+          sig do
+            params(
+              account_name: T.nilable(String),
+              account_number: T.nilable(String),
+              account_type:
+                T.nilable(
+                  FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol
+                ),
+              institution_name: T.nilable(String),
+              routing_number: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The name of the bank associated in the payroll/HRIS system.
+            account_name: nil,
+            # 10-12 digit number to specify the bank account
+            account_number: nil,
+            # The type of bank account.
+            account_type: nil,
+            # Name of the banking institution.
+            institution_name: nil,
+            # A nine-digit code that's based on the U.S. Bank location where your account was
+            # opened.
+            routing_number: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                account_name: T.nilable(String),
+                account_number: T.nilable(String),
+                account_type:
+                  T.nilable(
+                    FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType::OrSymbol
+                  ),
+                institution_name: T.nilable(String),
+                routing_number: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The type of bank account.
+          module AccountType
+            extend FinchAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            CHECKING =
+              T.let(
+                :checking,
+                FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol
+              )
+            SAVINGS =
+              T.let(
+                :savings,
+                FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  FinchAPI::Sandbox::CompanyUpdateParams::Account::AccountType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        class Department < FinchAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
+          # The department name.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :name
+
+          # The parent department, if present.
+          sig do
+            returns(
+              T.nilable(
+                FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent
+              )
+            )
+          end
+          attr_reader :parent
+
+          sig do
+            params(
+              parent:
+                T.nilable(
+                  FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent::OrHash
+                )
+            ).void
+          end
+          attr_writer :parent
+
+          sig do
+            params(
+              name: T.nilable(String),
+              parent:
+                T.nilable(
+                  FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent::OrHash
+                )
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The department name.
+            name: nil,
+            # The parent department, if present.
+            parent: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                name: T.nilable(String),
+                parent:
+                  T.nilable(
+                    FinchAPI::Sandbox::CompanyUpdateParams::Department::Parent
+                  )
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Parent < FinchAPI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
+            # The parent department's name.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :name
+
+            # The parent department, if present.
+            sig { params(name: T.nilable(String)).returns(T.attached_class) }
+            def self.new(
+              # The parent department's name.
+              name: nil
+            )
+            end
+
+            sig { override.returns({ name: T.nilable(String) }) }
+            def to_hash
+            end
+          end
+        end
+
+        class Entity < FinchAPI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias { T.any(T.self_type, FinchAPI::Internal::AnyHash) }
+
+          # The tax payer subtype of the company.
+          sig do
+            returns(
+              T.nilable(
+                FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol
+              )
+            )
+          end
+          attr_accessor :subtype
+
+          # The tax payer type of the company.
+          sig do
+            returns(
+              T.nilable(
+                FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol
+              )
+            )
+          end
+          attr_accessor :type
+
+          # The entity type object.
+          sig do
+            params(
+              subtype:
+                T.nilable(
+                  FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol
+                ),
+              type:
+                T.nilable(
+                  FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol
+                )
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The tax payer subtype of the company.
+            subtype: nil,
+            # The tax payer type of the company.
+            type: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                subtype:
+                  T.nilable(
+                    FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype::OrSymbol
+                  ),
+                type:
+                  T.nilable(
+                    FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::OrSymbol
+                  )
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The tax payer subtype of the company.
+          module Subtype
+            extend FinchAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            S_CORPORATION =
+              T.let(
+                :s_corporation,
+                FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol
+              )
+            C_CORPORATION =
+              T.let(
+                :c_corporation,
+                FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol
+              )
+            B_CORPORATION =
+              T.let(
+                :b_corporation,
+                FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  FinchAPI::Sandbox::CompanyUpdateParams::Entity::Subtype::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # The tax payer type of the company.
+          module Type
+            extend FinchAPI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            LLC =
+              T.let(
+                :llc,
+                FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol
+              )
+            LP =
+              T.let(
+                :lp,
+                FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol
+              )
+            CORPORATION =
+              T.let(
+                :corporation,
+                FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol
+              )
+            SOLE_PROPRIETOR =
+              T.let(
+                :sole_proprietor,
+                FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol
+              )
+            NON_PROFIT =
+              T.let(
+                :non_profit,
+                FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol
+              )
+            PARTNERSHIP =
+              T.let(
+                :partnership,
+                FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol
+              )
+            COOPERATIVE =
+              T.let(
+                :cooperative,
+                FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  FinchAPI::Sandbox::CompanyUpdateParams::Entity::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end