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

data/lib/finch-api/resources/hris/documents.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Resources
-    class HRIS
-      class Documents
-        # **Beta:** This endpoint is in beta and may change. Retrieve a list of
-        #   company-wide documents.
-        #
-        # @param params [FinchAPI::Models::HRIS::DocumentListParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Array<String>] :individual_ids Comma-delimited list of stable Finch uuids for each individual. If empty,
-        #     defaults to all individuals
-        #
-        #   @option params [Integer] :limit Number of documents to return (defaults to all)
-        #
-        #   @option params [Integer] :offset Index to start from (defaults to 0)
-        #
-        #   @option params [Array<Symbol, FinchAPI::Models::HRIS::DocumentListParams::Type>] :types Comma-delimited list of document types to filter on. If empty, defaults to all
-        #     types
-        #
-        #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [FinchAPI::Models::HRIS::DocumentListResponse]
-        def list(params = {})
-          parsed, options = FinchAPI::Models::HRIS::DocumentListParams.dump_request(params)
-          @client.request(
-            method: :get,
-            path: "employer/documents",
-            query: parsed,
-            model: FinchAPI::Models::HRIS::DocumentListResponse,
-            options: options
-          )
-        end
-
-        # **Beta:** This endpoint is in beta and may change. Retrieve details of a
-        #   specific document by its ID.
-        #
-        # @param document_id [String] The unique identifier of the document.
-        #
-        # @param params [FinchAPI::Models::HRIS::DocumentRetreiveParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [FinchAPI::Models::HRIS::W42020, FinchAPI::Models::HRIS::W42005]
-        def retreive(document_id, params = {})
-          @client.request(
-            method: :get,
-            path: ["employer/documents/%0s", document_id],
-            model: FinchAPI::Models::HRIS::DocumentRetreiveResponse,
-            options: params[:request_options]
-          )
-        end
-
-        # @param client [FinchAPI::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/resources/hris/employments.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Resources
-    class HRIS
-      class Employments
-        # Read individual employment and income data
-        #
-        # @param params [FinchAPI::Models::HRIS::EmploymentRetrieveManyParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>] :requests The array of batch requests.
-        #
-        #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [FinchAPI::ResponsesPage<FinchAPI::Models::HRIS::EmploymentDataResponse>]
-        def retrieve_many(params)
-          parsed, options = FinchAPI::Models::HRIS::EmploymentRetrieveManyParams.dump_request(params)
-          @client.request(
-            method: :post,
-            path: "employer/employment",
-            body: parsed,
-            page: FinchAPI::ResponsesPage,
-            model: FinchAPI::Models::HRIS::EmploymentDataResponse,
-            options: options
-          )
-        end
-
-        # @param client [FinchAPI::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/resources/hris/individuals.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Resources
-    class HRIS
-      class Individuals
-        # Read individual data, excluding income and employment data
-        #
-        # @param params [FinchAPI::Models::HRIS::IndividualRetrieveManyParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil] :options
-        #
-        #   @option params [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>] :requests
-        #
-        #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [FinchAPI::ResponsesPage<FinchAPI::Models::HRIS::IndividualResponse>]
-        def retrieve_many(params = {})
-          parsed, options = FinchAPI::Models::HRIS::IndividualRetrieveManyParams.dump_request(params)
-          @client.request(
-            method: :post,
-            path: "employer/individual",
-            body: parsed,
-            page: FinchAPI::ResponsesPage,
-            model: FinchAPI::Models::HRIS::IndividualResponse,
-            options: options
-          )
-        end
-
-        # @param client [FinchAPI::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/resources/hris/pay_statements.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Resources
-    class HRIS
-      class PayStatements
-        # Read detailed pay statements for each individual.
-        #
-        #   Deduction and contribution types are supported by the payroll systems that
-        #   supports Benefits.
-        #
-        # @param params [FinchAPI::Models::HRIS::PayStatementRetrieveManyParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>] :requests The array of batch requests.
-        #
-        #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [FinchAPI::ResponsesPage<FinchAPI::Models::HRIS::PayStatementResponse>]
-        def retrieve_many(params)
-          parsed, options = FinchAPI::Models::HRIS::PayStatementRetrieveManyParams.dump_request(params)
-          @client.request(
-            method: :post,
-            path: "employer/pay-statement",
-            body: parsed,
-            page: FinchAPI::ResponsesPage,
-            model: FinchAPI::Models::HRIS::PayStatementResponse,
-            options: options
-          )
-        end
-
-        # @param client [FinchAPI::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/resources/hris/payments.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Resources
-    class HRIS
-      class Payments
-        # Read payroll and contractor related payments by the company.
-        #
-        # @param params [FinchAPI::Models::HRIS::PaymentListParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Date] :end_date The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
-        #     format.
-        #
-        #   @option params [Date] :start_date The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
-        #     format.
-        #
-        #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [FinchAPI::SinglePage<FinchAPI::Models::HRIS::Payment>]
-        def list(params)
-          parsed, options = FinchAPI::Models::HRIS::PaymentListParams.dump_request(params)
-          @client.request(
-            method: :get,
-            path: "employer/payment",
-            query: parsed,
-            page: FinchAPI::SinglePage,
-            model: FinchAPI::Models::HRIS::Payment,
-            options: options
-          )
-        end
-
-        # @param client [FinchAPI::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/resources/hris.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Resources
-    class HRIS
-      # @return [FinchAPI::Resources::HRIS::Company]
-      attr_reader :company
-
-      # @return [FinchAPI::Resources::HRIS::Directory]
-      attr_reader :directory
-
-      # @return [FinchAPI::Resources::HRIS::Individuals]
-      attr_reader :individuals
-
-      # @return [FinchAPI::Resources::HRIS::Employments]
-      attr_reader :employments
-
-      # @return [FinchAPI::Resources::HRIS::Payments]
-      attr_reader :payments
-
-      # @return [FinchAPI::Resources::HRIS::PayStatements]
-      attr_reader :pay_statements
-
-      # @return [FinchAPI::Resources::HRIS::Documents]
-      attr_reader :documents
-
-      # @return [FinchAPI::Resources::HRIS::Benefits]
-      attr_reader :benefits
-
-      # @param client [FinchAPI::Client]
-      def initialize(client:)
-        @client = client
-        @company = FinchAPI::Resources::HRIS::Company.new(client: client)
-        @directory = FinchAPI::Resources::HRIS::Directory.new(client: client)
-        @individuals = FinchAPI::Resources::HRIS::Individuals.new(client: client)
-        @employments = FinchAPI::Resources::HRIS::Employments.new(client: client)
-        @payments = FinchAPI::Resources::HRIS::Payments.new(client: client)
-        @pay_statements = FinchAPI::Resources::HRIS::PayStatements.new(client: client)
-        @documents = FinchAPI::Resources::HRIS::Documents.new(client: client)
-        @benefits = FinchAPI::Resources::HRIS::Benefits.new(client: client)
-      end
-    end
-  end
-end

