Class: Orb::Resources::TopLevel

Inherits:
Object
  • Object
show all
Defined in:
lib/orb/resources/top_level.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ TopLevel

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

Parameters:



32
33
34
 
# File 'lib/orb/resources/top_level.rb', line 32

def initialize(client:)
  @client = client
end

Instance Method Details

#ping(request_options: {}) ⇒ Orb::Models::TopLevelPingResponse

This endpoint allows you to test your connection to the Orb API and check the validity of your API key, passed in the Authorization header. This is particularly useful for checking that your environment is set up properly, and is a great choice for connectors and integrations.

This API does not have any side-effects or return any Orb resources.

Parameters:

Returns:

See Also:



20
21
22
23
24
25
26
27
 
# File 'lib/orb/resources/top_level.rb', line 20

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