Class PlayersApi

Index

Constructors

Properties

Methods

cancelTransferAccountOwnership createPlayer deletePlayer getPlayer getPlayers requestTransferAccountOwnership updatePlayer

Constructors

constructor

new PlayersApi(configuration, requestFactory?, responseProcessor?): PlayersApi
Parameters
- configuration: Configuration
- Optional requestFactory: PlayersApiRequestFactory
- Optional responseProcessor: PlayersApiResponseProcessor
Returns PlayersApi
- Defined in src/generated/types/PromiseAPI.ts:1433

Properties

`Private` api

api: ObservablePlayersApi

Methods

cancelTransferAccountOwnership

cancelTransferAccountOwnership(id, playerCancelTransferOwnershipRequest, _options?): Promise<TransactionIntentResponse>
This endpoint allows you to cancel a pending transfer of ownership. Cancel request to transfer ownership of a player.
Parameters
- id: string
- playerCancelTransferOwnershipRequest: PlayerCancelTransferOwnershipRequest
- Optional _options: Configuration
Returns Promise<TransactionIntentResponse>
- Defined in src/generated/types/PromiseAPI.ts:1447

createPlayer

createPlayer(playerCreateRequest, _options?): Promise<PlayerResponse>
Creates a player. Create a player object.
Parameters
- playerCreateRequest: PlayerCreateRequest
- Optional _options: Configuration
Returns Promise<PlayerResponse>
- Defined in src/generated/types/PromiseAPI.ts:1457

deletePlayer

deletePlayer(id, _options?): Promise<PlayerDeleteResponse>
It will delete all linked accounts the player is authenticated with. If the player has a linked embedded signer, it will be deleted as well. Deletes a player object.
Parameters
- id: string
  Specifies the unique player ID (starts with pla_).
- Optional _options: Configuration
Returns Promise<PlayerDeleteResponse>
- Defined in src/generated/types/PromiseAPI.ts:1467

getPlayer

getPlayer(id, expand?, _options?): Promise<PlayerResponse>
Retrieves the details of a player that has previously been created. Returns the latest 10 transaction intents that were created with this player. Retrieves the details of an existing player.
Parameters
- id: string
  Specifies the unique player ID (starts with pla_).
- Optional expand: PlayerResponseExpandable[]
  Specifies the expandable fields.
- Optional _options: Configuration
Returns Promise<PlayerResponse>
- Defined in src/generated/types/PromiseAPI.ts:1478

getPlayers

getPlayers(limit?, skip?, order?, expand?, name?, _options?): Promise<PlayerListResponse>
By default, a maximum of 10 players are shown. Returns the latest 10 transaction intents that were created with each player. List players.
Parameters
- Optional limit: number
  Specifies the maximum number of records to return.
- Optional skip: number
  Specifies the offset for the first records to return.
- Optional order: SortOrder
  Specifies the order in which to sort the results.
- Optional expand: PlayerResponseExpandable[]
  Specifies the fields to expand in the response.
- Optional name: string
  Filter by player name.
- Optional _options: Configuration
Returns Promise<PlayerListResponse>
- Defined in src/generated/types/PromiseAPI.ts:1492

requestTransferAccountOwnership

requestTransferAccountOwnership(id, playerTransferOwnershipRequest, _options?): Promise<TransactionIntentResponse>
This endpoint allows you to perform a request to change the owner of an account. To perform an update on the owner of an account, first you must provide a new owner address. Once requested, the owner must accept to take ownership by calling acceptOwnership() in the smart contract account. Request transfer ownership of a player.
Parameters
- id: string
  Specifies the unique player ID (starts with pla_).
- playerTransferOwnershipRequest: PlayerTransferOwnershipRequest
- Optional _options: Configuration
Returns Promise<TransactionIntentResponse>
- Defined in src/generated/types/PromiseAPI.ts:1503

updatePlayer

updatePlayer(id, playerUpdateRequest, _options?): Promise<PlayerResponse>
Updates the specified player by setting the values of the parameters passed. Updates a player object.
Parameters
- id: string
  Specifies the unique player ID (starts with pla_).
- playerUpdateRequest: PlayerUpdateRequest
- Optional _options: Configuration
Returns Promise<PlayerResponse>
- Defined in src/generated/types/PromiseAPI.ts:1514