steamutils 1.0.5 → 1.0.7

package/protos/steammessages_store.steamclient.proto

@@ -0,0 +1,262 @@
+import "steammessages_base.proto";
+import "steammessages_unified_base.steamclient.proto";
+import "enums.proto";
+
+option cc_generic_services = true;
+
+enum EStoreDiscoveryQueueType {
+	k_EStoreDiscoveryQueueTypeNew = 0;
+	k_EStoreDiscoveryQueueTypeComingSoon = 1;
+	k_EStoreDiscoveryQueueTypeRecommended = 2;
+	k_EStoreDiscoveryQueueTypeEveryNewRelease = 3;
+	k_EStoreDiscoveryQueueTypeMLRecommender = 5;
+	k_EStoreDiscoveryQueueTypeWishlistOnSale = 6;
+	k_EStoreDiscoveryQueueTypeDLC = 7;
+	k_EStoreDiscoveryQueueTypeDLCOnSale = 8;
+	k_EStoreDiscoveryQueueTypeRecommendedComingSoon = 9;
+	k_EStoreDiscoveryQueueTypeRecommendedFree = 10;
+	k_EStoreDiscoveryQueueTypeRecommendedOnSale = 11;
+	k_EStoreDiscoveryQueueTypeRecommendedDemos = 12;
+	k_EStoreDiscoveryQueueTypeDLCNewReleases = 13;
+	k_EStoreDiscoveryQueueTypeDLCTopSellers = 14;
+	k_EStoreDiscoveryQueueTypeMAX = 15;
+}
+
+enum EUserReviewScorePreference {
+	k_EUserReviewScorePreference_Unset = 0;
+	k_EUserReviewScorePreference_IncludeAll = 1;
+	k_EUserReviewScorePreference_ExcludeBombs = 2;
+}
+
+message CStore_RegisterCDKey_Request {
+	optional string activation_code = 1 [(description) = "Key string to register on the logged in user's account"];
+	optional int32 purchase_platform = 2 [(description) = "EPurchasePlatform for platform of request"];
+	optional bool is_request_from_client = 3 [(description) = "True if the request was initiated from inside the Steam client"];
+}
+
+message CStore_PurchaseReceiptInfo {
+	message LineItem {
+		optional uint32 packageid = 1;
+		optional uint32 appid = 2;
+		optional string line_item_description = 3;
+	}
+
+	optional uint64 transactionid = 1;
+	optional uint32 packageid = 2;
+	optional uint32 purchase_status = 3;
+	optional uint32 result_detail = 4;
+	optional uint32 transaction_time = 5;
+	optional uint32 payment_method = 6;
+	optional uint64 base_price = 7;
+	optional uint64 total_discount = 8;
+	optional uint64 tax = 9;
+	optional uint64 shipping = 10;
+	optional uint32 currency_code = 11;
+	optional string country_code = 12;
+	optional string error_headline = 13;
+	optional string error_string = 14;
+	optional string error_link_text = 15;
+	optional string error_link_url = 16;
+	optional uint32 error_appid = 17;
+	repeated .CStore_PurchaseReceiptInfo.LineItem line_items = 18;
+}
+
+message CStore_RegisterCDKey_Response {
+	optional int32 purchase_result_details = 1 [(description) = "EPurchaseResultDetails from key activation"];
+	optional .CStore_PurchaseReceiptInfo purchase_receipt_info = 2 [(description) = "Purchase receipt info"];
+}
+
+message CStore_GetMostPopularTags_Request {
+	optional string language = 1;
+}
+
+message CStore_GetMostPopularTags_Response {
+	message Tag {
+		optional uint32 tagid = 1;
+		optional string name = 2;
+	}
+
+	repeated .CStore_GetMostPopularTags_Response.Tag tags = 1;
+}
+
+message CStore_GetLocalizedNameForTags_Request {
+	optional string language = 1;
+	repeated uint32 tagids = 2;
+}
+
+message CStore_GetLocalizedNameForTags_Response {
+	message Tag {
+		optional uint32 tagid = 1;
+		optional string english_name = 2;
+		optional string name = 3;
+		optional string normalized_name = 4 [(description) = "english_name, lowercase, with homoglyphs replaced and spaces and some punctuation removed."];
+	}
+
+	repeated .CStore_GetLocalizedNameForTags_Response.Tag tags = 1;
+}
+
+message CStoreDiscoveryQueueSettings {
+	optional bool os_win = 4;
+	optional bool os_mac = 5;
+	optional bool os_linux = 6;
+	optional bool full_controller_support = 7;
+	optional bool native_steam_controller = 8;
+	optional bool include_coming_soon = 9;
+	repeated uint32 excluded_tagids = 10 [(description) = "Don't return any games with these tags."];
+	optional bool exclude_early_access = 11;
+	optional bool exclude_videos = 12;
+	optional bool exclude_software = 13;
+	optional bool exclude_dlc = 14;
+	optional bool exclude_soundtracks = 15;
+	repeated uint32 featured_tagids = 16 [(description) = "Must be marked with one of these featured tagids (for sale pages and events)"];
+}
+
+message CStore_GetDiscoveryQueue_Request {
+	optional .EStoreDiscoveryQueueType queue_type = 1 [default = k_EStoreDiscoveryQueueTypeNew];
+	optional string country_code = 2;
+	optional bool rebuild_queue = 3;
+	optional bool settings_changed = 4;
+	optional .CStoreDiscoveryQueueSettings settings = 5;
+	optional bool rebuild_queue_if_stale = 6;
+	optional bool ignore_user_preferences = 8;
+	optional bool no_experimental_results = 9;
+	optional uint32 experimental_cohort = 10;
+	optional bool debug_get_solr_query = 11;
+}
+
+message CStore_GetDiscoveryQueue_Response {
+	repeated uint32 appids = 1;
+	optional string country_code = 2;
+	optional .CStoreDiscoveryQueueSettings settings = 3;
+	optional int32 skipped = 4;
+	optional bool exhausted = 5;
+	optional uint32 experimental_cohort = 6;
+	optional string debug_solr_query = 7;
+}
+
+message CStore_GetStorePreferences_Request {
+}
+
+message CStore_UserPreferences {
+	optional int32 primary_language = 1;
+	optional uint32 secondary_languages = 2;
+	optional bool platform_windows = 3;
+	optional bool platform_mac = 4;
+	optional bool platform_linux = 5;
+	optional bool hide_adult_content_violence = 6;
+	optional bool hide_adult_content_sex = 7;
+	optional uint32 timestamp_updated = 8;
+	optional bool hide_store_broadcast = 9;
+	optional .EUserReviewScorePreference review_score_preference = 10 [default = k_EUserReviewScorePreference_Unset];
+	optional int32 timestamp_content_descriptor_preferences_updated = 11;
+	optional .EProvideDeckFeedbackPreference provide_deck_feedback = 12 [default = k_EProvideDeckFeedbackPreference_Unset];
+}
+
+message CStore_UserTagPreferences {
+	message Tag {
+		optional uint32 tagid = 1;
+		optional string name = 2;
+		optional uint32 timestamp_added = 3;
+	}
+
+	repeated .CStore_UserTagPreferences.Tag tags_to_exclude = 1;
+}
+
+message CStore_UserContentDescriptorPreferences {
+	message ContentDescriptor {
+		optional uint32 content_descriptorid = 1;
+		optional uint32 timestamp_added = 2;
+	}
+
+	repeated .CStore_UserContentDescriptorPreferences.ContentDescriptor content_descriptors_to_exclude = 1;
+}
+
+message CStore_GetStorePreferences_Response {
+	optional .CStore_UserPreferences preferences = 1;
+	optional .CStore_UserTagPreferences tag_preferences = 2;
+	optional .CStore_UserContentDescriptorPreferences content_descriptor_preferences = 3;
+}
+
+message CStore_GetTrendingAppsAmongFriends_Request {
+	optional uint32 num_apps = 1;
+	optional uint32 num_top_friends = 2;
+}
+
+message CStore_GetTrendingAppsAmongFriends_Response {
+	message TrendingAppData {
+		optional uint32 appid = 1;
+		repeated uint64 steamids_top_friends = 2;
+		optional uint32 total_friends = 3;
+	}
+
+	repeated .CStore_GetTrendingAppsAmongFriends_Response.TrendingAppData trending_apps = 1;
+}
+
+message CSteamDeckCompatibility_SetFeedback_Request {
+	optional uint32 appid = 1;
+	optional .ESteamDeckCompatibilityFeedback feedback = 2 [default = k_ESteamDeckCompatibilityFeedback_Unset];
+}
+
+message CSteamDeckCompatibility_SetFeedback_Response {
+}
+
+message CSteamDeckCompatibility_ShouldPrompt_Request {
+	optional uint32 appid = 1;
+}
+
+message CSteamDeckCompatibility_ShouldPrompt_Response {
+	optional bool prompt = 1;
+	optional bool feedback_eligible = 2;
+	optional .ESteamDeckCompatibilityFeedback existing_feedback = 3 [default = k_ESteamDeckCompatibilityFeedback_Unset];
+}
+
+message CStore_StorePreferencesChanged_Notification {
+	optional .CStore_UserPreferences preferences = 1;
+	optional .CStore_UserTagPreferences tag_preferences = 2;
+	optional .CStore_UserContentDescriptorPreferences content_descriptor_preferences = 3;
+}
+
+service Store {
+	option (service_description) = "A service to access store data.";
+
+	rpc RegisterCDKey (.CStore_RegisterCDKey_Request) returns (.CStore_RegisterCDKey_Response) {
+		option (method_description) = "Registers a CD key with Steam on the logged in user's account";
+	}
+
+	rpc GetMostPopularTags (.CStore_GetMostPopularTags_Request) returns (.CStore_GetMostPopularTags_Response) {
+		option (method_description) = "Get all whitelisted tags, with localized names.";
+	}
+
+	rpc GetLocalizedNameForTags (.CStore_GetLocalizedNameForTags_Request) returns (.CStore_GetLocalizedNameForTags_Response) {
+		option (method_description) = "Gets tag names in a different language";
+	}
+
+	rpc GetDiscoveryQueue (.CStore_GetDiscoveryQueue_Request) returns (.CStore_GetDiscoveryQueue_Response) {
+		option (method_description) = "Get a list of games for the user to explore on the store.";
+	}
+
+	rpc GetStorePreferences (.CStore_GetStorePreferences_Request) returns (.CStore_GetStorePreferences_Response) {
+		option (method_description) = "Returns the desired ratings board and maximum rating to show on the store";
+	}
+
+	rpc GetTrendingAppsAmongFriends (.CStore_GetTrendingAppsAmongFriends_Request) returns (.CStore_GetTrendingAppsAmongFriends_Response) {
+		option (method_description) = "Get trending apps among friends";
+	}
+
+	rpc SetCompatibilityFeedback (.CSteamDeckCompatibility_SetFeedback_Request) returns (.CSteamDeckCompatibility_SetFeedback_Response) {
+		option (method_description) = "Upserts user feedback regarding the published Steam Deck Compatibility rating for a game";
+	}
+
+	rpc ShouldPromptForCompatibilityFeedback (.CSteamDeckCompatibility_ShouldPrompt_Request) returns (.CSteamDeckCompatibility_ShouldPrompt_Response) {
+		option (method_description) = "Returns whether we should ask the user if the compatibility rating is correct";
+	}
+}
+
+service StoreClient {
+	option (service_description) = "Steam store to client notifications";
+	option (service_execution_site) = k_EProtoExecutionSiteSteamClient;
+
+	rpc NotifyStorePreferencesChanged (.CStore_StorePreferencesChanged_Notification) returns (.NoResponse) {
+		option (method_description) = "Notification from server to client that the user's store preferences have changed";
+	}
+}

