roblox_api/api/inventory/
v1.rs

1use serde::{Deserialize, Serialize};
2
3use crate::{AssetTypeId, Error, Paging, client::Client};
4
5pub const URL: &str = "https://inventory.roblox.com/v1";
6
7#[repr(u8)]
8#[derive(Clone, Debug, Deserialize, Serialize)]
9pub enum ItemType {
10    Asset = 0,
11    Gamepass,
12    Badge,
13    Bundle,
14}
15
16#[derive(Clone, Debug, Deserialize)]
17pub struct AssetInfo {
18    pub id: u64,
19    #[serde(rename = "type")]
20    pub kind: String,
21    pub name: String,
22    #[serde(rename = "instanceId")]
23    pub instance_id: u64,
24}
25
26#[derive(Clone, Debug, Deserialize)]
27pub struct UserOwnedAssets {
28    #[serde(rename = "nextPageCursor")]
29    pub next_cursor: Option<String>,
30    #[serde(rename = "previousPageCursor")]
31    pub previous_cursor: Option<String>,
32    #[serde(rename = "data")]
33    pub assets: Vec<AssetInfo>,
34}
35
36#[derive(Clone, Debug, Deserialize)]
37pub struct CollectibleInfo {
38    #[serde(rename = "assetId")]
39    pub id: u64,
40    #[serde(rename = "originalPrice")]
41    pub original_price: u64,
42    #[serde(rename = "recentAveragePrice")]
43    pub recent_average_price: u64,
44    #[serde(rename = "assetStock")]
45    pub stock: u64,
46    #[serde(rename = "userAssetId")]
47    pub instance_id: u64,
48    pub name: String,
49    #[serde(rename = "buildersClubMembershipType")]
50    pub premium_membership_type: String,
51    #[serde(rename = "isOnHold")]
52    pub on_hold: bool,
53    #[serde(rename = "serialNumber")]
54    pub serial: Option<u64>,
55}
56
57#[derive(Clone, Debug, Deserialize)]
58pub struct UserOwnedCollectibles {
59    #[serde(rename = "nextPageCursor")]
60    pub next_cursor: Option<String>,
61    #[serde(rename = "previousPageCursor")]
62    pub previous_cursor: Option<String>,
63    #[serde(rename = "data")]
64    pub assets: Vec<CollectibleInfo>,
65}
66
67pub async fn can_view_inventory(client: &mut Client, user_id: u64) -> Result<bool, Error> {
68    let result = client
69        .requestor
70        .client
71        .get(format!("{URL}/users/{user_id}/can-view-inventory"))
72        .headers(client.requestor.default_headers.clone())
73        .send()
74        .await;
75
76    #[derive(Clone, Debug, Deserialize)]
77    struct Response {
78        #[serde(rename = "canView")]
79        can_view: bool,
80    }
81
82    let response = client.validate_response(result).await?;
83    Ok(client
84        .requestor
85        .parse_json::<Response>(response)
86        .await?
87        .can_view)
88}
89
90pub async fn user_owned_assets(
91    client: &mut Client,
92    user_id: u64,
93    id: u64,
94    item_type: ItemType,
95    paging: Paging<'_>,
96) -> Result<UserOwnedAssets, Error> {
97    let item_type = item_type as u8;
98
99    let cursor = match paging.cursor {
100        Some(cursor) => format!("&cursor={cursor}"),
101        None => String::new(),
102    };
103
104    let result = client
105        .requestor
106        .client
107        .get(format!(
108            "{URL}/users/{user_id}/items/{item_type}/{id}{cursor}"
109        ))
110        .headers(client.requestor.default_headers.clone())
111        .send()
112        .await;
113
114    let response = client.validate_response(result).await?;
115    client
116        .requestor
117        .parse_json::<UserOwnedAssets>(response)
118        .await
119}
120
121pub async fn user_owned_collectibles(
122    client: &mut Client,
123    user_id: u64,
124    asset_type_id: Option<AssetTypeId>,
125    paging: Paging<'_>,
126) -> Result<UserOwnedCollectibles, Error> {
127    let limit = paging.limit.unwrap_or(10);
128    let sort_order = paging.order.unwrap_or_default().to_string();
129    let cursor = match paging.cursor {
130        Some(cursor) => format!("&cursor={cursor}"),
131        None => String::new(),
132    };
133
134    let asset_type = match asset_type_id {
135        Some(id) => {
136            let id = id as u8;
137            format!("?assetType={id}")
138        }
139        None => String::new(),
140    };
141
142    let result = client
143        .requestor
144        .client
145        .get(format!(
146            "{URL}/users/{user_id}/assets/collectibles{asset_type}&limit={limit}&sortOrder={sort_order}{cursor}"
147        ))
148        .headers(client.requestor.default_headers.clone())
149        .send()
150        .await;
151
152    let response = client.validate_response(result).await?;
153    client
154        .requestor
155        .parse_json::<UserOwnedCollectibles>(response)
156        .await
157}
roblox_api/api/inventory/v1.rs

roblox_api/api/inventory/
v1.rs
