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

data/lib/finch_api/resources/sandbox/company.rb

@@ -11,22 +11,21 @@ module FinchAPI
         #
         # @overload update(accounts:, departments:, ein:, entity:, legal_name:, locations:, primary_email:, primary_phone_number:, request_options: {})
         #
-        # @param accounts [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Account>, nil] An array of bank account objects associated with the payroll/HRIS system.
+        # @param accounts [Array<FinchAPI::Sandbox::CompanyUpdateParams::Account>, nil] An array of bank account objects associated with the payroll/HRIS system.
         #
-        # @param departments [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Department, nil>, nil] The array of company departments.
+        # @param departments [Array<FinchAPI::Sandbox::CompanyUpdateParams::Department, nil>, nil] The array of company departments.
         #
         # @param ein [String, nil] The employer identification number.
         #
-        # @param entity [FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, nil] The entity type object.
+        # @param entity [FinchAPI::Sandbox::CompanyUpdateParams::Entity, nil] The entity type object.
         #
         # @param legal_name [String, nil] The legal name of the company.
         #
-        # @param locations [Array<FinchAPI::Models::Location, nil>, nil]
+        # @param locations [Array<FinchAPI::Location, nil>, nil]
         #
         # @param primary_email [String, nil] The email of the main administrator on the account.
         #
         # @param primary_phone_number [String, nil] The phone number of the main administrator on the account. Format: E.164, with e
-        # ...
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -34,7 +33,7 @@ module FinchAPI
         #
         # @see FinchAPI::Models::Sandbox::CompanyUpdateParams
         def update(params)