package/protos/steammessages_timedtrial.steamclient.proto

@@ -0,0 +1,50 @@
+import "steammessages_base.proto";
+import "steammessages_unified_base.steamclient.proto";
+
+option cc_generic_services = true;
+
+message CTimedTrial_GetTimeRemaining_Request {
+	optional uint32 appid = 1;
+}
+
+message CTimedTrial_GetTimeRemaining_Response {
+	optional uint32 seconds_played = 1;
+	optional uint32 seconds_allowed = 2;
+	optional uint32 packageid = 3;
+	optional uint32 mastersub_appid = 4;
+}
+
+message CTimedTrial_RecordPlaytime_Request {
+	optional uint32 appid = 1;
+	optional uint32 seconds_played = 2;
+}
+
+message CTimedTrial_RecordPlaytime_Response {
+	optional uint32 seconds_played = 1;
+	optional uint32 seconds_allowed = 2;
+}
+
+message CTimedTrial_ResetPlaytime_Request {
+	optional uint32 appid = 1;
+}
+
+message CTimedTrial_ResetPlaytime_Response {
+	optional uint32 seconds_played = 1;
+	optional uint32 seconds_allowed = 2;
+}
+
+service TimedTrial {
+	option (service_description) = "A service to get user timed trial information";
+
+	rpc GetTimeRemaining (.CTimedTrial_GetTimeRemaining_Request) returns (.CTimedTrial_GetTimeRemaining_Response) {
+		option (method_description) = "Returns the amount of time a user has left on a timed trial for an app";
+	}
+
+	rpc RecordPlaytime (.CTimedTrial_RecordPlaytime_Request) returns (.CTimedTrial_RecordPlaytime_Response) {
+		option (method_description) = "Updates the user's remaining playtime while in game";
+	}
+
+	rpc ResetPlaytime (.CTimedTrial_ResetPlaytime_Request) returns (.CTimedTrial_ResetPlaytime_Response) {
+		option (method_description) = "Reset the user's remaining playtime (developer only)";
+	}
+}

