finch-api 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.3

data/rbi/lib/finch-api/models/sandbox/individual_update_response.rbi

@@ -4,137 +4,92 @@ module FinchAPI
   module Models
     module Sandbox
       class IndividualUpdateResponse < FinchAPI::BaseModel
+        # A stable Finch `id` (UUID v4) for an individual in the company.
         sig { returns(T.nilable(String)) }
-        def id
-        end
+        attr_reader :id
 
-        sig { params(_: String).returns(String) }
-        def id=(_)
-        end
+        sig { params(id: String).void }
+        attr_writer :id
 
         sig { returns(T.nilable(String)) }
-        def dob
-        end
-
-        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-        def dob=(_)
-        end
+        attr_accessor :dob
 
         sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email])) }
-        def emails
-        end
-
-        sig do
-          params(_: T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email]))
-            .returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email]))
-        end
-        def emails=(_)
-        end
+        attr_accessor :emails
 
+        # Social Security Number of the individual in **encrypted** format. This field is
+        #   only available with the `ssn` scope enabled and the
+        #   `options: { include: ['ssn'] }` param set in the body.
         sig { returns(T.nilable(String)) }
-        def encrypted_ssn
-        end
-
-        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-        def encrypted_ssn=(_)
-        end
-
-        sig { returns(T.nilable(Symbol)) }
-        def ethnicity
-        end
+        attr_accessor :encrypted_ssn
 
-        sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
-        def ethnicity=(_)
-        end
+        # The EEOC-defined ethnicity of the individual.
+        sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol)) }
+        attr_accessor :ethnicity
 
+        # The legal first name of the individual.
         sig { returns(T.nilable(String)) }
-        def first_name
-        end
-
-        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-        def first_name=(_)
-        end
-
-        sig { returns(T.nilable(Symbol)) }
-        def gender
-        end
+        attr_accessor :first_name
 
-        sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
-        def gender=(_)
-        end
+        # The gender of the individual.
+        sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol)) }
+        attr_accessor :gender
 
+        # The legal last name of the individual.
         sig { returns(T.nilable(String)) }
-        def last_name
-        end
-
-        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-        def last_name=(_)
-        end
+        attr_accessor :last_name
 
+        # The legal middle name of the individual.
         sig { returns(T.nilable(String)) }
-        def middle_name
-        end
-
-        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-        def middle_name=(_)
-        end
+        attr_accessor :middle_name
 
         sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber)])) }
-        def phone_numbers
-        end
-
-        sig do
-          params(
-            _: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber)])
-          )
-            .returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber)]))
-        end
-        def phone_numbers=(_)
-        end
+        attr_accessor :phone_numbers
 
+        # The preferred name of the individual.
         sig { returns(T.nilable(String)) }
-        def preferred_name
-        end
-
-        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-        def preferred_name=(_)
-        end
+        attr_accessor :preferred_name
 
         sig { returns(T.nilable(FinchAPI::Models::Location)) }
-        def residence
-        end
+        attr_reader :residence
 
-        sig { params(_: T.nilable(FinchAPI::Models::Location)).returns(T.nilable(FinchAPI::Models::Location)) }
-        def residence=(_)
-        end
+        sig { params(residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash))).void }
+        attr_writer :residence
 
+        # Social Security Number of the individual. This field is only available with the
+        #   `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the
+        #   body.
+        #   [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field).
         sig { returns(T.nilable(String)) }
-        def ssn
-        end
-
-        sig { params(_: T.nilable(String)).returns(T.nilable(String)) }
-        def ssn=(_)
-        end
+        attr_accessor :ssn
 
         sig do
           params(
             id: String,
             dob: T.nilable(String),
-            emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email]),
+            emails: T.nilable(
+              T::Array[T.any(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email, FinchAPI::Util::AnyHash)]
+            ),
             encrypted_ssn: T.nilable(String),
-            ethnicity: T.nilable(Symbol),
+            ethnicity: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::OrSymbol),
             first_name: T.nilable(String),
-            gender: T.nilable(Symbol),
+            gender: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::OrSymbol),
             last_name: T.nilable(String),
             middle_name: T.nilable(String),
