briteverify-rs

Crates.iobriteverify-rs
lib.rsbriteverify-rs
version0.2.0
sourcesrc
created_at2023-03-29 17:16:05.123272
updated_at2023-10-30 18:53:04.025242
descriptionRust client library for the BriteVerify API Suite
homepagehttps://github.com/the-wondersmith/briteverify-rs
repositoryhttps://github.com/the-wondersmith/briteverify-rs
max_upload_size
id824219
size654,305
Mark S. (the-wondersmith)

documentation

https://docs.rs/briteverify-rs/latest/briteverify_rs/

README

briteverify-rs

crate documentation tests coverage

briteverify-rs provides a type-safe, ergonomic client for the BriteVerify API based on the popular reqwest HTTP client library.

It aims to provide a simple and convenient way to interact with the BriteVerify API from Rust. It tries to be easy to use, with a focus on allowing devs to quickly get up and running with the API.

License

AGPL-3.0-or-later

Basic Usage

let response: AccountCreditBalance = BriteVerifyClient::new("YOUR API KEY HERE")?
    .get_account_balance()
    .await?;

println!("{response:#?}");

Features

briteverify-rs provides:

  • Fully documented reqwest-based client for the BriteVerify API
  • Type-safe requests and responses w/ serde support
  • Support for all¹ single-transaction and bulk² BriteVerify API endpoints
  • Easy-to-use API that follows Rust conventions

  • 1: briteverify-rs makes a best-effort attempt to stay current with the BriteVerify API, but is ultimately maintained independently. Best-effort means that no guarantees are made, but PRs are always accepted.
  • 2: briteverify-rs currently implements support for the v3 bulk endpoints, with no plans to add support for legacy or deprecated endpoints (namely the v2 endpoints in this case).

TODO:

  • Tests 😅
Commit count: 23

cargo fmt