package/protos/steammessages_twofactor.steamclient.proto

@@ -0,0 +1,154 @@
+import "steammessages_base.proto";
+import "steammessages_unified_base.steamclient.proto";
+
+option cc_generic_services = true;
+
+message CTwoFactor_Status_Request {
+	optional fixed64 steamid = 1 [(description) = "steamid to use"];
+}
+
+message CTwoFactor_Status_Response {
+	optional uint32 state = 1 [(description) = "Authenticator state"];
+	optional uint32 inactivation_reason = 2 [(description) = "Inactivation reason (if any)"];
+	optional uint32 authenticator_type = 3 [(description) = "Type of authenticator"];
+	optional bool authenticator_allowed = 4 [(description) = "Account allowed to have an authenticator?"];
+	optional uint32 steamguard_scheme = 5 [(description) = "Steam Guard scheme in effect"];
+	optional string token_gid = 6 [(description) = "String rep of token GID assigned by server"];
+	optional bool email_validated = 7 [(description) = "Account has verified email capability"];
+	optional string device_identifier = 8 [(description) = "Authenticator (phone) identifier"];
+	optional uint32 time_created = 9 [(description) = "When the token was created"];
+	optional uint32 revocation_attempts_remaining = 10 [(description) = "Number of revocation code attempts remaining"];
+	optional string classified_agent = 11 [(description) = "Agent that added the authenticator (e.g., ios / android / other)"];
+	optional bool allow_external_authenticator = 12 [(description) = "Allow a third-party authenticator (in addition to two-factor)"];
+	optional uint32 time_transferred = 13 [(description) = "When the token was transferred from another device, if applicable"];
+}
+
+message CTwoFactor_AddAuthenticator_Request {
+	optional fixed64 steamid = 1 [(description) = "steamid to use"];
+	optional uint64 authenticator_time = 2 [(description) = "Current authenticator time"];
+	optional fixed64 serial_number = 3 [(description) = "locally computed serial (deprecated)"];
+	optional uint32 authenticator_type = 4 [(description) = "Authenticator type"];
+	optional string device_identifier = 5 [(description) = "Authenticator identifier"];
+	optional string sms_phone_id = 6 [(description) = "ID of phone to use for SMS verification"];
+	repeated string http_headers = 7 [(description) = "HTTP headers alternating by K/V"];
+}
+
+message CTwoFactor_AddAuthenticator_Response {
+	optional bytes shared_secret = 1 [(description) = "Shared secret between server and authenticator"];
+	optional fixed64 serial_number = 2 [(description) = "Authenticator serial number (unique per token)"];
+	optional string revocation_code = 3 [(description) = "code used to revoke authenticator"];
+	optional string uri = 4 [(description) = "URI for QR code generation"];
+	optional uint64 server_time = 5 [(description) = "Current server time"];
+	optional string account_name = 6 [(description) = "Account name to display on token client"];
+	optional string token_gid = 7 [(description) = "Token GID assigned by server"];
+	optional bytes identity_secret = 8 [(description) = "Secret used for identity attestation (e.g., for eventing)"];
+	optional bytes secret_1 = 9 [(description) = "Spare shared secret"];
+	optional int32 status = 10 [(description) = "Result code"];
+}
+
+message CTwoFactor_SendEmail_Request {
+	optional fixed64 steamid = 1 [(description) = "Steamid to use"];
+	optional uint32 email_type = 2 [(description) = "Type of email to send (ETwoFactorEmailType::*)"];
+	optional bool include_activation_code = 3 [(description) = "Include activation code in email parameters"];
+}
+
+message CTwoFactor_SendEmail_Response {
+}
+
+message CTwoFactor_FinalizeAddAuthenticator_Request {
+	optional fixed64 steamid = 1 [(description) = "steamid to use"];
+	optional string authenticator_code = 2 [(description) = "Current auth code"];
+	optional uint64 authenticator_time = 3 [(description) = "Current authenticator time"];
+	optional string activation_code = 4 [(description) = "Activation code from out-of-band message"];
+	repeated string http_headers = 5 [(description) = "HTTP headers alternating by K/V"];
+}
+
+message CTwoFactor_FinalizeAddAuthenticator_Response {
+	optional bool success = 1 [(description) = "True if succeeded, or want more tries"];
+	optional bool want_more = 2 [(description) = "True if want more tries"];
+	optional uint64 server_time = 3 [(description) = "Current server time"];
+	optional int32 status = 4 [(description) = "Result code"];
+}
+
+message CTwoFactor_UpdateTokenVersion_Request {
+	optional uint32 version = 2 [(description) = "What the version of our token should be"];
+}
+
+message CTwoFactor_UpdateTokenVersion_Response {
+}
+
+message CTwoFactor_RemoveAuthenticator_Request {
+	optional string revocation_code = 2 [(description) = "Password needed to remove token"];
+	optional uint32 revocation_reason = 5 [(description) = "Reason the authenticator is being removed"];
+	optional uint32 steamguard_scheme = 6 [(description) = "Type of Steam Guard to use once token is removed"];
+	optional bool remove_all_steamguard_cookies = 7 [(description) = "Remove all steamguard cookies"];
+}
+
+message CTwoFactor_RemoveAuthenticator_Response {
+	optional bool success = 1 [(description) = "True if request succeeeded. The mobile app checks this."];
+	optional uint64 server_time = 3 [(description) = "Current server time"];
+	optional uint32 revocation_attempts_remaining = 5 [(description) = "Number of revocation code attempts remaining"];
+}
+
+message CTwoFactor_CreateEmergencyCodes_Request {
+	optional string code = 1;
+}
+
+message CTwoFactor_CreateEmergencyCodes_Response {
+	repeated string codes = 1 [(description) = "Emergency codes"];
+}
+
+message CTwoFactor_DestroyEmergencyCodes_Request {
+	optional fixed64 steamid = 1 [(description) = "steamid to use"];
+}
+
+message CTwoFactor_DestroyEmergencyCodes_Response {
+}
+
+message CTwoFactor_ValidateToken_Request {
+	optional string code = 1 [(description) = "code to validate"];
+}
+
+message CTwoFactor_ValidateToken_Response {
+	optional bool valid = 1 [(description) = "result of validation"];
+}
+
+service TwoFactor {
+	option (service_description) = "Two Factor Authentication Service";
+
+	rpc QueryStatus (.CTwoFactor_Status_Request) returns (.CTwoFactor_Status_Response) {
+		option (method_description) = "Get two-factor authentication settings for the logged-in account";
+	}
+
+	rpc AddAuthenticator (.CTwoFactor_AddAuthenticator_Request) returns (.CTwoFactor_AddAuthenticator_Response) {
+		option (method_description) = "Add two-factor authenticator to the logged-in account";
+	}
+
+	rpc SendEmail (.CTwoFactor_SendEmail_Request) returns (.CTwoFactor_SendEmail_Response) {
+		option (method_description) = "Send email to the account";
+	}
+
+	rpc FinalizeAddAuthenticator (.CTwoFactor_FinalizeAddAuthenticator_Request) returns (.CTwoFactor_FinalizeAddAuthenticator_Response) {
+		option (method_description) = "Finalize two-factor authentication addition to the logged-in account";
+	}
+
+	rpc UpdateTokenVersion (.CTwoFactor_UpdateTokenVersion_Request) returns (.CTwoFactor_UpdateTokenVersion_Response) {
+		option (method_description) = "Update the version for my token";
+	}
+
+	rpc RemoveAuthenticator (.CTwoFactor_RemoveAuthenticator_Request) returns (.CTwoFactor_RemoveAuthenticator_Response) {
+		option (method_description) = "Remove two-factor authentication addition from the logged-in account";
+	}
+
+	rpc CreateEmergencyCodes (.CTwoFactor_CreateEmergencyCodes_Request) returns (.CTwoFactor_CreateEmergencyCodes_Response) {
+		option (method_description) = "Generate emergency authenticator codes";
+	}
+
+	rpc DestroyEmergencyCodes (.CTwoFactor_DestroyEmergencyCodes_Request) returns (.CTwoFactor_DestroyEmergencyCodes_Response) {
+		option (method_description) = "Destroy emergency authenticator codes for the account";
+	}
+
+	rpc ValidateToken (.CTwoFactor_ValidateToken_Request) returns (.CTwoFactor_ValidateToken_Response) {
+		option (method_description) = "Validate (and consume) a token";
+	}
+}

