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 private

  A new instance of Providers.

• #list(request_options: {}) ⇒ FinchAPI::Internal::SinglePage<FinchAPI::Models::ProviderListResponse>

  Return details on all available payroll and HR systems.

Constructor Details

#initialize(client:) ⇒ Providers

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Providers.

Parameters:

• client (FinchAPI::Client)

# File 'lib/finch_api/resources/providers.rb', line 28

def initialize(client:)
  @client = client
end

Instance Method Details

#list(request_options: {}) ⇒ FinchAPI::Internal::SinglePage<FinchAPI::Models::ProviderListResponse>

Return details on all available payroll and HR systems.

Parameters:

• request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (FinchAPI::Internal::SinglePage<FinchAPI::Models::ProviderListResponse>)

See Also:

• Models::ProviderListParams

# File 'lib/finch_api/resources/providers.rb', line 15

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