data/lib/finch-api/resources/jobs/automated.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Resources
-    class Jobs
-      class Automated
-        # Enqueue an automated job.
-        #
-        #   `data_sync_all`: Enqueue a job to re-sync all data for a connection.
-        #   `data_sync_all` has a concurrency limit of 1 job at a time per connection. This
-        #   means that if this endpoint is called while a job is already in progress for
-        #   this connection, Finch will return the `job_id` of the job that is currently in
-        #   progress. Finch allows a fixed window rate limit of 1 forced refresh per hour
-        #   per connection.
-        #
-        #   `w4_form_employee_sync`: Enqueues a job for sync W-4 data for a particular
-        #   individual, identified by `individual_id`. This feature is currently in beta.
-        #
-        #   This endpoint is available for _Scale_ tier customers as an add-on. To request
-        #   access to this endpoint, please contact your Finch account manager.
-        #
-        # @param params [FinchAPI::Models::Jobs::AutomatedCreateParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Symbol, FinchAPI::Models::Jobs::AutomatedCreateParams::Type] :type The type of job to start.
-        #
-        #   @option params [FinchAPI::Models::Jobs::AutomatedCreateParams::Params] :params
-        #
-        #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [FinchAPI::Models::Jobs::AutomatedCreateResponse]
-        def create(params)
-          parsed, options = FinchAPI::Models::Jobs::AutomatedCreateParams.dump_request(params)
-          @client.request(
-            method: :post,
-            path: "jobs/automated",
-            body: parsed,
-            model: FinchAPI::Models::Jobs::AutomatedCreateResponse,
-            options: options
-          )
-        end
-
-        # Get an automated job by `job_id`.
-        #
-        # @param job_id [String]
-        #
-        # @param params [FinchAPI::Models::Jobs::AutomatedRetrieveParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [FinchAPI::Models::Jobs::AutomatedAsyncJob]
-        def retrieve(job_id, params = {})
-          @client.request(
-            method: :get,
-            path: ["jobs/automated/%0s", job_id],
-            model: FinchAPI::Models::Jobs::AutomatedAsyncJob,
-            options: params[:request_options]
-          )
-        end
-
-        # Get all automated jobs. Automated jobs are completed by a machine. By default,
-        #   jobs are sorted in descending order by submission time. For scheduled jobs such
-        #   as data syncs, only the next scheduled job is shown.
-        #
-        # @param params [FinchAPI::Models::Jobs::AutomatedListParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Integer] :limit Number of items to return
-        #
-        #   @option params [Integer] :offset Index to start from (defaults to 0)
-        #
-        #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [FinchAPI::Models::Jobs::AutomatedListResponse]
-        def list(params = {})
-          parsed, options = FinchAPI::Models::Jobs::AutomatedListParams.dump_request(params)
-          @client.request(
-            method: :get,
-            path: "jobs/automated",
-            query: parsed,
-            model: FinchAPI::Models::Jobs::AutomatedListResponse,
-            options: options
-          )
-        end
-
-        # @param client [FinchAPI::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/resources/jobs/manual.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Resources
-    class Jobs
-      class Manual
-        # Get a manual job by `job_id`. Manual jobs are completed by a human and include
-        #   Assisted Benefits jobs.
-        #
-        # @param job_id [String]
-        #
-        # @param params [FinchAPI::Models::Jobs::ManualRetrieveParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [FinchAPI::Models::Jobs::ManualAsyncJob]
-        def retrieve(job_id, params = {})
-          @client.request(
-            method: :get,
-            path: ["jobs/manual/%0s", job_id],
-            model: FinchAPI::Models::Jobs::ManualAsyncJob,
-            options: params[:request_options]
-          )
-        end
-
-        # @param client [FinchAPI::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/resources/jobs.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Resources
-    class Jobs
-      # @return [FinchAPI::Resources::Jobs::Automated]
-      attr_reader :automated
-
-      # @return [FinchAPI::Resources::Jobs::Manual]
-      attr_reader :manual
-
-      # @param client [FinchAPI::Client]
-      def initialize(client:)
-        @client = client
-        @automated = FinchAPI::Resources::Jobs::Automated.new(client: client)
-        @manual = FinchAPI::Resources::Jobs::Manual.new(client: client)
-      end
-    end
-  end
-end