-            phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber)]),
+            phone_numbers: T.nilable(
+              T::Array[
+              T.nilable(
+                T.any(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber, FinchAPI::Util::AnyHash)
+              )
+              ]
+            ),
             preferred_name: T.nilable(String),
-            residence: T.nilable(FinchAPI::Models::Location),
+            residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)),
             ssn: T.nilable(String)
           )
-            .void
+            .returns(T.attached_class)
         end
-        def initialize(
+        def self.new(
           id: nil,
           dob: nil,
           emails: nil,
@@ -159,9 +114,9 @@ module FinchAPI
                 dob: T.nilable(String),
                 emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email]),
                 encrypted_ssn: T.nilable(String),
-                ethnicity: T.nilable(Symbol),
+                ethnicity: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol),
                 first_name: T.nilable(String),
-                gender: T.nilable(Symbol),
+                gender: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol),
                 last_name: T.nilable(String),
                 middle_name: T.nilable(String),
                 phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber)]),
@@ -176,103 +131,157 @@ module FinchAPI
 
         class Email < FinchAPI::BaseModel
           sig { returns(T.nilable(String)) }
-          def data
-          end
+          attr_reader :data
 
-          sig { params(_: String).returns(String) }
-          def data=(_)
-          end
+          sig { params(data: String).void }
+          attr_writer :data
 
-          sig { returns(T.nilable(Symbol)) }
-          def type
-          end
+          sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol)) }
+          attr_accessor :type
 
-          sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
-          def type=(_)
+          sig do
+            params(
+              data: String,
+              type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::OrSymbol)
+            )
+              .returns(T.attached_class)
           end
-
-          sig { params(data: String, type: T.nilable(Symbol)).void }
-          def initialize(data: nil, type: nil)
+          def self.new(data: nil, type: nil)
           end
 
-          sig { override.returns({data: String, type: T.nilable(Symbol)}) }
+          sig do
+            override
+              .returns(
+                {
+                  data: String,
+                  type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol)
+                }
+              )
+          end
           def to_hash
           end
 
-          class Type < FinchAPI::Enum
-            abstract!
+          module Type
+            extend FinchAPI::Enum
+
+            TaggedSymbol =
+              T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type) }
+            OrSymbol =
+              T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol) }
 
-            WORK = T.let(:work, T.nilable(Symbol))
-            PERSONAL = T.let(:personal, T.nilable(Symbol))
+            WORK = T.let(:work, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol)
+            PERSONAL =
+              T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol)
 
-            sig { override.returns(T::Array[Symbol]) }
+            sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol]) }
             def self.values
             end
           end
         end
 
-        class Ethnicity < FinchAPI::Enum
-          abstract!
+        # The EEOC-defined ethnicity of the individual.
+        module Ethnicity
+          extend FinchAPI::Enum
 
-          ASIAN = T.let(:asian, T.nilable(Symbol))
-          WHITE = T.let(:white, T.nilable(Symbol))
-          BLACK_OR_AFRICAN_AMERICAN = T.let(:black_or_african_american, T.nilable(Symbol))
-          NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER = T.let(:native_hawaiian_or_pacific_islander, T.nilable(Symbol))
-          AMERICAN_INDIAN_OR_ALASKA_NATIVE = T.let(:american_indian_or_alaska_native, T.nilable(Symbol))
-          HISPANIC_OR_LATINO = T.let(:hispanic_or_latino, T.nilable(Symbol))
-          TWO_OR_MORE_RACES = T.let(:two_or_more_races, T.nilable(Symbol))
-          DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol))
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity) }
+          OrSymbol =
+            T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol) }
 
-          sig { override.returns(T::Array[Symbol]) }
+          ASIAN = T.let(:asian, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol)
+          WHITE = T.let(:white, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol)
+          BLACK_OR_AFRICAN_AMERICAN =
+            T.let(
+              :black_or_african_american,
+              FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol
+            )
+          NATIVE_HAWAIIAN_OR_PACIFIC_ISLANDER =
+            T.let(
+              :native_hawaiian_or_pacific_islander,
+              FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol
+            )
+          AMERICAN_INDIAN_OR_ALASKA_NATIVE =
+            T.let(
+              :american_indian_or_alaska_native,
+              FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol
+            )
+          HISPANIC_OR_LATINO =
+            T.let(:hispanic_or_latino, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol)
+          TWO_OR_MORE_RACES =
+            T.let(:two_or_more_races, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol)
+          DECLINE_TO_SPECIFY =
+            T.let(:decline_to_specify, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol)
+
+          sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol]) }
           def self.values
           end
         end
 
