Class: Believe::Resources::Health

Inherits:

Object

• Object
• Believe::Resources::Health

Defined in:

lib/believe/resources/health.rb

Instance Method Summary

• #check(request_options: {}) ⇒ Object

  Check if the API is running and healthy.

• #initialize(client:) ⇒ Health constructor private

  A new instance of Health.

Constructor Details

#initialize(client:) ⇒ Health

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 Health.

Parameters:

• client (::Believe::Client)

# File 'lib/believe/resources/health.rb', line 27

def initialize(client:)
  @client = client
end

Instance Method Details

#check(request_options: {}) ⇒ Object

Check if the API is running and healthy.

Parameters:

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

Returns:

• (Object)

See Also:

• Models::HealthCheckParams

# File 'lib/believe/resources/health.rb', line 15

def check(params = {})
  @client.request(
    method: :get,
    path: "health",
    model: ::Believe::Internal::Type::Unknown,
    options: params[:request_options]
  )
end