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

v0.17.0
fekie · May 8, 2023 · e706d95 · e706d95
2 parents cca03f4 + 46dcf7a
commit e706d95
Show file tree

Hide file tree

Showing 17 changed files with 30 additions and 34 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -8,7 +8,7 @@ license = "MIT"
 name = "roboat"
 readme = "README.md"
 repository = "https://github.com/Chloe-Woahie/roboat"
-version = "0.16.2"
+version = "0.17.0"
 
 [dependencies]
 reqwest = { version = "0.11.14", default-features=false, features = ["rustls-tls", "json"] }

diff --git a/README.md b/README.md
@@ -21,6 +21,14 @@ All public methods in this crate are documented and have at least one correspond
 Documentation can be found [here](https://docs.rs/roboat/).
 
 # Coverage
+* Auth API - [`auth.roblox.com/*`]
+    - Force Refresh X-CSRF-TOKEN - [`Client::force_refresh_xcsrf_token`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.force_refresh_xcsrf_token)
+* BEDEV2 API - [`apis.roblox.com/*`] 
+    - Fetch Non-Tradable Limited Details - [`Client::non_tradable_limited_details`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.non_tradable_limited_details)
+    - Fetch Collectible Product ID - [`Client::collectible_product_id`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.collectible_product_id)
+    - Fetch Collectible Product ID Bulk - [`Client::collectible_product_id_bulk`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.collectible_product_id_bulk)
+    - Fetch Collectible Creator ID - [`Client::collectible_creator_id`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.collectible_creator_id)
+    - Purchase Non-Tradable Limited - [`Client::purchase_non_tradable_limited`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.purchase_non_tradable_limited)
 * Catalog API - [`catalog.roblox.com/*`]
     - Fetch Item Details - [`Client::item_details`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.item_details)
     - Fetch Product ID - [`Client::product_id`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.product_id)
@@ -34,25 +42,17 @@ Documentation can be found [here](https://docs.rs/roboat/).
     - Put Limited On Sale - [`Client::put_limited_on_sale`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.put_limited_on_sale)
     - Take Limited Off Sale - [`Client::take_limited_off_sale`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.take_limited_off_sale)
     - Purchase Tradable Limited - [`Client::purchase_tradable_limited`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.purchase_tradable_limited)
+* Group API - [`groups.roblox.com/*`]
+    - Fetch Group Roles - [`Client::group_roles`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.group_roles)
+* Presence API - [`presence.roblox.com/*`]
+    - Register Presence - [`Client::register_presence`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.register_presence)
+* Trades API - [`trades.roblox.com/*`]
+    - Fetch Trades List - [`Client::trades`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.trades)
 * Users API - [`users.roblox.com/*`]
     - Fetch User ID - [`Client::user_id`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.user_id)
     - Fetch Username - [`Client::username`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.username)
     - Fetch Display Name - [`Client::display_name`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.display_name)
     - User Search - [`Client::user_search`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.user_search)
-* Presence API - [`presence.roblox.com/*`]
-    - Register Presence - [`Client::register_presence`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.register_presence)
-* Trades API - [`trades.roblox.com/*`]
-    - Fetch Trades List - [`Client::trades`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.trades)
-* Auth API - [`auth.roblox.com/*`]
-    - Force Refresh X-CSRF-TOKEN - [`Client::force_refresh_xcsrf_token`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.force_refresh_xcsrf_token)
-* Group API - [`groups.roblox.com/*`]
-    - Fetch Group Roles - [`Client::group_roles`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.group_roles)
-* BEDEV2 API - [`apis.roblox.com/*`] 
-    - Fetch Non-Tradable Limited Details - [`Client::non_tradable_limited_details`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.non_tradable_limited_details)
-    - Fetch Collectible Product ID - [`Client::collectible_product_id`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.collectible_product_id)
-    - Fetch Collectible Product ID Bulk - [`Client::collectible_product_id_bulk`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.collectible_product_id_bulk)
-    - Fetch Collectible Creator ID - [`Client::collectible_creator_id`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.collectible_creator_id)
-    - Purchase Non-Tradable Limited - [`Client::purchase_non_tradable_limited`](https://docs.rs/roboat/latest/roboat/struct.Client.html#method.purchase_non_tradable_limited)
 
 # Setup
 You can add the latest version of roboat to your project by running:
@@ -64,7 +64,7 @@ Alternatively, you can add a specific version of roboat to your project by addin
 
 ```toml
 [dependencies]
-roboat = "0.16.2"
+roboat = "0.17.0"
 ```
 
 # Quick Start Examples

diff --git a/examples/get_client_user_info.rs → examples/fetch_client_user_info.rs b/examples/get_client_user_info.rs → examples/fetch_client_user_info.rs
diff --git a/examples/get_collectible_product_id.rs → examples/fetch_collectible_product_id.rs b/examples/get_collectible_product_id.rs → examples/fetch_collectible_product_id.rs
diff --git a/examples/get_collectible_product_ids_bulk.rs → ...les/fetch_collectible_product_ids_bulk.rs b/examples/get_collectible_product_ids_bulk.rs → ...les/fetch_collectible_product_ids_bulk.rs
diff --git a/examples/get_inbound_trades.rs → examples/fetch_inbound_trades.rs b/examples/get_inbound_trades.rs → examples/fetch_inbound_trades.rs
diff --git a/examples/get_item_details.rs → examples/fetch_item_details.rs b/examples/get_item_details.rs → examples/fetch_item_details.rs
diff --git a/examples/get_new_limited_details.rs → examples/fetch_new_limited_details.rs b/examples/get_new_limited_details.rs → examples/fetch_new_limited_details.rs
diff --git a/examples/get_non_tradable_limited_details.rs → ...les/fetch_non_tradable_limited_details.rs b/examples/get_non_tradable_limited_details.rs → ...les/fetch_non_tradable_limited_details.rs
diff --git a/examples/get_product_id.rs → examples/fetch_product_id.rs b/examples/get_product_id.rs → examples/fetch_product_id.rs
diff --git a/examples/force_refresh_xcsrf.rs → examples/fetch_refresh_xcsrf.rs b/examples/force_refresh_xcsrf.rs → examples/fetch_refresh_xcsrf.rs
diff --git a/examples/get_resellers.rs → examples/fetch_resellers.rs b/examples/get_resellers.rs → examples/fetch_resellers.rs
diff --git a/examples/get_robux_balance.rs → examples/fetch_robux_balance.rs b/examples/get_robux_balance.rs → examples/fetch_robux_balance.rs
diff --git a/...es/get_ugc_limited_collectible_item_id.rs → .../fetch_ugc_limited_collectible_item_id.rs b/...es/get_ugc_limited_collectible_item_id.rs → .../fetch_ugc_limited_collectible_item_id.rs
diff --git a/examples/get_ugc_limited_details.rs → examples/fetch_ugc_limited_details.rs b/examples/get_ugc_limited_details.rs → examples/fetch_ugc_limited_details.rs
diff --git a/examples/get_user_sales.rs → examples/fetch_user_sales.rs b/examples/get_user_sales.rs → examples/fetch_user_sales.rs
diff --git a/src/lib.rs b/src/lib.rs
@@ -9,6 +9,14 @@
 //! All public methods in this crate are documented and have at least one corresponding example.
 //!
 //! # Coverage
+//! * Auth API
+//!   - Force Refresh Xcsrf - [`Client::force_refresh_xcsrf`]
+//! * BEDEV2 API
+//!   - Fetch Non-Tradable Limited Details - [`Client::non_tradable_limited_details`]
+//!   - Fetch Collectible Product ID - [`Client::collectible_product_id`]
+//!   - Fetch Collectible Product ID Bulk - [`Client::collectible_product_id_bulk`]
+//!   - Fetch Collectible Creator ID - [`Client::collectible_creator_id`]
+//!   - Purchase Non-Tradable Limited - [`Client::purchase_non_tradable_limited`]
 //! * Catalog API
 //!   - Fetch Item Details - [`Client::item_details`]
 //!   - Fetch Product ID - [`Client::product_id`]  
@@ -22,25 +30,17 @@
 //!   - Put Limited On Sale - [`Client::put_limited_on_sale`]
 //!   - Take Limited Off Sale - [`Client::take_limited_off_sale`]
 //!   - Purchase Tradable Limited - [`Client::purchase_tradable_limited`]
+//! * Group API
+//!   - Fetch Group Roles - [`Client::group_roles`]
+//! * Presence API
+//!   - Register Presence - [`Client::register_presence`]
+//! * Trades API
+//!   - Fetch Trades List - [`Client::trades`]
 //! * Users API
 //!   - Fetch User ID - [`Client::user_id`]
 //!   - Fetch Username - [`Client::username`]
 //!   - Fetch Display Name - [`Client::display_name`]
 //!   - User Search - [`Client::user_search`]
-//! * Presence API
-//!   - Register Presence - [`Client::register_presence`]
-//! * Trades API
-//!   - Fetch Trades List - [`Client::trades`]
-//! * Auth API
-//!   - Force Refresh Xcsrf - [`Client::force_refresh_xcsrf`]
-//! * Group API
-//!   - Fetch Group Roles - [`Client::group_roles`]
-//! * BEDEV2 API
-//!   - Fetch Non-Tradable Limited Details - [`Client::non_tradable_limited_details`]
-//!   - Fetch Collectible Product ID - [`Client::collectible_product_id`]
-//!   - Fetch Collectible Product ID Bulk - [`Client::collectible_product_id_bulk`]
-//!   - Fetch Collectible Creator ID - [`Client::collectible_creator_id`]
-//!   - Purchase Non-Tradable Limited - [`Client::purchase_non_tradable_limited`]
 //!
 //! # Quick Start Examples
 //!
@@ -211,11 +211,7 @@ mod validation;
 // todo: add usage to readme
 // todo: every type should have an explanation of the typical means by which the user will construct or fetch it, if the answer isn't “this is a struct literal with public methods”.
 // todo: figure out authtickets
-// todo: add ugc limited buying
-// todo: make feature that allows reqwest crate to not collide.
 // todo: hide reqwest types
-// todo: rename reqwest_types.rs to request_types.rs
-// todo: list what errors can be returned by each method
 // todo: maybe respect cookies returned
 // todo: maybe post on devforums, reddit, maybe the rust server
 // todo: put string of parsing error in MalformedResponse