-        class Gender < FinchAPI::Enum
-          abstract!
+        # The gender of the individual.
+        module Gender
+          extend FinchAPI::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender) }
+          OrSymbol =
+            T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol) }
 
-          FEMALE = T.let(:female, T.nilable(Symbol))
-          MALE = T.let(:male, T.nilable(Symbol))
-          OTHER = T.let(:other, T.nilable(Symbol))
-          DECLINE_TO_SPECIFY = T.let(:decline_to_specify, T.nilable(Symbol))
+          FEMALE = T.let(:female, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol)
+          MALE = T.let(:male, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol)
+          OTHER = T.let(:other, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol)
+          DECLINE_TO_SPECIFY =
+            T.let(:decline_to_specify, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol)
 
-          sig { override.returns(T::Array[Symbol]) }
+          sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol]) }
           def self.values
           end
         end
 
         class PhoneNumber < FinchAPI::BaseModel
           sig { returns(T.nilable(String)) }
-          def data
-          end
+          attr_accessor :data
 
-          sig { params(_: String).returns(String) }
-          def data=(_)
-          end
+          sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol)) }
+          attr_accessor :type
 
-          sig { returns(T.nilable(Symbol)) }
-          def type
+          sig do
+            params(
+              data: T.nilable(String),
+              type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::OrSymbol)
+            )
+              .returns(T.attached_class)
           end
-
-          sig { params(_: T.nilable(Symbol)).returns(T.nilable(Symbol)) }
-          def type=(_)
+          def self.new(data: nil, type: nil)
           end
 
-          sig { params(data: String, type: T.nilable(Symbol)).void }
-          def initialize(data: nil, type: nil)
+          sig do
+            override
+              .returns(
+                {
+                  data: T.nilable(String),
+                  type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol)
+                }
+              )
           end
-
-          sig { override.returns({data: String, type: T.nilable(Symbol)}) }
           def to_hash
           end
 
-          class Type < FinchAPI::Enum
-            abstract!
+          module Type
+            extend FinchAPI::Enum
+
+            TaggedSymbol =
+              T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type) }
+            OrSymbol =
+              T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol) }
 
-            WORK = T.let(:work, T.nilable(Symbol))
-            PERSONAL = T.let(:personal, T.nilable(Symbol))
+            WORK = T.let(:work, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol)
+            PERSONAL =
+              T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol)
 
-            sig { override.returns(T::Array[Symbol]) }
+            sig do
+              override
+                .returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol])
+            end
             def self.values
             end
           end

data/rbi/lib/finch-api/models/sandbox/job_create_params.rbi

@@ -7,36 +7,39 @@ module FinchAPI
         extend FinchAPI::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
-        sig { returns(Symbol) }
-        def type
-        end
-
-        sig { params(_: Symbol).returns(Symbol) }
-        def type=(_)
-        end
+        # The type of job to start. Currently the only supported type is `data_sync_all`
+        sig { returns(FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol) }
+        attr_accessor :type
 
         sig do
           params(
-            type: Symbol,
-            request_options: T.any(
-              FinchAPI::RequestOptions,
-              T::Hash[Symbol, T.anything]
-            )
-          ).void
+            type: FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol,
+            request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)
+          )
+            .returns(T.attached_class)
         end
-        def initialize(type:, request_options: {})
+        def self.new(type:, request_options: {})
         end
 
-        sig { override.returns({type: Symbol, request_options: FinchAPI::RequestOptions}) }
+        sig do
+          override
+            .returns(
+              {type: FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol, request_options: FinchAPI::RequestOptions}
+            )
+        end
         def to_hash
         end
 