data/lib/finch-api/resources/payroll/pay_groups.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Resources
-    class Payroll
-      class PayGroups
-        # Read information from a single pay group
-        #
-        # @param pay_group_id [String]
-        #
-        # @param params [FinchAPI::Models::Payroll::PayGroupRetrieveParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [FinchAPI::Models::Payroll::PayGroupRetrieveResponse]
-        def retrieve(pay_group_id, params = {})
-          @client.request(
-            method: :get,
-            path: ["employer/pay-groups/%0s", pay_group_id],
-            model: FinchAPI::Models::Payroll::PayGroupRetrieveResponse,
-            options: params[:request_options]
-          )
-        end
-
-        # Read company pay groups and frequencies
-        #
-        # @param params [FinchAPI::Models::Payroll::PayGroupListParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [String] :individual_id
-        #
-        #   @option params [Array<String>] :pay_frequencies
-        #
-        #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [FinchAPI::SinglePage<FinchAPI::Models::Payroll::PayGroupListResponse>]
-        def list(params = {})
-          parsed, options = FinchAPI::Models::Payroll::PayGroupListParams.dump_request(params)
-          @client.request(
-            method: :get,
-            path: "employer/pay-groups",
-            query: parsed,
-            page: FinchAPI::SinglePage,
-            model: FinchAPI::Models::Payroll::PayGroupListResponse,
-            options: options
-          )
-        end
-
-        # @param client [FinchAPI::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/resources/payroll.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Resources
-    class Payroll
-      # @return [FinchAPI::Resources::Payroll::PayGroups]
-      attr_reader :pay_groups
-
-      # @param client [FinchAPI::Client]
-      def initialize(client:)
-        @client = client
-        @pay_groups = FinchAPI::Resources::Payroll::PayGroups.new(client: client)
-      end
-    end
-  end
-end

