PERS SDK - v2.3.26 / Exports / TokenApi
- getRemoteTokens
- getRemoteTokenTypes
- getRemoteActiveCreditToken
- getRemoteRewardTokens
- getRemoteStatusTokens
- getTokenByContractAddress
- getTokenMetadata
- createToken
- updateToken
- toggleTokenActive
- setMainnetContract
- createTokenMetadata
- updateTokenMetadata
- toggleTokenMetadataStatus
- createTokenType
- deleteTokenMetadata
- exportMetadataCSV
- setTokenMetadataApproval
• new TokenApi(apiClient): TokenApi
| Name | Type |
|---|---|
apiClient | PersApiClient |
▸ getRemoteTokens(includeInactive?, options?): Promise<PaginatedResponseDTO<TokenDTO>>
PUBLIC: Get all remote tokens ENHANCED: Added admin filtering capability and pagination
| Name | Type | Default value | Description |
|---|---|---|---|
includeInactive | boolean | false | Include inactive tokens (admin only) |
options? | PaginationOptions | undefined | Pagination options (page, limit, sortBy, sortOrder) |
Promise<PaginatedResponseDTO<TokenDTO>>
Paginated response with tokens
▸ getRemoteTokenTypes(options?): Promise<PaginatedResponseDTO<TokenTypeDTO>>
PUBLIC: Get all remote token types
| Name | Type | Description |
|---|---|---|
options? | PaginationOptions | Pagination options (page, limit, sortBy, sortOrder) |
Promise<PaginatedResponseDTO<TokenTypeDTO>>
Paginated response with token types
▸ getRemoteActiveCreditToken(): Promise<TokenDTO>
PUBLIC: Get active point token (was credit token)
Promise<TokenDTO>
▸ getRemoteRewardTokens(includeInactive?, options?): Promise<PaginatedResponseDTO<TokenDTO>>
PUBLIC: Get reward tokens ENHANCED: Added admin filtering capability and pagination
| Name | Type | Default value | Description |
|---|---|---|---|
includeInactive | boolean | false | Include inactive tokens (admin only) |
options? | PaginationOptions | undefined | Pagination options (page, limit, sortBy, sortOrder) |
Promise<PaginatedResponseDTO<TokenDTO>>
Paginated response with reward tokens
▸ getRemoteStatusTokens(includeInactive?, options?): Promise<PaginatedResponseDTO<TokenDTO>>
PUBLIC: Get stamp tokens (was status tokens) ENHANCED: Added admin filtering capability and pagination
| Name | Type | Default value | Description |
|---|---|---|---|
includeInactive | boolean | false | Include inactive tokens (admin only) |
options? | PaginationOptions | undefined | Pagination options (page, limit, sortBy, sortOrder) |
Promise<PaginatedResponseDTO<TokenDTO>>
Paginated response with stamp tokens
▸ getTokenByContractAddress(contractAddress, contractTokenId): Promise<TokenDTO>
PUBLIC: Get token by contract address
| Name | Type |
|---|---|
contractAddress | string |
contractTokenId | null | string |
Promise<TokenDTO>
▸ getTokenMetadata(options?): Promise<PaginatedResponseDTO<TokenMetadataDTO>>
Get all token metadata with filtering, pagination, and include relations
Useful for displaying rewards (ERC1155) or stamps (ERC721) in tables. Non-admin users always get active metadata only.
| Name | Type | Description |
|---|---|---|
options? | TokenMetadataQueryParams | Filter, pagination, and include options |
Promise<PaginatedResponseDTO<TokenMetadataDTO>>
Paginated response with token metadata
Example
const rewards = await tokenApi.getTokenMetadata({
tokenType: 'ERC1155',
active: true,
limit: 10,
include: ['mintCount', 'burnCount', 'token']
});Example
const stamps = await tokenApi.getTokenMetadata({
tokenType: 'ERC721',
search: 'gold',
include: ['ownerBusiness', 'token']
});▸ createToken(tokenData): Promise<TokenDTO>
ADMIN: Create new token
| Name | Type |
|---|---|
tokenData | TokenCreateRequestDTO |
Promise<TokenDTO>
▸ updateToken(tokenId, tokenData): Promise<TokenDTO>
ADMIN: Update token
| Name | Type |
|---|---|
tokenId | string |
tokenData | TokenUpdateRequestDTO |
Promise<TokenDTO>
▸ toggleTokenActive(tokenId): Promise<TokenDTO>
ADMIN: Toggle token active status FIXED: Now calls correct endpoint
| Name | Type |
|---|---|
tokenId | string |
Promise<TokenDTO>
▸ setMainnetContract(tokenId, contractAddress, chainId): Promise<TokenDTO>
ADMIN: Set mainnet contract address
| Name | Type |
|---|---|
tokenId | string |
contractAddress | string |
chainId | number |
Promise<TokenDTO>
▸ createTokenMetadata(tokenId, tokenData): Promise<TokenDTO>
ADMIN: Create token metadata
| Name | Type |
|---|---|
tokenId | string |
tokenData | TokenMetadataCreateRequestDTO |
Promise<TokenDTO>
▸ updateTokenMetadata(metadataId, tokenData): Promise<TokenMetadataDTO>
ADMIN: Update token metadata (ERC721 only) Note: Existing minted NFTs retain their original metadata - this only affects future mints
| Name | Type |
|---|---|
metadataId | string |
tokenData | TokenMetadataCreateRequestDTO |
Promise<TokenMetadataDTO>
▸ toggleTokenMetadataStatus(metadataId): Promise<TokenMetadataDTO>
ADMIN: Toggle token metadata status (separate from token status)
| Name | Type |
|---|---|
metadataId | string |
Promise<TokenMetadataDTO>
▸ createTokenType(tokenType): Promise<TokenTypeDTO>
ADMIN: Create token type
| Name | Type |
|---|---|
tokenType | TokenTypeDTO |
Promise<TokenTypeDTO>
▸ deleteTokenMetadata(metadataId): Promise<void>
ADMIN: Delete token metadata (soft delete)
Soft deletes token metadata by setting deletedAt timestamp. Will fail with 409 Conflict if metadata is in use by active campaigns or redemptions.
| Name | Type | Description |
|---|---|---|
metadataId | string | ID of the token metadata to delete |
Promise<void>
Throws
409 Conflict if metadata is in use
Example
try {
await tokenApi.deleteTokenMetadata('metadata-123');
console.log('Metadata deleted');
} catch (error) {
if (error.statusCode === 409) {
console.log('Cannot delete: metadata is in use');
}
}▸ exportMetadataCSV(options?): Promise<Blob>
ADMIN: Export token metadata to CSV
Returns a CSV file with all token metadata for the tenant. Supports date range filtering.
Endpoint: GET /tokens/metadata/export/csv Auth: @TenantAdmin()
| Name | Type | Description |
|---|---|---|
options? | Object | Export options (dateFrom, dateTo) |
options.dateFrom? | string | - |
options.dateTo? | string | - |
Promise<Blob>
CSV blob
Example
// Export all token metadata
const csvBlob = await tokenApi.exportMetadataCSV();
// Export metadata created in date range
const csvBlob = await tokenApi.exportMetadataCSV({
dateFrom: '2026-01-01',
dateTo: '2026-06-30'
});▸ setTokenMetadataApproval(tokenMetadataId, status, reason?): Promise<TokenMetadataDTO>
ADMIN: Approve a token metadata
Approves token metadata that is pending approval, changing its status to 'approved'.
Endpoint: PATCH /admin/token-metadata/:id/approve Auth: @TenantAdmin()
| Name | Type | Description |
|---|---|---|
tokenMetadataId | string | ID of the token metadata to approve |
status | "approved" | "rejected" | - |
reason? | string | - |
Promise<TokenMetadataDTO>
Updated token metadata with approval metadata