package/protos/steammessages_unified_base.steamclient.proto

@@ -0,0 +1,33 @@
+import "google/protobuf/descriptor.proto";
+
+option optimize_for = SPEED;
+option cc_generic_services = false;
+
+extend .google.protobuf.FieldOptions {
+	optional string description = 50000;
+}
+
+extend .google.protobuf.ServiceOptions {
+	optional string service_description = 50000;
+	optional .EProtoExecutionSite service_execution_site = 50008 [default = k_EProtoExecutionSiteUnknown];
+}
+
+extend .google.protobuf.MethodOptions {
+	optional string method_description = 50000;
+}
+
+extend .google.protobuf.EnumOptions {
+	optional string enum_description = 50000;
+}
+
+extend .google.protobuf.EnumValueOptions {
+	optional string enum_value_description = 50000;
+}
+
+enum EProtoExecutionSite {
+	k_EProtoExecutionSiteUnknown = 0;
+	k_EProtoExecutionSiteSteamClient = 2;
+}
+
+message NoResponse {
+}

package/protos/steammessages_unified_test.steamclient.proto

@@ -0,0 +1,50 @@
+import "steammessages_base.proto";
+import "steammessages_unified_base.steamclient.proto";
+
+option cc_generic_services = true;
+
+message CMsgTest_MessageToClient_Request {
+	optional string some_text = 1 [(description) = "Some string."];
+}
+
+message CMsgTest_MessageToClient_Response {
+	optional string some_text = 1 [(description) = "Some string."];
+}
+
+message CMsgTest_NotifyClient_Notification {
+	optional string some_text = 1 [(description) = "Some string."];
+}
+
+message CMsgTest_MessageToServer_Request {
+	optional string some_text = 1 [(description) = "Some string."];
+}
+
+message CMsgTest_MessageToServer_Response {
+	optional string some_text = 1 [(description) = "Some string."];
+}
+
+message CMsgTest_NotifyServer_Notification {
+	optional string some_text = 1 [(description) = "Some string."];
+}
+
+service TestSteamClient {
+	option (service_execution_site) = k_EProtoExecutionSiteSteamClient;
+
+	rpc MessageToClient (.CMsgTest_MessageToClient_Request) returns (.CMsgTest_MessageToClient_Response) {
+		option (method_description) = "Some description - MessageToClient.";
+	}
+
+	rpc NotifyClient (.CMsgTest_NotifyClient_Notification) returns (.NoResponse) {
+		option (method_description) = "Some description - NotifyClient.";
+	}
+}
+
+service TestServerFromClient {
+	rpc MessageToServer (.CMsgTest_MessageToServer_Request) returns (.CMsgTest_MessageToServer_Response) {
+		option (method_description) = "Some description - MessageToServer.";
+	}
+
+	rpc NotifyServer (.CMsgTest_NotifyServer_Notification) returns (.NoResponse) {
+		option (method_description) = "Some description - NotifyServer.";
+	}
+}