data/lib/finch-api/resources/providers.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Resources
-    class Providers
-      # Return details on all available payroll and HR systems.
-      #
-      # @param params [FinchAPI::Models::ProviderListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [FinchAPI::SinglePage<FinchAPI::Models::Provider>]
-      def list(params = {})
-        @client.request(
-          method: :get,
-          path: "providers",
-          page: FinchAPI::SinglePage,
-          model: FinchAPI::Models::Provider,
-          options: params[:request_options]
-        )
-      end
-
-      # @param client [FinchAPI::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/lib/finch-api/resources/request_forwarding.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Resources
-    class RequestForwarding
-      # The Forward API allows you to make direct requests to an employment system. If
-      #   Finch’s unified API doesn’t have a data model that cleanly fits your needs, then
-      #   Forward allows you to push or pull data models directly against an integration’s
-      #   API.
-      #
-      # @param params [FinchAPI::Models::RequestForwardingForwardParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :method_ The HTTP method for the forwarded request. Valid values include: `GET` , `POST`
-      #     , `PUT` , `DELETE` , and `PATCH`.
-      #
-      #   @option params [String] :route The URL route path for the forwarded request. This value must begin with a
-      #     forward-slash ( / ) and may only contain alphanumeric characters, hyphens, and
-      #     underscores.
-      #
-      #   @option params [String, nil] :data The body for the forwarded request. This value must be specified as either a
-      #     string or a valid JSON object.
-      #
-      #   @option params [Object, nil] :headers The HTTP headers to include on the forwarded request. This value must be
-      #     specified as an object of key-value pairs. Example:
-      #     `{"Content-Type": "application/xml", "X-API-Version": "v1" }`
-      #
-      #   @option params [Object, nil] :params The query parameters for the forwarded request. This value must be specified as
-      #     a valid JSON object rather than a query string.
-      #
-      #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [FinchAPI::Models::RequestForwardingForwardResponse]
-      def forward(params)
-        parsed, options = FinchAPI::Models::RequestForwardingForwardParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "forward",
-          body: parsed,
-          model: FinchAPI::Models::RequestForwardingForwardResponse,
-          options: options
-        )
-      end
-
-      # @param client [FinchAPI::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/lib/finch-api/resources/sandbox/company.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Resources
-    class Sandbox
-      class Company
-        # Update a sandbox company's data
-        #
-        # @param params [FinchAPI::Models::Sandbox::CompanyUpdateParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Account>, nil] :accounts An array of bank account objects associated with the payroll/HRIS system.
-        #
-        #   @option params [Array<FinchAPI::Models::Sandbox::CompanyUpdateParams::Department, nil>, nil] :departments The array of company departments.
-        #
-        #   @option params [String, nil] :ein The employer identification number.
-        #
-        #   @option params [FinchAPI::Models::Sandbox::CompanyUpdateParams::Entity, nil] :entity The entity type object.
-        #
-        #   @option params [String, nil] :legal_name The legal name of the company.
-        #
-        #   @option params [Array<FinchAPI::Models::Location, nil>, nil] :locations
-        #
-        #   @option params [String, nil] :primary_email The email of the main administrator on the account.
-        #
-        #   @option params [String, nil] :primary_phone_number The phone number of the main administrator on the account. Format: `XXXXXXXXXX`
-        #
-        #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-        #
-        # @return [FinchAPI::Models::Sandbox::CompanyUpdateResponse]
-        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
-
-        # @param client [FinchAPI::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end

data/lib/finch-api/resources/sandbox/connections/accounts.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-module FinchAPI
-  module Resources
-    class Sandbox
-      class Connections
-        class Accounts
-          # Create a new account for an existing connection (company/provider pair)
-          #
-          # @param params [FinchAPI::Models::Sandbox::Connections::AccountCreateParams, Hash{Symbol=>Object}] .
-          #
-          #   @option params [String] :company_id
-          #
-          #   @option params [String] :provider_id The provider associated with the `access_token`
-          #
-          #   @option params [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateParams::AuthenticationType] :authentication_type
-          #
-          #   @option params [Array<String>] :products Optional, defaults to Organization products (`company`, `directory`,
-          #     `employment`, `individual`)
-          #
-          #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-          #
-          # @return [FinchAPI::Models::Sandbox::Connections::AccountCreateResponse]
-          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.
-          #
-          # @param params [FinchAPI::Models::Sandbox::Connections::AccountUpdateParams, Hash{Symbol=>Object}] .
-          #
-          #   @option params [Symbol, FinchAPI::Models::ConnectionStatusType] :connection_status
-          #
-          #   @option params [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-          #
-          # @return [FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse]
-          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
-
-          # @param client [FinchAPI::Client]
-          def initialize(client:)
-            @client = client
-          end
-        end
-      end
-    end
-  end
-end