-          parsed, options = FinchAPI::Models::Sandbox::CompanyUpdateParams.dump_request(params)
+          parsed, options = FinchAPI::Sandbox::CompanyUpdateParams.dump_request(params)
           @client.request(
             method: :put,
             path: "sandbox/company",

data/lib/finch_api/resources/sandbox/connections/accounts.rb

@@ -16,10 +16,9 @@ module FinchAPI
           #
           # @param provider_id [String] The provider associated with the `access_token`
           #
-          # @param authentication_type [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType]
+          # @param authentication_type [Symbol, FinchAPI::Sandbox::Connections::AccountCreateParams::AuthenticationType]
           #
           # @param products [Array<String>] Optional, defaults to Organization products (`company`, `directory`, `employment
-          # ...
           #
           # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -27,7 +26,7 @@ module FinchAPI
           #
           # @see FinchAPI::Models::Sandbox::Connections::AccountCreateParams
           def create(params)
-            parsed, options = FinchAPI::Models::Sandbox::Connections::AccountCreateParams.dump_request(params)
+            parsed, options = FinchAPI::Sandbox::Connections::AccountCreateParams.dump_request(params)
             @client.request(
               method: :post,
               path: "sandbox/connections/accounts",
@@ -42,14 +41,14 @@ module FinchAPI
           #
           # @overload update(connection_status: nil, request_options: {})
           #
-          # @param connection_status [Symbol, FinchAPI::Models::ConnectionStatusType]
+          # @param connection_status [Symbol, FinchAPI::ConnectionStatusType]
           # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse]
           #
           # @see FinchAPI::Models::Sandbox::Connections::AccountUpdateParams
           def update(params = {})
-            parsed, options = FinchAPI::Models::Sandbox::Connections::AccountUpdateParams.dump_request(params)
+            parsed, options = FinchAPI::Sandbox::Connections::AccountUpdateParams.dump_request(params)
             @client.request(
               method: :put,
               path: "sandbox/connections/accounts",

data/lib/finch_api/resources/sandbox/connections.rb

@@ -16,10 +16,9 @@ module FinchAPI
         #
         # @param provider_id [String] The provider associated with the connection
         #
-        # @param authentication_type [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType]
+        # @param authentication_type [Symbol, FinchAPI::Sandbox::ConnectionCreateParams::AuthenticationType]
         #
         # @param employee_size [Integer] Optional: the size of the employer to be created with this connection. Defaults
-        # ...
         #
         # @param products [Array<String>]
         #
@@ -29,7 +28,7 @@ module FinchAPI
         #
         # @see FinchAPI::Models::Sandbox::ConnectionCreateParams
         def create(params)
-          parsed, options = FinchAPI::Models::Sandbox::ConnectionCreateParams.dump_request(params)
+          parsed, options = FinchAPI::Sandbox::ConnectionCreateParams.dump_request(params)
           @client.request(
             method: :post,
             path: "sandbox/connections",

data/lib/finch_api/resources/sandbox/directory.rb

@@ -11,8 +11,7 @@ module FinchAPI
         #
         # @overload create(body: nil, request_options: {})
         #
-        # @param body [Array<FinchAPI::Models::Sandbox::DirectoryCreateParams::Body>] Array of individuals to create. Takes all combined fields from `/individual` and
-        # ...
+        # @param body [Array<FinchAPI::Sandbox::DirectoryCreateParams::Body>] Array of individuals to create. Takes all combined fields from `/individual` and
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -20,7 +19,7 @@ module FinchAPI
         #
         # @see FinchAPI::Models::Sandbox::DirectoryCreateParams
         def create(params = {})
-          parsed, options = FinchAPI::Models::Sandbox::DirectoryCreateParams.dump_request(params)
+          parsed, options = FinchAPI::Sandbox::DirectoryCreateParams.dump_request(params)
           @client.request(
             method: :post,
             path: "sandbox/directory",

data/lib/finch_api/resources/sandbox/employment.rb

@@ -15,23 +15,21 @@ module FinchAPI
         #
         # @param class_code [String, nil] Worker's compensation classification code for this employee
         #
-        # @param custom_fields [Array<FinchAPI::Models::Sandbox::EmploymentUpdateParams::CustomField>] Custom fields for the individual. These are fields which are defined by the empl
-        # ...
+        # @param custom_fields [Array<FinchAPI::Sandbox::EmploymentUpdateParams::CustomField>] Custom fields for the individual. These are fields which are defined by the empl
         #
-        # @param department [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, nil] The department object.
+        # @param department [FinchAPI::Sandbox::EmploymentUpdateParams::Department, nil] The department object.
         #
-        # @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
+        # @param employment [FinchAPI::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
         #
-        # @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual.
+        # @param employment_status [Symbol, FinchAPI::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual.
         #
         # @param end_date [String, nil]
         #
         # @param first_name [String, nil] The legal first name of the individual.
         #
-        # @param income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual
-        # ...
+        # @param income [FinchAPI::Income, nil] The employee's income as reported by the provider. This may not always be annual
         #
-        # @param income_history [Array<FinchAPI::Models::Income, nil>, nil] The array of income history.
+        # @param income_history [Array<FinchAPI::Income, nil>, nil] The array of income history.
         #
         # @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company.
         #
@@ -39,9 +37,9 @@ module FinchAPI
         #
         # @param latest_rehire_date [String, nil]
         #
-        # @param location [FinchAPI::Models::Location, nil]
+        # @param location [FinchAPI::Location, nil]
         #
-        # @param manager [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Manager, nil] The manager object representing the manager of the individual within the org.
+        # @param manager [FinchAPI::Sandbox::EmploymentUpdateParams::Manager, nil] The manager object representing the manager of the individual within the org.
         #
         # @param middle_name [String, nil] The legal middle name of the individual.
         #
@@ -57,7 +55,7 @@ module FinchAPI
         #
         # @see FinchAPI::Models::Sandbox::EmploymentUpdateParams
         def update(individual_id, params = {})
-          parsed, options = FinchAPI::Models::Sandbox::EmploymentUpdateParams.dump_request(params)
+          parsed, options = FinchAPI::Sandbox::EmploymentUpdateParams.dump_request(params)
           @client.request(
             method: :put,
             path: ["sandbox/employment/%1$s", individual_id],

data/lib/finch_api/resources/sandbox/individual.rb

@@ -15,29 +15,27 @@ module FinchAPI
         #
         # @param dob [String, nil]
         #
-        # @param emails [Array<FinchAPI::Models::Sandbox::IndividualUpdateParams::Email>, nil]
+        # @param emails [Array<FinchAPI::Sandbox::IndividualUpdateParams::Email>, nil]
         #
         # @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is
-        # ...
         #
-        # @param ethnicity [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity, nil] The EEOC-defined ethnicity of the individual.
+        # @param ethnicity [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Ethnicity, nil] The EEOC-defined ethnicity of the individual.
         #
         # @param first_name [String, nil] The legal first name of the individual.
         #
-        # @param gender [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender, nil] The gender of the individual.
+        # @param gender [Symbol, FinchAPI::Sandbox::IndividualUpdateParams::Gender, nil] The gender of the individual.
         #
         # @param last_name [String, nil] The legal last name of the individual.
         #
         # @param middle_name [String, nil] The legal middle name of the individual.
         #
-        # @param phone_numbers [Array<FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber, nil>, nil]
+        # @param phone_numbers [Array<FinchAPI::Sandbox::IndividualUpdateParams::PhoneNumber, nil>, nil]
         #
         # @param preferred_name [String, nil] The preferred name of the individual.
         #
-        # @param residence [FinchAPI::Models::Location, nil]
+        # @param residence [FinchAPI::Location, nil]
         #
         # @param ssn [String, nil] Social Security Number of the individual. This field is only available with the
-        # ...
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -45,7 +43,7 @@ module FinchAPI
         #
         # @see FinchAPI::Models::Sandbox::IndividualUpdateParams
         def update(individual_id, params = {})
-          parsed, options = FinchAPI::Models::Sandbox::IndividualUpdateParams.dump_request(params)
+          parsed, options = FinchAPI::Sandbox::IndividualUpdateParams.dump_request(params)
           @client.request(
             method: :put,
             path: ["sandbox/individual/%1$s", individual_id],

data/lib/finch_api/resources/sandbox/jobs/configuration.rb

@@ -11,14 +11,14 @@ module FinchAPI
           #
           # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [Array<FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration>]
+          # @return [Array<FinchAPI::Sandbox::Jobs::SandboxJobConfiguration>]
           #
           # @see FinchAPI::Models::Sandbox::Jobs::ConfigurationRetrieveParams
           def retrieve(params = {})
             @client.request(
               method: :get,
               path: "sandbox/jobs/configuration",
-              model: FinchAPI::Internal::Type::ArrayOf[FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration],
+              model: FinchAPI::Internal::Type::ArrayOf[FinchAPI::Sandbox::Jobs::SandboxJobConfiguration],
               options: params[:request_options]
             )
           end
@@ -27,20 +27,20 @@ module FinchAPI
           #
           # @overload update(completion_status:, type:, request_options: {})
           #
-          # @param completion_status [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus]
-          # @param type [Symbol, FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration::Type]
+          # @param completion_status [Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::CompletionStatus]
+          # @param type [Symbol, FinchAPI::Sandbox::Jobs::SandboxJobConfiguration::Type]
           # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration]
+          # @return [FinchAPI::Sandbox::Jobs::SandboxJobConfiguration]
           #
           # @see FinchAPI::Models::Sandbox::Jobs::ConfigurationUpdateParams
           def update(params)
-            parsed, options = FinchAPI::Models::Sandbox::Jobs::ConfigurationUpdateParams.dump_request(params)
+            parsed, options = FinchAPI::Sandbox::Jobs::ConfigurationUpdateParams.dump_request(params)
             @client.request(
               method: :put,
               path: "sandbox/jobs/configuration",
               body: parsed,
-              model: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration,
+              model: FinchAPI::Sandbox::Jobs::SandboxJobConfiguration,
               options: options
             )
           end

data/lib/finch_api/resources/sandbox/jobs.rb

@@ -11,7 +11,7 @@ module FinchAPI
         #
         # @overload create(type:, request_options: {})
         #
-        # @param type [Symbol, FinchAPI::Models::Sandbox::JobCreateParams::Type] The type of job to start. Currently the only supported type is `data_sync_all`
+        # @param type [Symbol, FinchAPI::Sandbox::JobCreateParams::Type] The type of job to start. Currently the only supported type is `data_sync_all`
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -19,7 +19,7 @@ module FinchAPI
         #
         # @see FinchAPI::Models::Sandbox::JobCreateParams
         def create(params)
-          parsed, options = FinchAPI::Models::Sandbox::JobCreateParams.dump_request(params)
+          parsed, options = FinchAPI::Sandbox::JobCreateParams.dump_request(params)
           @client.request(
             method: :post,
             path: "sandbox/jobs",

data/lib/finch_api/resources/sandbox/payment.rb

@@ -9,7 +9,7 @@ module FinchAPI
         # @overload create(end_date: nil, pay_statements: nil, start_date: nil, request_options: {})
         #
         # @param end_date [String]
-        # @param pay_statements [Array<FinchAPI::Models::Sandbox::PaymentCreateParams::PayStatement>]
+        # @param pay_statements [Array<FinchAPI::Sandbox::PaymentCreateParams::PayStatement>]
         # @param start_date [String]
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -17,7 +17,7 @@ module FinchAPI
         #
         # @see FinchAPI::Models::Sandbox::PaymentCreateParams
         def create(params = {})
-          parsed, options = FinchAPI::Models::Sandbox::PaymentCreateParams.dump_request(params)
+          parsed, options = FinchAPI::Sandbox::PaymentCreateParams.dump_request(params)
           @client.request(
             method: :post,
             path: "sandbox/payment",

data/lib/finch_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FinchAPI
-  VERSION = "0.1.0.pre.alpha.13"
+  VERSION = "0.1.0.pre.alpha.14"
 end

data/lib/finch_api.rb

@@ -174,6 +174,7 @@ require_relative "finch_api/models/sandbox/jobs/configuration_update_params"
 require_relative "finch_api/models/sandbox/payment_create_params"
 require_relative "finch_api/models/sandbox/payment_create_response"
 require_relative "finch_api/models/webhook_event"
+require_relative "finch_api/models"
 require_relative "finch_api/resources/access_tokens"
 require_relative "finch_api/resources/account"
 require_relative "finch_api/resources/connect"

data/rbi/finch_api/client.rbi

@@ -51,15 +51,18 @@ module FinchAPI
 
     # @api private
     sig { override.returns(T::Hash[String, String]) }
-    private def auth_headers; end
+    private def auth_headers
+    end
 
     # @api private
     sig { returns(T::Hash[String, String]) }
-    private def bearer_auth; end
+    private def bearer_auth
+    end
 
     # @api private
     sig { returns(T::Hash[String, String]) }
-    private def basic_auth; end
+    private def basic_auth
+    end
 
     # Creates and returns a new client for interacting with the API.
     sig do
@@ -72,8 +75,7 @@ module FinchAPI
         timeout: Float,
         initial_retry_delay: Float,
         max_retry_delay: Float
-      )
-        .returns(T.attached_class)
+      ).returns(T.attached_class)
     end
     def self.new(
       # Defaults to `ENV["FINCH_CLIENT_ID"]`
@@ -89,6 +91,7 @@ module FinchAPI
       timeout: FinchAPI::Client::DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: FinchAPI::Client::DEFAULT_INITIAL_RETRY_DELAY,
       max_retry_delay: FinchAPI::Client::DEFAULT_MAX_RETRY_DELAY
-    ); end
+    )
+    end
   end
 end

data/rbi/finch_api/errors.rbi

@@ -29,10 +29,17 @@ module FinchAPI
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: nil
+      )
       end
-      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil); end
     end
 
     class APIConnectionError < FinchAPI::Errors::APIError
@@ -51,10 +58,16 @@ module FinchAPI
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
-      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.")
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
       end
     end
 
@@ -68,10 +81,16 @@ module FinchAPI
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
-      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.")
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
       end
     end
 
@@ -85,10 +104,10 @@ module FinchAPI
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
+      end
+      def self.for(url:, status:, body:, request:, response:, message: nil)
       end
-      def self.for(url:, status:, body:, request:, response:, message: nil); end
 
       sig { returns(Integer) }
       attr_accessor :status
@@ -102,10 +121,10 @@ module FinchAPI
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
+      end
+      def self.new(url:, status:, body:, request:, response:, message: nil)
       end
-      def self.new(url:, status:, body:, request:, response:, message: nil); end
     end
 
     class BadRequestError < FinchAPI::Errors::APIStatusError

data/rbi/finch_api/file_part.rbi

@@ -13,22 +13,25 @@ module FinchAPI
 
     # @api private
     sig { returns(String) }
-    private def read; end
+    private def read
+    end
 
     sig { params(a: T.anything).returns(String) }
-    def to_json(*a); end
+    def to_json(*a)
+    end
 
     sig { params(a: T.anything).returns(String) }
-    def to_yaml(*a); end
+    def to_yaml(*a)
+    end
 
     sig do
       params(
         content: T.any(Pathname, StringIO, IO, String),
         filename: T.nilable(String),
         content_type: T.nilable(String)
-      )
-        .returns(T.attached_class)
+      ).returns(T.attached_class)
+    end
+    def self.new(content, filename: nil, content_type: nil)
     end
-    def self.new(content, filename: nil, content_type: nil); end
   end
 end

data/rbi/finch_api/internal/individuals_page.rbi

@@ -10,12 +10,13 @@ module FinchAPI
       sig { returns(T.nilable(T::Array[Elem])) }
       attr_accessor :individuals
 
-      sig { returns(FinchAPI::Models::Paging) }
+      sig { returns(FinchAPI::Paging) }
       attr_accessor :paging
 
       # @api private
       sig { returns(String) }
-      def inspect; end
+      def inspect
+      end
     end
   end
 end

data/rbi/finch_api/internal/page.rbi

@@ -10,12 +10,13 @@ module FinchAPI
       sig { returns(T.nilable(T::Array[Elem])) }
       attr_accessor :data
 
-      sig { returns(FinchAPI::Models::Paging) }
+      sig { returns(FinchAPI::Paging) }
       attr_accessor :paging
 
       # @api private
       sig { returns(String) }
-      def inspect; end
+      def inspect
+      end
     end
   end
 end

data/rbi/finch_api/internal/responses_page.rbi

@@ -12,7 +12,8 @@ module FinchAPI
 
       # @api private
       sig { returns(String) }
-      def inspect; end
+      def inspect
+      end
     end
   end
 end

data/rbi/finch_api/internal/single_page.rbi

@@ -8,17 +8,21 @@ module FinchAPI
       Elem = type_member
 
       sig { override.returns(T::Boolean) }
-      def next_page?; end
+      def next_page?
+      end
 
       sig { override.returns(T.self_type) }
-      def next_page; end
+      def next_page
+      end
 
       sig { override.params(blk: T.proc.params(arg0: Elem).void).void }
-      def auto_paging_each(&blk); end
+      def auto_paging_each(&blk)
+      end
 
       # @api private
       sig { returns(String) }
-      def inspect; end
+      def inspect
+      end
     end
   end
 end