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

data/rbi/lib/finch-api/resources/sandbox/employment.rbi

@@ -4,57 +4,76 @@ module FinchAPI
   module Resources
     class Sandbox
       class Employment
+        # Update sandbox employment
         sig do
           params(
             individual_id: String,
             class_code: T.nilable(String),
-            custom_fields: T::Array[FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField],
-            department: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department),
-            employment: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment),
-            employment_status: T.nilable(Symbol),
+            custom_fields: T::Array[T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField, FinchAPI::Util::AnyHash)],
+            department: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, FinchAPI::Util::AnyHash)),
+            employment: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, FinchAPI::Util::AnyHash)),
+            employment_status: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus::OrSymbol),
             end_date: T.nilable(String),
             first_name: T.nilable(String),
-            income: T.nilable(FinchAPI::Models::Income),
-            income_history: T.nilable(T::Array[T.nilable(FinchAPI::Models::Income)]),
+            income: T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash)),
+            income_history: T.nilable(T::Array[T.nilable(T.any(FinchAPI::Models::Income, FinchAPI::Util::AnyHash))]),
             is_active: T.nilable(T::Boolean),
             last_name: T.nilable(String),
             latest_rehire_date: T.nilable(String),
-            location: T.nilable(FinchAPI::Models::Location),
-            manager: T.nilable(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager),
+            location: T.nilable(T.any(FinchAPI::Models::Location, FinchAPI::Util::AnyHash)),
+            manager: T.nilable(T.any(FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, FinchAPI::Util::AnyHash)),
             middle_name: T.nilable(String),
             source_id: String,
             start_date: T.nilable(String),
             title: T.nilable(String),
-            request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))
+            request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))
           )
             .returns(FinchAPI::Models::Sandbox::EmploymentUpdateResponse)
         end
         def update(
           individual_id,
+          # Worker's compensation classification code for this employee
           class_code: nil,
+          # Custom fields for the individual. These are fields which are defined by the
+          #   employer in the system. Custom fields are not currently supported for assisted
+          #   connections.
           custom_fields: nil,
+          # The department object.
           department: nil,
+          # The employment object.
           employment: nil,
+          # The detailed employment status of the individual.
           employment_status: nil,
           end_date: nil,
+          # The legal first name of the individual.
           first_name: nil,
+          # The employee's income as reported by the provider. This may not always be
+          #   annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
+          #   depending on what information the provider returns.
           income: nil,
+          # The array of income history.
           income_history: nil,
+          # `true` if the individual an an active employee or contractor at the company.
           is_active: nil,
+          # The legal last name of the individual.
           last_name: nil,
           latest_rehire_date: nil,
           location: nil,
+          # The manager object representing the manager of the individual within the org.
           manager: nil,
+          # The legal middle name of the individual.
           middle_name: nil,
+          # The source system's unique employment identifier for this individual
           source_id: nil,
           start_date: nil,
+          # The current title of the individual.
           title: nil,
           request_options: {}
         )
         end
 
-        sig { params(client: FinchAPI::Client).void }
-        def initialize(client:)
+        sig { params(client: FinchAPI::Client).returns(T.attached_class) }
+        def self.new(client:)
         end
       end
     end

data/rbi/lib/finch-api/resources/sandbox/individual.rbi

@@ -4,22 +4,27 @@ module FinchAPI
   module Resources
     class Sandbox
       class Individual
+        # Update sandbox individual
         sig do
           params(
             individual_id: String,
             dob: T.nilable(String),
-            emails: T.nilable(T::Array[FinchAPI::Models::Sandbox::IndividualUpdateParams::Email]),
+            emails: T.nilable(
+              T::Array[T.any(FinchAPI::Models::Sandbox::IndividualUpdateParams::Email, FinchAPI::Util::AnyHash)]
+            ),
             encrypted_ssn: T.nilable(String),
-            ethnicity: T.nilable(Symbol),
+            ethnicity: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity::OrSymbol),
             first_name: T.nilable(String),
