Add archival (#69)

Sleitnick · web-flow · commit b8ded152cedf · 2025-03-21T02:12:25.000-04:00
* Add archive and restore

* Add get and get-operation

* Docs and version bump

* Fix CI
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v4
       
       - name: Rust
-        run: rustup toolchain install stable --profile minimal --component clippy rustfmt --no-self-update
+        run: rustup toolchain install stable --profile minimal --component clippy,rustfmt --no-self-update
       
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "rbxcloud"
-version = "0.15.1"
+version = "0.16.0"
 description = "CLI and SDK for the Roblox Open Cloud APIs"
 authors = ["Stephen Leitnick"]
 license = "MIT"
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,4 +1,4 @@
-Copyright 2024 Stephen Leitnick
+Copyright 2025 Stephen Leitnick
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ Possible use-cases:
 | :white_check_mark: | Messaging |
 | :white_check_mark: | Place Publishing |
 
-| | API v2 (Beta) |
+| | API v2 |
 | -- | -- |
 | :white_check_mark: | Groups |
 | :white_check_mark: | Universes |
@@ -34,6 +34,7 @@ Possible use-cases:
 | :white_check_mark: | User Notifications |
 | :white_check_mark: | User |
 | :x: | Creator Store |
+| :x: | Luau Execution |
 
 - :white_check_mark: = Supported
 - :x: = Not yet supported
diff --git a/docs/cli/cli-assets.md b/docs/cli/cli-assets.md
@@ -0,0 +1,86 @@
+# Assets API
+
+## Get
+Get information on a given asset.
+```
+Usage: rbxcloud.exe assets get [OPTIONS] --asset-id <ASSET_ID> --api-key <API_KEY>
+
+Options:
+  -i, --asset-id <ASSET_ID>    Asset ID
+  -m, --read-mask <READ_MASK>
+  -a, --api-key <API_KEY>      Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
+  -h, --help                   Print help
+```
+
+## Create
+Create a new asset.
+```
+Usage: rbxcloud.exe assets create [OPTIONS] --display-name <DISPLAY_NAME> --description <DESCRIPTION> --creator-id <CREATOR_ID> --creator-type <CREATOR_TYPE> --filepath <FILEPATH> --api-key <API_KEY>
+
+Options:
+  -t, --asset-type <ASSET_TYPE>
+          Asset type [possible values: audio-mp3, audio-ogg, audio-flac, audio-wav, decal-png, decal-jpeg, decal-bmp, decal-tga, model-fbx]
+  -n, --display-name <DISPLAY_NAME>
+          Display name
+  -d, --description <DESCRIPTION>
+          Description
+  -e, --expected-price <EXPECTED_PRICE>
+          Expected Robux price
+  -i, --creator-id <CREATOR_ID>
+          Creator ID
+  -c, --creator-type <CREATOR_TYPE>
+          Creator type [possible values: user, group]
+  -f, --filepath <FILEPATH>
+          File (full or relative path)
+  -a, --api-key <API_KEY>
+          Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
+  -h, --help
+          Print help
+```
+
+## Update
+Update an asset.
+```
+Usage: rbxcloud.exe assets update [OPTIONS] --asset-id <ASSET_ID> --filepath <FILEPATH> --api-key <API_KEY>
+
+Options:
+  -t, --asset-type <ASSET_TYPE>  Asset type [possible values: audio-mp3, audio-ogg, audio-flac, audio-wav, decal-png, decal-jpeg, decal-bmp, decal-tga, model-fbx]
+  -i, --asset-id <ASSET_ID>      Asset ID
+  -f, --filepath <FILEPATH>      File (full or relative path)
+  -a, --api-key <API_KEY>        Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
+  -h, --help                     Print help
+```
+
+## Archive
+Archive an asset.
+```
+Usage: rbxcloud.exe assets archive --asset-id <ASSET_ID> --api-key <API_KEY>
+
+Options:
+  -i, --asset-id <ASSET_ID>  Asset ID
+  -a, --api-key <API_KEY>    Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
+  -h, --help                 Print help
+```
+
+## Restore
+Restore an archived asset.
+```
+Usage: rbxcloud.exe assets restore --asset-id <ASSET_ID> --api-key <API_KEY>
+
+Options:
+  -i, --asset-id <ASSET_ID>  Asset ID
+  -a, --api-key <API_KEY>    Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
+  -h, --help                 Print help
+```
+
+## Get Operation
+Get information on an asset operation.
+```
+Usage: rbxcloud.exe assets get-operation --operation-id <OPERATION_ID> --api-key <API_KEY>
+
+Options:
+  -i, --operation-id <OPERATION_ID>  Operation ID
+  -a, --api-key <API_KEY>            Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
+  -h, --help                         Print help
+
+```
diff --git a/src/cli/assets_cli.rs b/src/cli/assets_cli.rs
@@ -9,7 +9,7 @@ use rbxcloud::rbx::{
             AssetCreation, AssetCreationContext, AssetCreator, AssetGroupCreator, AssetType,
             AssetUserCreator,
         },
-        CreateAsset, GetAsset, RbxCloud, UpdateAsset,
+        ArchiveAsset, CreateAsset, GetAsset, GetAssetOperation, RbxCloud, UpdateAsset,
     },
 };
 