-        class Type < FinchAPI::Enum
-          abstract!
+        # The type of job to start. Currently the only supported type is `data_sync_all`
+        module Type
+          extend FinchAPI::Enum
+
+          TaggedSymbol = T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type) }
+          OrSymbol = T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type::TaggedSymbol) }
 
-          DATA_SYNC_ALL = :data_sync_all
+          DATA_SYNC_ALL = T.let(:data_sync_all, FinchAPI::Models::Sandbox::JobCreateParams::Type::TaggedSymbol)
 
-          sig { override.returns(T::Array[Symbol]) }
+          sig { override.returns(T::Array[FinchAPI::Models::Sandbox::JobCreateParams::Type::TaggedSymbol]) }
           def self.values
           end
         end

data/rbi/lib/finch-api/models/sandbox/job_create_response.rbi

@@ -4,47 +4,27 @@ module FinchAPI
   module Models
     module Sandbox
       class JobCreateResponse < FinchAPI::BaseModel
+        # The number of allowed refreshes per hour (per hour, fixed window)
         sig { returns(Integer) }
-        def allowed_refreshes
-        end
-
-        sig { params(_: Integer).returns(Integer) }
-        def allowed_refreshes=(_)
-        end
+        attr_accessor :allowed_refreshes
 
+        # The id of the job that has been created.
         sig { returns(String) }
-        def job_id
-        end
-
-        sig { params(_: String).returns(String) }
-        def job_id=(_)
-        end
+        attr_accessor :job_id
 
+        # The url that can be used to retrieve the job status
         sig { returns(String) }
-        def job_url
-        end
-
-        sig { params(_: String).returns(String) }
-        def job_url=(_)
-        end
+        attr_accessor :job_url
 
+        # The number of remaining refreshes available (per hour, fixed window)
         sig { returns(Integer) }
-        def remaining_refreshes
-        end
-
-        sig { params(_: Integer).returns(Integer) }
-        def remaining_refreshes=(_)
-        end
+        attr_accessor :remaining_refreshes
 
         sig do
-          params(
-            allowed_refreshes: Integer,
-            job_id: String,
-            job_url: String,
-            remaining_refreshes: Integer
-          ).void
+          params(allowed_refreshes: Integer, job_id: String, job_url: String, remaining_refreshes: Integer)
+            .returns(T.attached_class)
         end
-        def initialize(allowed_refreshes:, job_id:, job_url:, remaining_refreshes:)
+        def self.new(allowed_refreshes:, job_id:, job_url:, remaining_refreshes:)
         end
 
         sig do

data/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_params.rbi

@@ -8,8 +8,15 @@ module FinchAPI
           extend FinchAPI::RequestParameters::Converter
           include FinchAPI::RequestParameters
 
-          sig { params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])).void }
-          def initialize(request_options: {})
+          sig do
+            params(
+              request_options: T.any(
+                FinchAPI::RequestOptions,
+                FinchAPI::Util::AnyHash
+              )
+            ).returns(T.attached_class)
+          end
+          def self.new(request_options: {})
           end
 
           sig { override.returns({request_options: FinchAPI::RequestOptions}) }

data/rbi/lib/finch-api/models/sandbox/jobs/configuration_retrieve_response.rbi

@@ -4,7 +4,8 @@ module FinchAPI
   module Models
     module Sandbox
       module Jobs
-        ConfigurationRetrieveResponse = T.type_alias { T::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration] }
+        ConfigurationRetrieveResponse =
+          T.let(FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration], FinchAPI::Converter)
       end
     end
   end

data/rbi/lib/finch-api/models/sandbox/jobs/configuration_update_params.rbi

@@ -8,8 +8,15 @@ module FinchAPI
           extend FinchAPI::RequestParameters::Converter
           include FinchAPI::RequestParameters
 
-          sig { params(request_options: T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])).void }
-          def initialize(request_options: {})
+          sig do
+            params(
+              request_options: T.any(
+                FinchAPI::RequestOptions,
+                FinchAPI::Util::AnyHash
+              )
+            ).returns(T.attached_class)
+          end
+          def self.new(request_options: {})
           end
 
           sig { override.returns({request_options: FinchAPI::RequestOptions}) }