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

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

@@ -1,292 +0,0 @@
-# typed: strong
-
-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)) }
-        attr_reader :id
-
-        sig { params(id: String).void }
-        attr_writer :id
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :dob
-
-        sig { returns(T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email])) }
-        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)) }
-        attr_accessor :encrypted_ssn
-
-        # 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)) }
-        attr_accessor :first_name
-
-        # 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)) }
-        attr_accessor :last_name
-
-        # The legal middle name of the individual.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :middle_name
-
-        sig { returns(T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber)])) }
-        attr_accessor :phone_numbers
-
-        # The preferred name of the individual.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :preferred_name
-
-        sig { returns(T.nilable(FinchAPI::Models::Location)) }
-        attr_reader :residence
-
-        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)) }
-        attr_accessor :ssn
-
-        sig do
-          params(
-            id: String,
-            dob: T.nilable(String),
-            emails: T.nilable(
-              T::Array[T.any(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email, FinchAPI::Util::AnyHash)]
-            ),
-            encrypted_ssn: T.nilable(String),
-            ethnicity: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::OrSymbol),
-            first_name: T.nilable(String),
-            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(
-                T.any(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber, FinchAPI::Util::AnyHash)
-              )
-              ]
-            ),
-            preferred_name: T.nilable(String),
-            residence: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)),
-            ssn: T.nilable(String)
-          )
-            .returns(T.attached_class)
-        end
-        def self.new(
-          id: nil,
-          dob: nil,
-          emails: nil,
-          encrypted_ssn: nil,
-          ethnicity: nil,
-          first_name: nil,
-          gender: nil,
-          last_name: nil,
-          middle_name: nil,
-          phone_numbers: nil,
-          preferred_name: nil,
-          residence: nil,
-          ssn: nil
-        )
-        end
-
-        sig do
-          override
-            .returns(
-              {
-                id: String,
-                dob: T.nilable(String),
-                emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email]),
-                encrypted_ssn: T.nilable(String),
-                ethnicity: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Ethnicity::TaggedSymbol),
-                first_name: T.nilable(String),
-                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)]),
-                preferred_name: T.nilable(String),
-                residence: T.nilable(FinchAPI::Models::Location),
-                ssn: T.nilable(String)
-              }
-            )
-        end
-        def to_hash
-        end
-
-        class Email < FinchAPI::BaseModel
-          sig { returns(T.nilable(String)) }
-          attr_reader :data
-
-          sig { params(data: String).void }
-          attr_writer :data
-
-          sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol)) }
-          attr_accessor :type
-
-          sig do
-            params(
-              data: String,
-              type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::OrSymbol)
-            )
-              .returns(T.attached_class)
-          end
-          def self.new(data: nil, type: nil)
-          end
-
-          sig do
-            override
-              .returns(
-                {
-                  data: String,
-                  type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol)
-                }
-              )
-          end
-          def to_hash
-          end
-
-          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, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol)
-            PERSONAL =
-              T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol)
-
-            sig { override.returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Email::Type::TaggedSymbol]) }
-            def self.values
-            end
-          end
-        end
-
-        # The EEOC-defined ethnicity of the individual.
-        module Ethnicity
-          extend FinchAPI::Enum
-
-          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) }
-
-          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
-
-        # 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, 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[FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol]) }
-          def self.values
-          end
-        end
-
-        class PhoneNumber < FinchAPI::BaseModel
-          sig { returns(T.nilable(String)) }
-          attr_accessor :data
-
-          sig { returns(T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol)) }
-          attr_accessor :type
-
-          sig do
-            params(
-              data: T.nilable(String),
-              type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::OrSymbol)
-            )
-              .returns(T.attached_class)
-          end
-          def self.new(data: nil, type: nil)
-          end
-
-          sig do
-            override
-              .returns(
-                {
-                  data: T.nilable(String),
-                  type: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol)
-                }
-              )
-          end
-          def to_hash
-          end
-
-          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, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol)
-            PERSONAL =
-              T.let(:personal, FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol)
-
-            sig do
-              override
-                .returns(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateResponse::PhoneNumber::Type::TaggedSymbol])
-            end
-            def self.values
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,49 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module Sandbox
-      class JobCreateParams < FinchAPI::BaseModel
-        extend FinchAPI::Type::RequestParameters::Converter
-        include FinchAPI::RequestParameters
-
-        # 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: FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol,
-            request_options: T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)
-          )
-            .returns(T.attached_class)
-        end
-        def self.new(type:, request_options: {})
-        end
-
-        sig do
-          override
-            .returns(
-              {type: FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol, request_options: FinchAPI::RequestOptions}
-            )
-        end
-        def to_hash
-        end
-
-        # 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 = T.let(:data_sync_all, FinchAPI::Models::Sandbox::JobCreateParams::Type::TaggedSymbol)
-
-          sig { override.returns(T::Array[FinchAPI::Models::Sandbox::JobCreateParams::Type::TaggedSymbol]) }
-          def self.values
-          end
-        end
-      end
-    end
-  end
-end

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

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

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

@@ -1,29 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module Sandbox
-      module Jobs
-        class ConfigurationRetrieveParams < FinchAPI::BaseModel
-          extend FinchAPI::Type::RequestParameters::Converter
-          include FinchAPI::RequestParameters
-
-          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}) }
-          def to_hash
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module Sandbox
-      module Jobs
-        ConfigurationRetrieveResponse =
-          T.let(
-            FinchAPI::ArrayOf[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration],
-            FinchAPI::Type::Converter
-          )
-      end
-    end
-  end
-end

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

@@ -1,29 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module Sandbox
-      module Jobs
-        class ConfigurationUpdateParams < FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration
-          extend FinchAPI::Type::RequestParameters::Converter
-          include FinchAPI::RequestParameters
-
-          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}) }
-          def to_hash
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,88 +0,0 @@
-# typed: strong
-
-module FinchAPI
-  module Models
-    module Sandbox
-      module Jobs
-        class SandboxJobConfiguration < FinchAPI::BaseModel
-          sig { returns(FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol) }
-          attr_accessor :completion_status
-
-          sig { returns(FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol) }
-          attr_accessor :type
-
-          sig do
-            params(
-              completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::OrSymbol,
-              type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::OrSymbol
-            )
-              .returns(T.attached_class)
-          end
-          def self.new(completion_status:, type:)
-          end
-
-          sig do
-            override
-              .returns(
-                {
-                  completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol,
-                  type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol
-                }
-              )
-          end
-          def to_hash
-          end
-
-          module CompletionStatus
-            extend FinchAPI::Enum
-
-            TaggedSymbol =
-              T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus) }
-            OrSymbol =
-              T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol) }
-
-            COMPLETE =
-              T.let(:complete, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol)
-            REAUTH_ERROR =
-              T.let(
-                :reauth_error,
-                FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol
-              )
-            PERMISSIONS_ERROR =
-              T.let(
-                :permissions_error,
-                FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol
-              )
-            ERROR =
-              T.let(:error, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol)
-
-            sig do
-              override
-                .returns(
-                  T::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::TaggedSymbol]
-                )
-            end
-            def self.values
-            end
-          end
-
-          module Type
-            extend FinchAPI::Enum
-
-            TaggedSymbol =
-              T.type_alias { T.all(Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type) }
-            OrSymbol =
-              T.type_alias { T.any(Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol) }
-
-            DATA_SYNC_ALL =
-              T.let(:data_sync_all, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol)
-
-            sig { override.returns(T::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::TaggedSymbol]) }
-            def self.values
-            end
-          end
-        end
-      end
-    end
-  end
-end