Class: Blueticks::Resources::PingResource

Inherits:

BaseResource

• Object
• BaseResource
• Blueticks::Resources::PingResource

Defined in:

lib/blueticks/resources/ping.rb

Instance Attribute Summary

Attributes inherited from BaseResource

#client

Instance Method Summary

• #retrieve ⇒ Object

  Ping.

Methods inherited from BaseResource

#initialize

Constructor Details

This class inherits a constructor from Blueticks::BaseResource

Instance Method Details

#retrieve ⇒ Object

Ping.

Probe the API: returns api: "ok", the account id, and the currently connected WhatsApp engines. Useful as a connection/liveness test.

# File 'lib/blueticks/resources/ping.rb', line 13

def retrieve
  env = client.request("GET", "/v1/ping")
  Types::Ping.from_hash(env && env["data"])
end