-            gender: T.nilable(Symbol),
+            gender: T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender::OrSymbol),
             last_name: T.nilable(String),
             middle_name: T.nilable(String),
-            phone_numbers: T.nilable(T::Array[T.nilable(FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber)]),
+            phone_numbers: T.nilable(
+              T::Array[T.nilable(T.any(FinchAPI::Models::Sandbox::IndividualUpdateParams::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),
-            request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))
+            request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))
           )
             .returns(FinchAPI::Models::Sandbox::IndividualUpdateResponse)
         end
@@ -27,22 +32,35 @@ module FinchAPI
           individual_id,
           dob: nil,
           emails: nil,
+          # 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.
           encrypted_ssn: nil,
+          # The EEOC-defined ethnicity of the individual.
           ethnicity: nil,
+          # The legal first name of the individual.
           first_name: nil,
+          # The gender of the individual.
           gender: nil,
+          # The legal last name of the individual.
           last_name: nil,
+          # The legal middle name of the individual.
           middle_name: nil,
           phone_numbers: nil,
+          # The preferred name of the individual.
           preferred_name: nil,
           residence: nil,
+          # 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).
           ssn: nil,
           request_options: {}
         )
         end
 
-        sig { params(client: FinchAPI::Client).void }
-        def initialize(client:)
+        sig { params(client: FinchAPI::Client).returns(T.attached_class) }
+        def self.new(client:)
         end
       end
     end

data/rbi/lib/finch-api/resources/sandbox/jobs/configuration.rbi

@@ -5,26 +5,28 @@ module FinchAPI
     class Sandbox
       class Jobs
         class Configuration
+          # Get configurations for sandbox jobs
           sig do
-            params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything])))
-              .returns(FinchAPI::Models::Sandbox::Jobs::ConfigurationRetrieveResponse)
+            params(request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)))
+              .returns(T::Array[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration])
           end
           def retrieve(request_options: {})
           end
 
+          # Update configurations for sandbox jobs
           sig do
             params(
-              completion_status: Symbol,
-              type: Symbol,
-              request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))
+              completion_status: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus::OrSymbol,
+              type: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type::OrSymbol,
+              request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))
             )
               .returns(FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration)
           end
           def update(completion_status:, type:, request_options: {})
           end
 
-          sig { params(client: FinchAPI::Client).void }
-          def initialize(client:)
+          sig { params(client: FinchAPI::Client).returns(T.attached_class) }
+          def self.new(client:)
           end
         end
       end

data/rbi/lib/finch-api/resources/sandbox/jobs.rbi

@@ -5,21 +5,25 @@ module FinchAPI
     class Sandbox
       class Jobs
         sig { returns(FinchAPI::Resources::Sandbox::Jobs::Configuration) }
-        def configuration
-        end
+        attr_reader :configuration
 
+        # Enqueue a new sandbox job
         sig do
           params(
-            type: Symbol,
-            request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))
+            type: FinchAPI::Models::Sandbox::JobCreateParams::Type::OrSymbol,
+            request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))
           )
             .returns(FinchAPI::Models::Sandbox::JobCreateResponse)
         end
-        def create(type:, request_options: {})
+        def create(
+          # The type of job to start. Currently the only supported type is `data_sync_all`
+          type:,
+          request_options: {}
+        )
         end
 
-        sig { params(client: FinchAPI::Client).void }
-        def initialize(client:)
+        sig { params(client: FinchAPI::Client).returns(T.attached_class) }
+        def self.new(client:)
         end
       end
     end

data/rbi/lib/finch-api/resources/sandbox/payment.rbi

@@ -4,20 +4,21 @@ module FinchAPI
   module Resources
     class Sandbox
       class Payment
