Skip to main content

Crate waka

Crate waka 

Source
Expand description

§WakaTime API client

A client for the WakaTime API, covering every documented endpoint: coding statistics, summaries, durations, heartbeats, goals, insights, leaderboards, organizations, and the write operations.

Authenticate with an API key (WakaTimeClientBuilder::new_with_api_key) or an OAuth 2.0 access token (WakaTimeClientBuilder::new_with_bearer_token).

use waka::{SummariesOptions, WakaTimeClientBuilder};

let api_key = std::env::var("WAKATIME_API_KEY")?;
let client = WakaTimeClientBuilder::new_with_api_key(api_key)
    .with_user("current")
    .build()?;

let summary = client
    .summaries("2023-01-01", "2023-01-08", SummariesOptions::default())
    .await?;

Modules§

model
API model types.

Structs§

AllTimesSinceTodayOptions
Options for WakaTimeClient::all_time_since_today.
CommitOptions
Options for WakaTimeClient::commit.
CommitsOptions
Options for WakaTimeClient::commits and WakaTimeClient::commits_all.
DurationsOptions
Options for WakaTimeClient::durations.
EditorsOptions
Options for WakaTimeClient::editors.
ErrorsResponse
The error messages returned by the API; either as a list in errors or as a single message in error, depending on the endpoint.
ExternalDurationsOptions
Options for WakaTimeClient::external_durations.
InsightsOptions
Options for WakaTimeClient::insights.
LeadersOptions
Options for WakaTimeClient::leaders.
OrgDurationsOptions
Options for WakaTimeClient::org_dashboard_durations and WakaTimeClient::org_dashboard_member_durations.
OrgMemberSummariesOptions
Options for WakaTimeClient::org_dashboard_member_summaries.
OrgSummariesOptions
Options for WakaTimeClient::org_dashboard_summaries.
PrivateLeaderboardLeadersOptions
Options for WakaTimeClient::private_leaderboard_leaders.
ProjectsOptions
Options for WakaTimeClient::projects.
StatsOptions
Options for WakaTimeClient::stats.
SummariesOptions
Options for WakaTimeClient::summaries.
WakaTimeClient
A client for accessing the WakaTime API.
WakaTimeClientBuilder
A builder for WakaTimeClient instances.

Enums§

ApiError
An error returned by the WakaTime API or while communicating with it.
BuilderError
An error that occurred while building a WakaTimeClient.
InsightType
An insight type accepted by WakaTimeClient::insights.
Range
A time range accepted by WakaTimeClient::stats, WakaTimeClient::insights and WakaTimeClient::stats_aggregated.