Skip to content
Last updated

PERS SDK - v2.3.26 / Exports / TokenApi

Class: TokenApi

Table of contents

Constructors

Methods

Constructors

constructor

• new TokenApi(apiClient): TokenApi

Parameters

NameType
apiClientPersApiClient

Returns

TokenApi

Defined in

token/api/token-api.ts:34

Methods

getRemoteTokens

▸ getRemoteTokens(includeInactive?, options?): Promise<PaginatedResponseDTO<TokenDTO>>

PUBLIC: Get all remote tokens ENHANCED: Added admin filtering capability and pagination

Parameters

NameTypeDefault valueDescription
includeInactivebooleanfalseInclude inactive tokens (admin only)
options?PaginationOptionsundefinedPagination options (page, limit, sortBy, sortOrder)

Returns

Promise<PaginatedResponseDTO<TokenDTO>>

Paginated response with tokens

Defined in

token/api/token-api.ts:50


getRemoteTokenTypes

▸ getRemoteTokenTypes(options?): Promise<PaginatedResponseDTO<TokenTypeDTO>>

PUBLIC: Get all remote token types

Parameters

NameTypeDescription
options?PaginationOptionsPagination options (page, limit, sortBy, sortOrder)

Returns

Promise<PaginatedResponseDTO<TokenTypeDTO>>

Paginated response with token types

Defined in

token/api/token-api.ts:65


getRemoteActiveCreditToken

▸ getRemoteActiveCreditToken(): Promise<TokenDTO>

PUBLIC: Get active point token (was credit token)

Returns

Promise<TokenDTO>

Defined in

token/api/token-api.ts:74


getRemoteRewardTokens

▸ getRemoteRewardTokens(includeInactive?, options?): Promise<PaginatedResponseDTO<TokenDTO>>

PUBLIC: Get reward tokens ENHANCED: Added admin filtering capability and pagination

Parameters

NameTypeDefault valueDescription
includeInactivebooleanfalseInclude inactive tokens (admin only)
options?PaginationOptionsundefinedPagination options (page, limit, sortBy, sortOrder)

Returns

Promise<PaginatedResponseDTO<TokenDTO>>

Paginated response with reward tokens

Defined in

token/api/token-api.ts:86


getRemoteStatusTokens

▸ getRemoteStatusTokens(includeInactive?, options?): Promise<PaginatedResponseDTO<TokenDTO>>

PUBLIC: Get stamp tokens (was status tokens) ENHANCED: Added admin filtering capability and pagination

Parameters

NameTypeDefault valueDescription
includeInactivebooleanfalseInclude inactive tokens (admin only)
options?PaginationOptionsundefinedPagination options (page, limit, sortBy, sortOrder)

Returns

Promise<PaginatedResponseDTO<TokenDTO>>

Paginated response with stamp tokens

Defined in

token/api/token-api.ts:103


getTokenByContractAddress

▸ getTokenByContractAddress(contractAddress, contractTokenId): Promise<TokenDTO>

PUBLIC: Get token by contract address

Parameters

NameType
contractAddressstring
contractTokenIdnull | string

Returns

Promise<TokenDTO>

Defined in

token/api/token-api.ts:115


getTokenMetadata

▸ 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.

Parameters

NameTypeDescription
options?TokenMetadataQueryParamsFilter, pagination, and include options

Returns

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']
});

Defined in

token/api/token-api.ts:151


createToken

▸ createToken(tokenData): Promise<TokenDTO>

ADMIN: Create new token

Parameters

NameType
tokenDataTokenCreateRequestDTO

Returns

Promise<TokenDTO>

Defined in

token/api/token-api.ts:205


updateToken

▸ updateToken(tokenId, tokenData): Promise<TokenDTO>

ADMIN: Update token

Parameters

NameType
tokenIdstring
tokenDataTokenUpdateRequestDTO

Returns

Promise<TokenDTO>

Defined in

token/api/token-api.ts:212


toggleTokenActive

▸ toggleTokenActive(tokenId): Promise<TokenDTO>

ADMIN: Toggle token active status FIXED: Now calls correct endpoint

Parameters

NameType
tokenIdstring

Returns

Promise<TokenDTO>

Defined in

token/api/token-api.ts:220


setMainnetContract

▸ setMainnetContract(tokenId, contractAddress, chainId): Promise<TokenDTO>

ADMIN: Set mainnet contract address

Parameters

NameType
tokenIdstring
contractAddressstring
chainIdnumber

Returns

Promise<TokenDTO>

Defined in

token/api/token-api.ts:227


createTokenMetadata

▸ createTokenMetadata(tokenId, tokenData): Promise<TokenDTO>

ADMIN: Create token metadata

Parameters

NameType
tokenIdstring
tokenDataTokenMetadataCreateRequestDTO

Returns

Promise<TokenDTO>

Defined in

token/api/token-api.ts:237


updateTokenMetadata

▸ updateTokenMetadata(metadataId, tokenData): Promise<TokenMetadataDTO>

ADMIN: Update token metadata (ERC721 only) Note: Existing minted NFTs retain their original metadata - this only affects future mints

Parameters

NameType
metadataIdstring
tokenDataTokenMetadataCreateRequestDTO

Returns

Promise<TokenMetadataDTO>

Defined in

token/api/token-api.ts:245


toggleTokenMetadataStatus

▸ toggleTokenMetadataStatus(metadataId): Promise<TokenMetadataDTO>

ADMIN: Toggle token metadata status (separate from token status)

Parameters

NameType
metadataIdstring

Returns

Promise<TokenMetadataDTO>

Defined in

token/api/token-api.ts:252


createTokenType

▸ createTokenType(tokenType): Promise<TokenTypeDTO>

ADMIN: Create token type

Parameters

NameType
tokenTypeTokenTypeDTO

Returns

Promise<TokenTypeDTO>

Defined in

token/api/token-api.ts:259


deleteTokenMetadata

▸ 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.

Parameters

NameTypeDescription
metadataIdstringID of the token metadata to delete

Returns

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');
  }
}

Defined in

token/api/token-api.ts:284


exportMetadataCSV

▸ 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()

Parameters

NameTypeDescription
options?ObjectExport options (dateFrom, dateTo)
options.dateFrom?string-
options.dateTo?string-

Returns

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'
});

Defined in

token/api/token-api.ts:316


setTokenMetadataApproval

▸ 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()

Parameters

NameTypeDescription
tokenMetadataIdstringID of the token metadata to approve
status"approved" | "rejected"-
reason?string-

Returns

Promise<TokenMetadataDTO>

Updated token metadata with approval metadata

Defined in

token/api/token-api.ts:340