Crate ridewithgps_client

Crate ridewithgps_client 

Source
Expand description

A Rust client for the RideWithGPS API.

This crate provides a client for interacting with the RideWithGPS API v1, allowing you to manage routes, trips, events, collections, and more.

§Example

use ridewithgps_client::RideWithGpsClient;

let client = RideWithGpsClient::new(
    "https://ridewithgps.com",
    "your-api-key",
    Some("your-auth-token")
);

// Get current user
let user = client.get_current_user().unwrap();
println!("User: {:?}", user);

Structs§

AuthToken
Response containing an authentication token
Collection
A collection of routes and trips
CoursePoint
Course point (turn-by-turn cue) on a route
CreateAuthTokenRequest
Request to create an authentication token
Event
An event
EventRequest
Request to create or update an event
Gear
Gear/equipment used for a trip
ListCollectionsParams
Parameters for listing collections
ListEventsParams
Parameters for listing events
ListMembersParams
Parameters for listing members
ListPointsOfInterestParams
Parameters for listing POIs
ListRoutesParams
Parameters for listing routes
ListTripsParams
Parameters for listing trips
Member
A club member
MemberPermissions
Member permissions
Organizer
Event organizer information
PaginatedResponse
Common response wrapper for paginated lists
Pagination
Pagination information for list responses
Photo
Photo attached to a route or trip
PointOfInterest
A point of interest
PointOfInterestRequest
Request to create or update a POI
Polyline
Polyline data for a route
RideWithGpsClient
Main client for the RideWithGPS API
Route
A route
SyncItem
A synchronized item
SyncResponse
Response from the sync endpoint
TrackPoint
Track point on a route
Trip
A trip (recorded ride)
TripTrackPoint
Track point on a trip with telemetry data
UpdateMemberRequest
Request to update member permissions/status
User
User information

Enums§

Error
Error type for RideWithGPS API operations
ItemType
Types of items that can be synchronized
Visibility
Visibility setting for a route

Type Aliases§

Result
Result type for RideWithGPS API operations