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

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Resources
+    class Sandbox
+      class Company
+        # Some parameter documentations has been truncated, see
+        # {FinchAPI::Models::Sandbox::CompanyUpdateParams} for more details.
+        #
+        # Update a sandbox company's data
+        #
+        # @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 departments [Array<FinchAPI::Models::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 legal_name [String, nil] The legal name of the company.
+        #
+        # @param locations [Array<FinchAPI::Models::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]
+        #
+        # @return [FinchAPI::Models::Sandbox::CompanyUpdateResponse]
+        #
+        # @see FinchAPI::Models::Sandbox::CompanyUpdateParams
+        def update(params)
+          parsed, options = FinchAPI::Models::Sandbox::CompanyUpdateParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: "sandbox/company",
+            body: parsed,
+            model: FinchAPI::Models::Sandbox::CompanyUpdateResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [FinchAPI::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Resources
+    class Sandbox
+      class Connections
+        class Accounts
+          # Some parameter documentations has been truncated, see
+          # {FinchAPI::Models::Sandbox::Connections::AccountCreateParams} for more details.
+          #
+          # Create a new account for an existing connection (company/provider pair)
+          #
+          # @overload create(company_id:, provider_id:, authentication_type: nil, products: nil, request_options: {})
+          #
+          # @param company_id [String]
+          #
+          # @param provider_id [String] The provider associated with the `access_token`
+          #
+          # @param authentication_type [Symbol, FinchAPI::Models::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]
+          #
+          # @return [FinchAPI::Models::Sandbox::Connections::AccountCreateResponse]
+          #
+          # @see FinchAPI::Models::Sandbox::Connections::AccountCreateParams
+          def create(params)
+            parsed, options = FinchAPI::Models::Sandbox::Connections::AccountCreateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "sandbox/connections/accounts",
+              body: parsed,
+              model: FinchAPI::Models::Sandbox::Connections::AccountCreateResponse,
+              options: options
+            )
+          end
+
+          # Update an existing sandbox account. Change the connection status to understand
+          # how the Finch API responds.
+          #
+          # @overload update(connection_status: nil, request_options: {})
+          #
+          # @param connection_status [Symbol, FinchAPI::Models::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)
+            @client.request(
+              method: :put,
+              path: "sandbox/connections/accounts",
+              body: parsed,
+              model: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [FinchAPI::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Resources
+    class Sandbox
+      class Connections
+        # @return [FinchAPI::Resources::Sandbox::Connections::Accounts]
+        attr_reader :accounts
+
+        # Some parameter documentations has been truncated, see
+        # {FinchAPI::Models::Sandbox::ConnectionCreateParams} for more details.
+        #
+        # Create a new connection (new company/provider pair) with a new account
+        #
+        # @overload create(provider_id:, authentication_type: nil, employee_size: nil, products: nil, request_options: {})
+        #
+        # @param provider_id [String] The provider associated with the connection
+        #
+        # @param authentication_type [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateParams::AuthenticationType]
+        #
+        # @param employee_size [Integer] Optional: the size of the employer to be created with this connection. Defaults
+        # ...
+        #
+        # @param products [Array<String>]
+        #
+        # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [FinchAPI::Models::Sandbox::ConnectionCreateResponse]
+        #
+        # @see FinchAPI::Models::Sandbox::ConnectionCreateParams
+        def create(params)
+          parsed, options = FinchAPI::Models::Sandbox::ConnectionCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "sandbox/connections",
+            body: parsed,
+            model: FinchAPI::Models::Sandbox::ConnectionCreateResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [FinchAPI::Client]
+        def initialize(client:)
+          @client = client
+          @accounts = FinchAPI::Resources::Sandbox::Connections::Accounts.new(client: client)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Resources
+    class Sandbox
+      class Directory
+        # Some parameter documentations has been truncated, see
+        # {FinchAPI::Models::Sandbox::DirectoryCreateParams} for more details.
+        #
+        # Add new individuals to a sandbox company
+        #
+        # @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 request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Object>]
+        #
+        # @see FinchAPI::Models::Sandbox::DirectoryCreateParams
+        def create(params = {})
+          parsed, options = FinchAPI::Models::Sandbox::DirectoryCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "sandbox/directory",
+            body: parsed[:body],
+            model: FinchAPI::Internal::Type::ArrayOf[FinchAPI::Internal::Type::Unknown],
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [FinchAPI::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Resources
+    class Sandbox
+      class Employment
+        # Some parameter documentations has been truncated, see
+        # {FinchAPI::Models::Sandbox::EmploymentUpdateParams} for more details.
+        #
+        # Update sandbox employment
+        #
+        # @overload update(individual_id, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, income: nil, income_history: nil, is_active: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, source_id: nil, start_date: nil, title: nil, request_options: {})
+        #
+        # @param individual_id [String]
+        #
+        # @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 department [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Department, nil] The department object.
+        #
+        # @param employment [FinchAPI::Models::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 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_history [Array<FinchAPI::Models::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.
+        #
+        # @param last_name [String, nil] The legal last name of the individual.
+        #
+        # @param latest_rehire_date [String, nil]
+        #
+        # @param location [FinchAPI::Models::Location, nil]
+        #
+        # @param manager [FinchAPI::Models::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.
+        #
+        # @param source_id [String] The source system's unique employment identifier for this individual
+        #
+        # @param start_date [String, nil]
+        #
+        # @param title [String, nil] The current title of the individual.
+        #
+        # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [FinchAPI::Models::Sandbox::EmploymentUpdateResponse]
+        #
+        # @see FinchAPI::Models::Sandbox::EmploymentUpdateParams
+        def update(individual_id, params = {})
+          parsed, options = FinchAPI::Models::Sandbox::EmploymentUpdateParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: ["sandbox/employment/%1$s", individual_id],
+            body: parsed,
+            model: FinchAPI::Models::Sandbox::EmploymentUpdateResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [FinchAPI::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Resources
+    class Sandbox
+      class Individual
+        # Some parameter documentations has been truncated, see
+        # {FinchAPI::Models::Sandbox::IndividualUpdateParams} for more details.
+        #
+        # Update sandbox individual
+        #
+        # @overload update(individual_id, 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, request_options: {})
+        #
+        # @param individual_id [String]
+        #
+        # @param dob [String, nil]
+        #
+        # @param emails [Array<FinchAPI::Models::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 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 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 preferred_name [String, nil] The preferred name of the individual.
+        #
+        # @param residence [FinchAPI::Models::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]
+        #
+        # @return [FinchAPI::Models::Sandbox::IndividualUpdateResponse]
+        #
+        # @see FinchAPI::Models::Sandbox::IndividualUpdateParams
+        def update(individual_id, params = {})
+          parsed, options = FinchAPI::Models::Sandbox::IndividualUpdateParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: ["sandbox/individual/%1$s", individual_id],
+            body: parsed,
+            model: FinchAPI::Models::Sandbox::IndividualUpdateResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [FinchAPI::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Resources
+    class Sandbox
+      class Jobs
+        class Configuration
+          # Get configurations for sandbox jobs
+          #
+          # @overload retrieve(request_options: {})
+          #
+          # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Array<FinchAPI::Models::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],
+              options: params[:request_options]
+            )
+          end
+
+          # Update configurations for sandbox jobs
+          #
+          # @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 request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration]
+          #
+          # @see FinchAPI::Models::Sandbox::Jobs::ConfigurationUpdateParams
+          def update(params)
+            parsed, options = FinchAPI::Models::Sandbox::Jobs::ConfigurationUpdateParams.dump_request(params)
+            @client.request(
+              method: :put,
+              path: "sandbox/jobs/configuration",
+              body: parsed,
+              model: FinchAPI::Models::Sandbox::Jobs::SandboxJobConfiguration,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [FinchAPI::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Resources
+    class Sandbox
+      class Jobs
+        # @return [FinchAPI::Resources::Sandbox::Jobs::Configuration]
+        attr_reader :configuration
+
+        # Enqueue a new sandbox job
+        #
+        # @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 request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [FinchAPI::Models::Sandbox::JobCreateResponse]
+        #
+        # @see FinchAPI::Models::Sandbox::JobCreateParams
+        def create(params)
+          parsed, options = FinchAPI::Models::Sandbox::JobCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "sandbox/jobs",
+            body: parsed,
+            model: FinchAPI::Models::Sandbox::JobCreateResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [FinchAPI::Client]
+        def initialize(client:)
+          @client = client
+          @configuration = FinchAPI::Resources::Sandbox::Jobs::Configuration.new(client: client)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Resources
+    class Sandbox
+      class Payment
+        # Add a new sandbox payment
+        #
+        # @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 start_date [String]
+        # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [FinchAPI::Models::Sandbox::PaymentCreateResponse]
+        #
+        # @see FinchAPI::Models::Sandbox::PaymentCreateParams
+        def create(params = {})
+          parsed, options = FinchAPI::Models::Sandbox::PaymentCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "sandbox/payment",
+            body: parsed,
+            model: FinchAPI::Models::Sandbox::PaymentCreateResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [FinchAPI::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/finch_api/resources/sandbox.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Resources
+    class Sandbox
+      # @return [FinchAPI::Resources::Sandbox::Connections]
+      attr_reader :connections
+
+      # @return [FinchAPI::Resources::Sandbox::Company]
+      attr_reader :company
+
+      # @return [FinchAPI::Resources::Sandbox::Directory]
+      attr_reader :directory
+
+      # @return [FinchAPI::Resources::Sandbox::Individual]
+      attr_reader :individual
+
+      # @return [FinchAPI::Resources::Sandbox::Employment]
+      attr_reader :employment
+
+      # @return [FinchAPI::Resources::Sandbox::Payment]
+      attr_reader :payment
+
+      # @return [FinchAPI::Resources::Sandbox::Jobs]
+      attr_reader :jobs
+
+      # @api private
+      #
+      # @param client [FinchAPI::Client]
+      def initialize(client:)
+        @client = client
+        @connections = FinchAPI::Resources::Sandbox::Connections.new(client: client)
+        @company = FinchAPI::Resources::Sandbox::Company.new(client: client)
+        @directory = FinchAPI::Resources::Sandbox::Directory.new(client: client)
+        @individual = FinchAPI::Resources::Sandbox::Individual.new(client: client)
+        @employment = FinchAPI::Resources::Sandbox::Employment.new(client: client)
+        @payment = FinchAPI::Resources::Sandbox::Payment.new(client: client)
+        @jobs = FinchAPI::Resources::Sandbox::Jobs.new(client: client)
+      end
+    end
+  end
+end

data/lib/finch_api/resources/webhooks.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Resources
+    class Webhooks
+      # @api private
+      #
+      # @param client [FinchAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/finch_api/version.rb

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