Class: MethodRuby::Resources::Ping

Inherits:

Object

• Object
• MethodRuby::Resources::Ping

Defined in:

lib/method_ruby/resources/ping.rb

Overview

API health check endpoint.

Instance Method Summary

• #check(request_options: {}) ⇒ MethodRuby::Models::PingCheckResponse

  Returns the API health status and version.

• #initialize(client:) ⇒ Ping constructor private

  A new instance of Ping.

Constructor Details

#initialize(client:) ⇒ Ping

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

Parameters:

• client (MethodRuby::Client)

# File 'lib/method_ruby/resources/ping.rb', line 29

def initialize(client:)
  @client = client
end

Instance Method Details

#check(request_options: {}) ⇒ MethodRuby::Models::PingCheckResponse

Returns the API health status and version.

Parameters:

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

Returns:

• (MethodRuby::Models::PingCheckResponse)

See Also:

• Models::PingCheckParams

# File 'lib/method_ruby/resources/ping.rb', line 16

def check(params = {})
  @client.request(
    method: :get,
    path: "ping",
    model: MethodRuby::Models::PingCheckResponse,
    security: {},
    options: params[:request_options]
  )
end