playfab_ex

defmodule PlayfabEx.Server.PlayerItemManagement do
  use Interface

  @doc """
  Increments  the character's balance of the specified virtual currency by the stated amount

  [online docs](https://api.playfab.com/documentation/server/method/AddCharacterVirtualCurrency)
  """
  @spec add_character_virtual_currency(map()) :: {:ok, map} | {:error, String.t}
  definterface add_character_virtual_currency(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Increments  the user's balance of the specified virtual currency by the stated amount

  [online docs](https://api.playfab.com/documentation/server/method/AddUserVirtualCurrency)
  """
  @spec add_user_virtual_currency(map()) :: {:ok, map} | {:error, String.t}
  definterface add_user_virtual_currency(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory.

  [online docs](https://api.playfab.com/documentation/server/method/ConsumeItem)
  """
  @spec consume_item(map()) :: {:ok, map} | {:error, String.t}
  definterface consume_item(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would have been added to the player inventory, if the Random Result Table were added via a Bundle or a call to UnlockContainer.

  [online docs](https://api.playfab.com/documentation/server/method/EvaluateRandomResultTable)
  """
  @spec evaluate_random_result_table(map()) :: {:ok, map} | {:error, String.t}
  definterface evaluate_random_result_table(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Retrieves the specified character's current inventory of virtual goods

  [online docs](https://api.playfab.com/documentation/server/method/GetCharacterInventory)
  """
  @spec get_character_inventory(map()) :: {:ok, map} | {:error, String.t}
  definterface get_character_inventory(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Retrieves the configuration information for the specified random results tables for the title, including all ItemId values and weights

  [online docs](https://api.playfab.com/documentation/server/method/GetRandomResultTables)
  """
  @spec get_random_result_tables(map()) :: {:ok, map} | {:error, String.t}
  definterface get_random_result_tables(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Retrieves the specified user's current inventory of virtual goods

  [online docs](https://api.playfab.com/documentation/server/method/GetUserInventory)
  """
  @spec get_user_inventory(map()) :: {:ok, map} | {:error, String.t}
  definterface get_user_inventory(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Adds the specified items to the specified character's inventory

  [online docs](https://api.playfab.com/documentation/server/method/GrantItemsToCharacter)
  """
  @spec grant_items_to_character(map()) :: {:ok, map} | {:error, String.t}
  definterface grant_items_to_character(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Adds the specified items to the specified user's inventory

  [online docs](https://api.playfab.com/documentation/server/method/GrantItemsToUser)
  """
  @spec grant_items_to_user(map()) :: {:ok, map} | {:error, String.t}
  definterface grant_items_to_user(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Adds the specified items to the specified user inventories

  [online docs](https://api.playfab.com/documentation/server/method/GrantItemsToUsers)
  """
  @spec grant_items_to_users(map()) :: {:ok, map} | {:error, String.t}
  definterface grant_items_to_users(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Modifies the number of remaining uses of a player's inventory item

  [online docs](https://api.playfab.com/documentation/server/method/ModifyItemUses)
  """
  @spec modify_item_uses(map()) :: {:ok, map} | {:error, String.t}
  definterface modify_item_uses(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Moves an item from a character's inventory into another of the users's character's inventory.

  [online docs](https://api.playfab.com/documentation/server/method/MoveItemToCharacterFromCharacter)
  """
  @spec move_item_to_character_from_character(map()) :: {:ok, map} | {:error, String.t}
  definterface move_item_to_character_from_character(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Moves an item from a user's inventory into their character's inventory.

  [online docs](https://api.playfab.com/documentation/server/method/MoveItemToCharacterFromUser)
  """
  @spec move_item_to_character_from_user(map()) :: {:ok, map} | {:error, String.t}
  definterface move_item_to_character_from_user(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Moves an item from a character's inventory into the owning user's inventory.

  [online docs](https://api.playfab.com/documentation/server/method/MoveItemToUserFromCharacter)
  """
  @spec move_item_to_user_from_character(map()) :: {:ok, map} | {:error, String.t}
  definterface move_item_to_user_from_character(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated  via the Economy->Catalogs tab in the PlayFab Game Manager.

  [online docs](https://api.playfab.com/documentation/server/method/RedeemCoupon)
  """
  @spec redeem_coupon(map()) :: {:ok, map} | {:error, String.t}
  definterface redeem_coupon(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Submit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service representatives for the title can take action concerning potentially toxic players.

  [online docs](https://api.playfab.com/documentation/server/method/ReportPlayer)
  """
  @spec report_player(map()) :: {:ok, map} | {:error, String.t}
  definterface report_player(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Revokes access to an item in a user's inventory

  [online docs](https://api.playfab.com/documentation/server/method/RevokeInventoryItem)
  """
  @spec revoke_inventory_item(map()) :: {:ok, map} | {:error, String.t}
  definterface revoke_inventory_item(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Decrements the character's balance of the specified virtual currency by the stated amount. It is possible to make a VC balance negative with this API.

  [online docs](https://api.playfab.com/documentation/server/method/SubtractCharacterVirtualCurrency)
  """
  @spec subtract_character_virtual_currency(map()) :: {:ok, map} | {:error, String.t}
  definterface subtract_character_virtual_currency(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make a VC balance negative with this API.

  [online docs](https://api.playfab.com/documentation/server/method/SubtractUserVirtualCurrency)
  """
  @spec subtract_user_virtual_currency(map()) :: {:ok, map} | {:error, String.t}
  definterface subtract_user_virtual_currency(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.

  [online docs](https://api.playfab.com/documentation/server/method/UnlockContainerInstance)
  """
  @spec unlock_container_instance(map()) :: {:ok, map} | {:error, String.t}
  definterface unlock_container_instance(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.

  [online docs](https://api.playfab.com/documentation/server/method/UnlockContainerItem)
  """
  @spec unlock_container_item(map()) :: {:ok, map} | {:error, String.t}
  definterface unlock_container_item(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  

  @doc """
  Updates the key-value pair data tagged to the specified item, which is read-only from the client.

  [online docs](https://api.playfab.com/documentation/server/method/UpdateUserInventoryItemCustomData)
  """
  @spec update_user_inventory_item_custom_data(map()) :: {:ok, map} | {:error, String.t}
  definterface update_user_inventory_item_custom_data(params), to: (Application.get_env(:playfab_ex, PlayfabEx.Server.PlayerItemManagement) || PlayfabEx.Server.Default.PlayerItemManagement)
  
end