Cloud Code Services SDKs

CurrenciesApi

Import

Import

const { CurrenciesApi } = require("@unity-services/economy-2.0");

Constructors

Constructor

new CurrenciesApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): CurrenciesApi

Parameters
- Optional configuration: Configuration
- basePath: string = ...
- axios: AxiosInstance = ...
Returns CurrenciesApi

Methods

Decrement Player Currency Balance

decrementPlayerCurrencyBalance(projectId: string, playerId: string, currencyId: string, currencyModifyBalanceRequest?: CurrencyModifyBalanceRequest, options?: any): Promise<AxiosResponse<CurrencyBalanceResponse>>

Decrements a player's currency balance by a given value.

summary

Decrement Currency Balance

throws

{RequiredError}

memberof

CurrenciesApi

Parameters
- projectId: string
  
  ID of the project
- playerId: string
  
  ID of the player
- currencyId: string
- Optional currencyModifyBalanceRequest: CurrencyModifyBalanceRequest
- Optional options: any
Returns Promise<AxiosResponse<CurrencyBalanceResponse>>

Get Player Currencies

getPlayerCurrencies(projectId: string, playerId: string, after?: string, limit?: number, options?: any): Promise<AxiosResponse<PlayerCurrencyBalanceResponse>>

Get a list of currency balances for a player. Results ordered by Currency ID ascending.

summary

Player Currency Balances

throws

{RequiredError}

memberof

CurrenciesApi

Parameters
- projectId: string
  
  ID of the project
- playerId: string
  
  ID of the player
- Optional after: string
- Optional limit: number
- Optional options: any
Returns Promise<AxiosResponse<PlayerCurrencyBalanceResponse>>

Increment Player Currency Balance

incrementPlayerCurrencyBalance(projectId: string, playerId: string, currencyId: string, currencyModifyBalanceRequest?: CurrencyModifyBalanceRequest, options?: any): Promise<AxiosResponse<CurrencyBalanceResponse>>

Increment a player's currency balance by a given value.

summary

Increment Currency Balance

throws

{RequiredError}

memberof

CurrenciesApi

Parameters
- projectId: string
  
  ID of the project
- playerId: string
  
  ID of the player
- currencyId: string
- Optional currencyModifyBalanceRequest: CurrencyModifyBalanceRequest
- Optional options: any
Returns Promise<AxiosResponse<CurrencyBalanceResponse>>

Set Player Currency Balance

setPlayerCurrencyBalance(projectId: string, playerId: string, currencyId: string, currencyBalanceRequest?: CurrencyBalanceRequest, options?: any): Promise<AxiosResponse<CurrencyBalanceResponse>>

Set a player's currency balance.

summary

Set Currency Balance

throws

{RequiredError}

memberof

CurrenciesApi

Parameters
- projectId: string
  
  ID of the project
- playerId: string
  
  ID of the player
- currencyId: string
- Optional currencyBalanceRequest: CurrencyBalanceRequest
- Optional options: any
Returns Promise<AxiosResponse<CurrencyBalanceResponse>>