Class: FinchAPI::Resources::Providers

Inherits:

Object

• Object
• FinchAPI::Resources::Providers

Defined in:

lib/finch-api/resources/providers.rb

Instance Method Summary

• #initialize(client:) ⇒ Providers constructor

  A new instance of Providers.

• #list(params = {}) ⇒ FinchAPI::SinglePage<FinchAPI::Models::Provider>

  Return details on all available payroll and HR systems.

Constructor Details

#initialize(client:) ⇒ Providers

Returns a new instance of Providers.

Parameters:

• client (FinchAPI::Client)

# File 'lib/finch-api/resources/providers.rb', line 24

def initialize(client:)
  @client = client
end

Instance Method Details

#list(params = {}) ⇒ FinchAPI::SinglePage<FinchAPI::Models::Provider>

Return details on all available payroll and HR systems.

Parameters:

• params (FinchAPI::Models::ProviderListParams, Hash{Symbol=>Object}) (defaults to: {}) —

  .

  @option params [FinchAPI::RequestOptions, HashSymbol=>Object, nil] :request_options

Returns:

• (FinchAPI::SinglePage<FinchAPI::Models::Provider>)

# File 'lib/finch-api/resources/providers.rb', line 13

def list(params = {})
  @client.request(
    method: :get,
    path: "providers",
    page: FinchAPI::SinglePage,
    model: FinchAPI::Models::Provider,
    options: params[:request_options]
  )
end