Class: MethodRuby::Resources::Ping

Inherits:

Object

• Object
• MethodRuby::Resources::Ping

Defined in:

lib/method_ruby/resources/ping.rb

Overview

Health check endpoint

Instance Method Summary

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

  Some parameter documentations has been truncated, see Models::PingCheckParams for more details.

• #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 36

def initialize(client:)
  @client = client
end

Instance Method Details

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

Some parameter documentations has been truncated, see Models::PingCheckParams for more details.

Returns a simple health check response for authenticated API clients.

Parameters:

• method_version (Symbol, MethodRuby::Models::PingCheckParams::MethodVersion) —

  API version to use for this request. This spec targets ‘2025-12-01`.

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

Returns:

• (MethodRuby::Models::PingCheckResponse)

See Also:

• Models::PingCheckParams

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

def check(params)
  parsed, options = MethodRuby::PingCheckParams.dump_request(params)
  @client.request(
    method: :get,
    path: "ping",
    headers: parsed.transform_keys(method_version: "method-version"),
    model: MethodRuby::Models::PingCheckResponse,
    security: {secret_key: true},
    options: options
  )
end