#if !DISABLE_PLAYFABENTITY_API
using System;
using System.Collections.Generic;
using PlayFab.SharedModels;
namespace PlayFab.AddonModels
{
[Serializable]
public class CreateOrUpdateAppleRequest : PlayFabRequestCommon
{
///
/// iOS App Bundle ID obtained after setting up your app in the App Store.
///
public string AppBundleId;
///
/// iOS App Shared Secret obtained after setting up your app in the App Store.
///
public string AppSharedSecret;
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
///
/// If an error should be returned if the addon already exists.
///
public bool? ErrorIfExists;
///
/// Ignore expiration date for identity tokens. Be aware that when set to true this can invalidate expired tokens in the
/// case where Apple rotates their signing keys.
///
public bool? IgnoreExpirationDate;
///
/// Require secure authentication only for this app.
///
public bool? RequireSecureAuthentication;
}
[Serializable]
public class CreateOrUpdateAppleResponse : PlayFabResultCommon
{
}
[Serializable]
public class CreateOrUpdateFacebookInstantGamesRequest : PlayFabRequestCommon
{
///
/// Facebook App ID obtained after setting up your app in Facebook Instant Games.
///
public string AppID;
///
/// Facebook App Secret obtained after setting up your app in Facebook Instant Games.
///
public string AppSecret;
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
///
/// If an error should be returned if the addon already exists.
///
public bool? ErrorIfExists;
}
[Serializable]
public class CreateOrUpdateFacebookInstantGamesResponse : PlayFabResultCommon
{
}
[Serializable]
public class CreateOrUpdateFacebookRequest : PlayFabRequestCommon
{
///
/// Facebook App ID obtained after setting up your app in Facebook.
///
public string AppID;
///
/// Facebook App Secret obtained after setting up your app in Facebook.
///
public string AppSecret;
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
///
/// If an error should be returned if the addon already exists.
///
public bool? ErrorIfExists;
///
/// Email address for purchase dispute notifications.
///
public string NotificationEmail;
}
[Serializable]
public class CreateOrUpdateFacebookResponse : PlayFabResultCommon
{
}
[Serializable]
public class CreateOrUpdateGoogleRequest : PlayFabRequestCommon
{
///
/// Google App License Key obtained after setting up your app in the Google Play developer portal. Required if using Google
/// receipt validation.
///
public string AppLicenseKey;
///
/// Google App Package ID obtained after setting up your app in the Google Play developer portal. Required if using Google
/// receipt validation.
///
public string AppPackageID;
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
///
/// If an error should be returned if the addon already exists.
///
public bool? ErrorIfExists;
///
/// Google OAuth Client ID obtained through the Google Developer Console by creating a new set of "OAuth Client ID".
/// Required if using Google Authentication.
///
public string OAuthClientID;
///
/// Google OAuth Client Secret obtained through the Google Developer Console by creating a new set of "OAuth Client ID".
/// Required if using Google Authentication.
///
public string OAuthClientSecret;
///
/// Authorized Redirect Uri obtained through the Google Developer Console. This currently defaults to
/// https://oauth.playfab.com/oauth2/google. If you are authenticating players via browser, please update this to your own
/// domain.
///
public string OAuthCustomRedirectUri;
///
/// Needed to enable pending purchase handling and subscription processing.
///
public string ServiceAccountKey;
}
[Serializable]
public class CreateOrUpdateGoogleResponse : PlayFabResultCommon
{
}
[Serializable]
public class CreateOrUpdateKongregateRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
///
/// If an error should be returned if the addon already exists.
///
public bool? ErrorIfExists;
///
/// Kongregate Secret API Key obtained after setting up your game in your Kongregate developer account.
///
public string SecretAPIKey;
}
[Serializable]
public class CreateOrUpdateKongregateResponse : PlayFabResultCommon
{
}
[Serializable]
public class CreateOrUpdateNintendoRequest : PlayFabRequestCommon
{
///
/// Nintendo Switch Application ID, without the "0x" prefix.
///
public string ApplicationID;
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
///
/// List of Nintendo Environments, currently supporting up to 4. Needs Catalog enabled.
///
public List Environments;
///
/// If an error should be returned if the addon already exists.
///
public bool? ErrorIfExists;
}
[Serializable]
public class CreateOrUpdateNintendoResponse : PlayFabResultCommon
{
}
[Serializable]
public class CreateOrUpdatePSNRequest : PlayFabRequestCommon
{
///
/// Client ID obtained after setting up your game with Sony. This one is associated with the existing PS4 marketplace.
///
public string ClientID;
///
/// Client secret obtained after setting up your game with Sony. This one is associated with the existing PS4 marketplace.
///
public string ClientSecret;
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
///
/// If an error should be returned if the addon already exists.
///
public bool? ErrorIfExists;
///
/// Client ID obtained after setting up your game with Sony. This one is associated with the modern marketplace, which
/// includes PS5, cross-generation for PS4, and unified entitlements.
///
public string NextGenClientID;
///
/// Client secret obtained after setting up your game with Sony. This one is associated with the modern marketplace, which
/// includes PS5, cross-generation for PS4, and unified entitlements.
///
public string NextGenClientSecret;
}
[Serializable]
public class CreateOrUpdatePSNResponse : PlayFabResultCommon
{
}
[Serializable]
public class CreateOrUpdateSteamRequest : PlayFabRequestCommon
{
///
/// Application ID obtained after setting up your app in Valve's developer portal.
///
public string ApplicationId;
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// Enforce usage of AzurePlayFab identity in user authentication tickets.
///
public bool? EnforceServiceSpecificTickets;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
///
/// If an error should be returned if the addon already exists.
///
public bool? ErrorIfExists;
///
/// Sercet Key obtained after setting up your app in Valve's developer portal.
///
public string SecretKey;
///
/// Use Steam Payments sandbox endpoint for test transactions.
///
public bool? UseSandbox;
}
[Serializable]
public class CreateOrUpdateSteamResponse : PlayFabResultCommon
{
}
[Serializable]
public class CreateOrUpdateTwitchRequest : PlayFabRequestCommon
{
///
/// Client ID obtained after creating your Twitch developer account.
///
public string ClientID;
///
/// Client Secret obtained after creating your Twitch developer account.
///
public string ClientSecret;
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
///
/// If an error should be returned if the addon already exists.
///
public bool? ErrorIfExists;
}
[Serializable]
public class CreateOrUpdateTwitchResponse : PlayFabResultCommon
{
}
[Serializable]
public class DeleteAppleRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
}
[Serializable]
public class DeleteAppleResponse : PlayFabResultCommon
{
}
[Serializable]
public class DeleteFacebookInstantGamesRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
}
[Serializable]
public class DeleteFacebookInstantGamesResponse : PlayFabResultCommon
{
}
[Serializable]
public class DeleteFacebookRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
}
[Serializable]
public class DeleteFacebookResponse : PlayFabResultCommon
{
}
[Serializable]
public class DeleteGoogleRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
}
[Serializable]
public class DeleteGoogleResponse : PlayFabResultCommon
{
}
[Serializable]
public class DeleteKongregateRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
}
[Serializable]
public class DeleteKongregateResponse : PlayFabResultCommon
{
}
[Serializable]
public class DeleteNintendoRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
}
[Serializable]
public class DeleteNintendoResponse : PlayFabResultCommon
{
}
[Serializable]
public class DeletePSNRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
}
[Serializable]
public class DeletePSNResponse : PlayFabResultCommon
{
}
[Serializable]
public class DeleteSteamRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
}
[Serializable]
public class DeleteSteamResponse : PlayFabResultCommon
{
}
[Serializable]
public class DeleteTwitchRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
}
[Serializable]
public class DeleteTwitchResponse : PlayFabResultCommon
{
}
///
/// Combined entity type and ID structure which uniquely identifies a single entity.
///
[Serializable]
public class EntityKey : PlayFabBaseModel
{
///
/// Unique ID of the entity.
///
public string Id;
///
/// Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types
///
public string Type;
}
[Serializable]
public class GetAppleRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
}
[Serializable]
public class GetAppleResponse : PlayFabResultCommon
{
///
/// iOS App Bundle ID obtained after setting up your app in the App Store.
///
public string AppBundleId;
///
/// Addon status.
///
public bool Created;
///
/// Ignore expiration date for identity tokens.
///
public bool? IgnoreExpirationDate;
///
/// Require secure authentication only for this app.
///
public bool? RequireSecureAuthentication;
}
[Serializable]
public class GetFacebookInstantGamesRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
}
[Serializable]
public class GetFacebookInstantGamesResponse : PlayFabResultCommon
{
///
/// Facebook App ID obtained after setting up your app in Facebook Instant Games.
///
public string AppID;
///
/// Addon status.
///
public bool Created;
}
[Serializable]
public class GetFacebookRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
}
[Serializable]
public class GetFacebookResponse : PlayFabResultCommon
{
///
/// Facebook App ID obtained after setting up your app in Facebook.
///
public string AppID;
///
/// Addon status.
///
public bool Created;
///
/// Email address for purchase dispute notifications.
///
public string NotificationEmail;
}
[Serializable]
public class GetGoogleRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
}
[Serializable]
public class GetGoogleResponse : PlayFabResultCommon
{
///
/// Google App Package ID obtained after setting up your app in the Google Play developer portal. Required if using Google
/// receipt validation.
///
public string AppPackageID;
///
/// Addon status.
///
public bool Created;
///
/// Google OAuth Client ID obtained through the Google Developer Console by creating a new set of "OAuth Client ID".
/// Required if using Google Authentication.
///
public string OAuthClientID;
///
/// Authorized Redirect Uri obtained through the Google Developer Console. This currently defaults to
/// https://oauth.playfab.com/oauth2/google. If you are authenticating players via browser, please update this to your own
/// domain.
///
public string OauthCustomRedirectUri;
}
[Serializable]
public class GetKongregateRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
}
[Serializable]
public class GetKongregateResponse : PlayFabResultCommon
{
///
/// Addon status.
///
public bool Created;
}
[Serializable]
public class GetNintendoRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
}
[Serializable]
public class GetNintendoResponse : PlayFabResultCommon
{
///
/// Nintendo Switch Application ID, without the "0x" prefix.
///
public string ApplicationID;
///
/// Addon status.
///
public bool Created;
///
/// List of Nintendo Environments, currently supporting up to 4.
///
public List Environments;
}
[Serializable]
public class GetPSNRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
}
[Serializable]
public class GetPSNResponse : PlayFabResultCommon
{
///
/// Client ID obtained after setting up your game with Sony. This one is associated with the existing PS4 marketplace.
///
public string ClientID;
///
/// Addon status.
///
public bool Created;
///
/// Client ID obtained after setting up your game with Sony. This one is associated with the modern marketplace, which
/// includes PS5, cross-generation for PS4, and unified entitlements.
///
public string NextGenClientID;
}
[Serializable]
public class GetSteamRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
}
[Serializable]
public class GetSteamResponse : PlayFabResultCommon
{
///
/// Application ID obtained after setting up your game in Valve's developer portal.
///
public string ApplicationId;
///
/// Addon status.
///
public bool Created;
///
/// Enforce usage of AzurePlayFab identity in user authentication tickets.
///
public bool? EnforceServiceSpecificTickets;
///
/// Use Steam Payments sandbox endpoint for test transactions.
///
public bool? UseSandbox;
}
[Serializable]
public class GetTwitchRequest : PlayFabRequestCommon
{
///
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
///
public Dictionary CustomTags;
///
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
///
public EntityKey Entity;
}
[Serializable]
public class GetTwitchResponse : PlayFabResultCommon
{
///
/// Client ID obtained after creating your Twitch developer account.
///
public string ClientID;
///
/// Addon status.
///
public bool Created;
}
[Serializable]
public class NintendoEnvironment : PlayFabBaseModel
{
///
/// Client ID for the Nintendo Environment.
///
public string ClientID;
///
/// Client Secret for the Nintendo Environment.
///
public string ClientSecret;
///
/// ID for the Nintendo Environment.
///
public string ID;
}
}
#endif