+        # Add a new sandbox payment
         sig do
           params(
             end_date: String,
-            pay_statements: T::Array[FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement],
+            pay_statements: T::Array[T.any(FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement, FinchAPI::Util::AnyHash)],
             start_date: String,
-            request_options: T.nilable(T.any(FinchAPI::RequestOptions, T::Hash[Symbol, T.anything]))
+            request_options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))
           )
             .returns(FinchAPI::Models::Sandbox::PaymentCreateResponse)
         end
         def create(end_date: nil, pay_statements: nil, start_date: nil, request_options: {})
         end
 
-        sig { params(client: FinchAPI::Client).void }
-        def initialize(client:)
+        sig { params(client: FinchAPI::Client).returns(T.attached_class) }
+        def self.new(client:)
         end
       end
     end

data/rbi/lib/finch-api/resources/sandbox.rbi

@@ -4,35 +4,28 @@ module FinchAPI
   module Resources
     class Sandbox
       sig { returns(FinchAPI::Resources::Sandbox::Connections) }
-      def connections
-      end
+      attr_reader :connections
 
       sig { returns(FinchAPI::Resources::Sandbox::Company) }
-      def company
-      end
+      attr_reader :company
 
       sig { returns(FinchAPI::Resources::Sandbox::Directory) }
-      def directory
-      end
+      attr_reader :directory
 
       sig { returns(FinchAPI::Resources::Sandbox::Individual) }
-      def individual
-      end
+      attr_reader :individual
 
       sig { returns(FinchAPI::Resources::Sandbox::Employment) }
-      def employment
-      end
+      attr_reader :employment
 
       sig { returns(FinchAPI::Resources::Sandbox::Payment) }
-      def payment
-      end
+      attr_reader :payment
 
       sig { returns(FinchAPI::Resources::Sandbox::Jobs) }
-      def jobs
-      end
+      attr_reader :jobs
 
-      sig { params(client: FinchAPI::Client).void }
-      def initialize(client:)
+      sig { params(client: FinchAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/finch-api/resources/webhooks.rbi

@@ -3,8 +3,8 @@
 module FinchAPI
   module Resources
     class Webhooks
-      sig { params(client: FinchAPI::Client).void }
-      def initialize(client:)
+      sig { params(client: FinchAPI::Client).returns(T.attached_class) }
+      def self.new(client:)
       end
     end
   end

data/rbi/lib/finch-api/responses_page.rbi

@@ -6,24 +6,11 @@ module FinchAPI
 
     Elem = type_member
 
-    sig { returns(T::Array[Elem]) }
-    def responses
-    end
-
-    sig { params(_: T::Array[Elem]).returns(T::Array[Elem]) }
-    def responses=(_)
-    end
+    sig { returns(T.nilable(T::Array[Elem])) }
+    attr_accessor :responses
 
-    sig do
-      params(
-        client: FinchAPI::BaseClient,
-        req: FinchAPI::BaseClient::RequestComponentsShape,
-        headers: T.any(T::Hash[String, String], Net::HTTPHeader),
-        unwrapped: T::Array[T.anything]
-      )
-        .void
-    end
-    def initialize(client:, req:, headers:, unwrapped:)
+    sig { returns(String) }
+    def inspect
     end
   end
 end

data/rbi/lib/finch-api/single_page.rbi

@@ -6,18 +6,6 @@ module FinchAPI
 
     Elem = type_member
 
-    sig do
-      params(
-        client: FinchAPI::BaseClient,
-        req: FinchAPI::BaseClient::RequestComponentsShape,
-        headers: T.any(T::Hash[String, String], Net::HTTPHeader),
-        unwrapped: T::Array[T.anything]
-      )
-        .void
-    end
-    def initialize(client:, req:, headers:, unwrapped:)
-    end
-
     sig { override.returns(T::Boolean) }
     def next_page?
     end
@@ -29,5 +17,9 @@ module FinchAPI
     sig { override.params(blk: T.proc.params(arg0: Elem).void).void }
     def auto_paging_each(&blk)
     end
+
+    sig { returns(String) }
+    def inspect
+    end
   end
 end