VRChat.Economy (vrchat v1.20.0)

View Source

API calls for all endpoints tagged Economy.

Summary

Functions

Get Balance Gets the balance of a user

Get Current Subscriptions Get a list of all current user subscriptions.

Get License Group Get a single License Group by given ID.

Get Product Listing Gets a product listing

Get User Product Listings Gets the product listings of a given user

Get Steam Transaction Get a single Steam transactions by ID. This returns the exact same information as getSteamTransactions, so no point in using this endpoint.

List Steam Transactions Get all own Steam transactions.

List Subscriptions List all existing Subscriptions. For example, "vrchatplus-monthly" and "vrchatplus-yearly".

Get Tilia Status Gets the status of Tilia integration

Get Tilia TOS Agreement Status Gets the status of the agreement of a user to the Tilia TOS

List Token Bundles Gets the list of token bundles

Functions

get_balance(connection, user_id, opts \\ [])

@spec get_balance(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.Balance.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Get Balance Gets the balance of a user

Parameters

  • connection (VRChat.Connection): Connection to server
  • user_id (String.t): Must be a valid user ID.
  • opts (keyword): Optional parameters

Returns

  • {:ok, VRChat.Model.Balance.t} on success
  • {:error, Tesla.Env.t} on failure

get_current_subscriptions(connection, opts \\ [])

@spec get_current_subscriptions(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [VRChat.Model.UserSubscription.t()]}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Get Current Subscriptions Get a list of all current user subscriptions.

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, [%UserSubscription{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

get_license_group(connection, license_group_id, opts \\ [])

@spec get_license_group(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.LicenseGroup.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Get License Group Get a single License Group by given ID.

Parameters

  • connection (VRChat.Connection): Connection to server
  • license_group_id (String.t): Must be a valid license group ID.
  • opts (keyword): Optional parameters

Returns

  • {:ok, VRChat.Model.LicenseGroup.t} on success
  • {:error, Tesla.Env.t} on failure

get_product_listing(connection, product_id, opts \\ [])

@spec get_product_listing(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.ProductListing.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Get Product Listing Gets a product listing

Parameters

  • connection (VRChat.Connection): Connection to server
  • product_id (String.t): Must be a valid product ID.
  • opts (keyword): Optional parameters
    • :hydrate (boolean()): Populates some fields and changes types of others for certain objects.

Returns

  • {:ok, VRChat.Model.ProductListing.t} on success
  • {:error, Tesla.Env.t} on failure

get_product_listings(connection, user_id, opts \\ [])

@spec get_product_listings(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.Error.t()}
  | {:ok, [VRChat.Model.ProductListing.t()]}
  | {:error, Tesla.Env.t()}

Get User Product Listings Gets the product listings of a given user

Parameters

  • connection (VRChat.Connection): Connection to server
  • user_id (String.t): Must be a valid user ID.
  • opts (keyword): Optional parameters
    • :n (integer()): The number of objects to return.
    • :offset (integer()): A zero-based offset from the default object sorting from where search results start.
    • :hydrate (boolean()): Populates some fields and changes types of others for certain objects.
    • :groupId (String.t): Must be a valid group ID.
    • :active (boolean()): Filter for users' listings.

Returns

  • {:ok, [%ProductListing{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

get_steam_transaction(connection, transaction_id, opts \\ [])

@spec get_steam_transaction(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.Transaction.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Get Steam Transaction Get a single Steam transactions by ID. This returns the exact same information as getSteamTransactions, so no point in using this endpoint.

Parameters

  • connection (VRChat.Connection): Connection to server
  • transaction_id (String.t): Must be a valid transaction ID.
  • opts (keyword): Optional parameters

Returns

  • {:ok, VRChat.Model.Transaction.t} on success
  • {:error, Tesla.Env.t} on failure

get_steam_transactions(connection, opts \\ [])

@spec get_steam_transactions(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, VRChat.Model.Error.t()}
  | {:ok, [VRChat.Model.Transaction.t()]}
  | {:error, Tesla.Env.t()}

List Steam Transactions Get all own Steam transactions.

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, [%Transaction{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

get_subscriptions(connection, opts \\ [])

@spec get_subscriptions(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [VRChat.Model.Subscription.t()]}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

List Subscriptions List all existing Subscriptions. For example, "vrchatplus-monthly" and "vrchatplus-yearly".

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, [%Subscription{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

get_tilia_status(connection, opts \\ [])

@spec get_tilia_status(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, VRChat.Model.TiliaStatus.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Get Tilia Status Gets the status of Tilia integration

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, VRChat.Model.TiliaStatus.t} on success
  • {:error, Tesla.Env.t} on failure

get_tilia_tos(connection, user_id, opts \\ [])

@spec get_tilia_tos(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.TiliaTos.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Get Tilia TOS Agreement Status Gets the status of the agreement of a user to the Tilia TOS

Parameters

  • connection (VRChat.Connection): Connection to server
  • user_id (String.t): Must be a valid user ID.
  • opts (keyword): Optional parameters

Returns

  • {:ok, VRChat.Model.TiliaTos.t} on success
  • {:error, Tesla.Env.t} on failure

get_token_bundles(connection, opts \\ [])

@spec get_token_bundles(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [VRChat.Model.TokenBundle.t()]}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

List Token Bundles Gets the list of token bundles

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, [%TokenBundle{}, ...]} on success
  • {:error, Tesla.Env.t} on failure