Module: ShelfWatch

Defined in:
lib/shelfwatch.rb,
lib/shelfwatch/http.rb,
lib/shelfwatch/client.rb,
lib/shelfwatch/errors.rb,
lib/shelfwatch/version.rb,
lib/shelfwatch/resources/mdm.rb,
lib/shelfwatch/resources/visits.rb,
lib/shelfwatch/resources/reports.rb

Overview

Official Ruby SDK for ShelfWatch APIs v2.

client = ShelfWatch.new(api_key: "swpk_…", project_id: "PROJECT_UUID")
visits = client.visits.list(start_date: "2026-07-01", end_date: "2026-07-31")

Defined Under Namespace

Modules: Http, Resources Classes: AuthenticationError, Client, Error, ForbiddenError, NotFoundError, RateLimitError, ServerError, ValidationError

Constant Summary collapse

VERSION = 
"0.1.0"

Class Method Summary collapse

Class Method Details

.new(**kwargs) ⇒ Object

Construct a Client (mirrors the Python ShelfWatch(...) entrypoint).



19
20
21
 
# File 'lib/shelfwatch.rb', line 19

def self.new(**kwargs)
  Client.new(**kwargs)
end