@@ -75,8 +75,8 @@ pub enum AssetsCommands {
         api_key: String,
     },
 
-    /// Get asset information
-    Get {
+    /// Get asset operation information
+    GetOperation {
         /// Operation ID
         #[clap(short = 'i', long, value_parser)]
         operation_id: String,
@@ -85,6 +85,42 @@ pub enum AssetsCommands {
         #[clap(short, long, value_parser, env = "RBXCLOUD_API_KEY")]
         api_key: String,
     },
+
+    /// Get asset information
+    Get {
+        /// Asset ID
+        #[clap(short = 'i', long, value_parser)]
+        asset_id: u64,
+
+        #[clap(short = 'm', long, value_parser)]
+        read_mask: Option<String>,
+
+        /// Roblox Open Cloud API Key
+        #[clap(short, long, value_parser, env = "RBXCLOUD_API_KEY")]
+        api_key: String,
+    },
+
+    /// Archive an asset
+    Archive {
+        /// Asset ID
+        #[clap(short = 'i', long, value_parser)]
+        asset_id: u64,
+
+        /// Roblox Open Cloud API Key
+        #[clap(short, long, value_parser, env = "RBXCLOUD_API_KEY")]
+        api_key: String,
+    },
+
+    /// Restore an archived asset
+    Restore {
+        /// Asset ID
+        #[clap(short = 'i', long, value_parser)]
+        asset_id: u64,
+
+        /// Roblox Open Cloud API Key
+        #[clap(short, long, value_parser, env = "RBXCLOUD_API_KEY")]
+        api_key: String,
+    },
 }
 
 #[derive(Debug, Args)]
@@ -191,13 +227,54 @@ impl Assets {
                 }
             }
 
-            AssetsCommands::Get {
+            AssetsCommands::GetOperation {
                 operation_id,
                 api_key,
             } => {
                 let rbx_cloud = RbxCloud::new(&api_key);
                 let assets = rbx_cloud.assets();
-                let res = assets.get(&GetAsset { operation_id }).await;
+                let res = assets
+                    .get_operation(&GetAssetOperation { operation_id })
+                    .await;
+                match res {
+                    Ok(data) => Ok(Some(format!("{data:#?}"))),
+                    Err(err) => Err(anyhow::anyhow!(err)),
+                }
+            }
+
+            AssetsCommands::Get {
+                asset_id,
+                read_mask,
+                api_key,
+            } => {
+                let rbx_cloud = RbxCloud::new(&api_key);
+                let assets = rbx_cloud.assets();
+                let res = assets
+                    .get(&GetAsset {
+                        asset_id,
+                        read_mask,
+                    })
+                    .await;
+                match res {
+                    Ok(data) => Ok(Some(format!("{data:#?}"))),
+                    Err(err) => Err(anyhow::anyhow!(err)),
+                }
+            }
+
+            AssetsCommands::Archive { asset_id, api_key } => {
+                let rbx_cloud = RbxCloud::new(&api_key);
+                let assets = rbx_cloud.assets();
+                let res = assets.archive(&ArchiveAsset { asset_id }).await;
+                match res {
+                    Ok(data) => Ok(Some(format!("{data:#?}"))),
+                    Err(err) => Err(anyhow::anyhow!(err)),
+                }
+            }
+
+            AssetsCommands::Restore { asset_id, api_key } => {
+                let rbx_cloud = RbxCloud::new(&api_key);
+                let assets = rbx_cloud.assets();
+                let res = assets.restore(&ArchiveAsset { asset_id }).await;
                 match res {
                     Ok(data) => Ok(Some(format!("{data:#?}"))),
                     Err(err) => Err(anyhow::anyhow!(err)),
diff --git a/src/rbx/v1/assets.rs b/src/rbx/v1/assets.rs
diff --git a/src/rbx/v1/mod.rs b/src/rbx/v1/mod.rs

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Copyright 2024 Stephen Leitnick`
	`1`	`+Copyright 2025 Stephen Leitnick`
`2`	`2`
`3`	`3`	`Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:`
`4`	`4`