Merge pull request #26 from Chloe-Woahie/dev-main

v0.7.1

Cargo.toml

@@ -8,7 +8,7 @@ license = "MIT"
 name = "roli"
 readme = "README.md"
 repository = "https://github.com/Chloe-Woahie/roli"
-version = "0.7.0"
+version = "0.7.1"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

README.md

@@ -15,14 +15,22 @@ A low level API wrapper for Rolimons.com.
 * This crate is a low level wrapper due to the fact that allowed requests to the website are limited. To maintain flexibility while also using the endpoints responsibly, the user is expected to maintain their own caching.
 
 # API Coverage Checklist
-- [x] Items API
-- [x] Deals API
-- [x] Trade Ad API
-- [x] Player API
-- [x] Game API
-- [x] Groups API
-- [x] Market Activity API
-- [ ] Hidden APIs (undocumented APIs that are only found in the source code)
+* [x] Items API
+    - Fetch All Item Details - [`Client::all_item_details`](https://docs.rs/roli/latest/roli/struct.Client.html#method.all_item_details)
+* [x] Deals API
+    - Fetch Deals Activity - [`Client::deals_activity`](https://docs.rs/roli/latest/roli/struct.Client.html#method.deals_activity)
+* [x] Trade Ad API
+    - Fetch Recent Trade Ads - [`Client::recent_trade_ads`](https://docs.rs/roli/latest/roli/struct.Client.html#method.recent_trade_ads)
+    - Create Trade Ad - [`Client::create_trade_ad`](https://docs.rs/roli/latest/roli/struct.Client.html#method.create_trade_ad)
+* [x] Player API
+    - Player Search - [`Client::player_search`](https://docs.rs/roli/latest/roli/struct.Client.html#method.player_search)
+    - Fetch Player Profile - [`Client::player_profile`](https://docs.rs/roli/latest/roli/struct.Client.html#method.player_profile)
+* [x] Game API
+    - Fetch Games List - [`Client::games_list`](https://docs.rs/roli/latest/roli/struct.Client.html#method.games_list)
+* [x] Groups API
+    - Fetch Group Search - [`Client::group_search`](https://docs.rs/roli/latest/roli/struct.Client.html#method.group_search)
+* [x] Market Activity API
+    - Fetch Recent Sales - [`Client::recent_sales`](https://docs.rs/roli/latest/roli/struct.Client.html#method.recent_sales)
 
 # Related Crates
 This crate is a sister crate of [roboat](https://crates.io/crates/roboat), an API wrapper for [Roblox.com](https://www.roblox.com/).

src/items.rs

@@ -174,7 +174,7 @@ impl AllItemDetailsResponse {
 }
 
 impl Client {
-    /// A wrapper for <https://www.rolimons.com/itemapi/itemdetails>.
+    /// A wrapper for the item details API.
     ///
     /// Does not require authentication.
     ///

src/lib.rs

@@ -9,10 +9,11 @@
 //!
 //! # API Coverage Checklist
 //! - [x] Items API
-//!     - [`Client::deals_activity`]
-//! - [x] Deals API
 //!     - [`Client::all_item_details`]
+//! - [x] Deals API
+//!     - [`Client::deals_activity`]
 //! - [x] Trade Ad API
+//!    - [`Client::recent_trade_ads`]
 //!    - [`Client::create_trade_ad`]
 //! - [x] Player API
 //!    - [`Client::player_search`]
@@ -23,8 +24,6 @@
 //!    - [`Client::group_search`]
 //! - [x] Market Activity API
 //!   - [`Client::recent_sales`]
-//! - [ ] Hidden APIs
-//!   - [`Client::recent_trade_ads`]
 //!
 //! # Quick Start
 //!

src/market_activity.rs

@@ -73,7 +73,7 @@ impl Sale {
 }
 
 impl Client {
-    /// A wrapper for for market activity page.
+    /// A wrapper for the market activity page.
     ///
     /// Provides information on the most recent limited sales.
     ///