Class: TorqueAdminClient

@torque-labs/torque-ts-sdk • Docs

@torque-labs/torque-ts-sdk / TorqueAdminClient

Class: TorqueAdminClient

The TorqueAdminClient class is used to manage admin actions in the Torque API.

Example

const client = new TorqueAdminClient(TorqueAdminClientOptions);

const result = await client.createCampaign(<campaignData>);
const result = await client.endCampaign(<campaignData>);

Constructors

new TorqueAdminClient()

new TorqueAdminClient(options): TorqueAdminClient

Create a new instance of the TorqueAdminClient class with the provided API key.

Parameters

Returns

TorqueAdminClient

Defined in

src/classes/admin.ts:86

Properties

Methods

createCampaign()

createCampaign(data): Promise<SignatureField>

Create a new campaign with the provided data.

Parameters

Returns

Promise<SignatureField>

A promise that resolves with the signature of the transaction.

Defined in

src/classes/admin.ts:226

deleteAudience()

deleteAudience(id): Promise<{
  audienceId: string;
}>

Delete an existing audience.

Parameters

Returns

Promise<{ audienceId: string; }>

A promise that resolves to the deleted audience.

Throws

If the client is not initialized or if there was an error deleting the audience.

Defined in

src/classes/admin.ts:691

endCampaign()

endCampaign(data): Promise<SignatureField>

End a campaign using the provided campaign ID.

Parameters

Returns

Promise<SignatureField>

A promise that resolves to the signature of the transaction.

Throws

Throws an error if the client is not initialized or if there is an error ending the campaign.

Defined in

src/classes/admin.ts:261

getActiveCampaigns()

getActiveCampaigns(params?): Promise<{
  campaigns: ApiCampaign[];
}>

Get a list of all currently active campaigns.

Parameters

Returns

Promise<{ campaigns: ApiCampaign[]; }>

A promise that resolves to an array of ApiCampaign objects.

Throws

If the client is not initialized or there was an error getting the list of campaigns.

Defined in

src/classes/admin.ts:131

getAudience()

getAudience(id): Promise<ApiAudience>

Get an audience by ID.

Parameters

Returns

Promise<ApiAudience>

A promise that resolves to an array of Audiences.

Throws

If the client is not initialized or there was an error getting the audience.

Defined in

src/classes/admin.ts:523

getAudiences()

getAudiences(): Promise<{
  audiences: ApiAudience[];
}>

Get a list of the user's saved audiences.

Returns

Promise<{ audiences: ApiAudience[]; }>

A promise that resolves to an array of Audiences.

Throws

If the client is not initialized or there was an error getting the audiences.

Defined in

src/classes/admin.ts:559

getCampaign()

getCampaign(campaignId): Promise<ApiCampaign>

Get the details of a specific campaign.

Parameters

Returns

Promise<ApiCampaign>

A Promise that resolves to the campaign data.

Throws

Throws an error if a fetching a campaign failed.

Defined in

src/classes/admin.ts:198

getCampaignAnalytics()

getCampaignAnalytics(campaignId): Promise<CampaignAnalytics>

Get the analytics data for a specific campaign.

Parameters

Returns

Promise<CampaignAnalytics>

A Promise that resolves to the analytics data for the campaign.

Throws

Throws an error if a fetching a campaign failed.

Defined in

src/classes/admin.ts:487

getCampaigns()

getCampaigns(params?, includeHistoric?): Promise<{
  campaigns: ApiCampaign[];
}>

Parameters

Returns

Promise<{ campaigns: ApiCampaign[]; }>

Defined in

src/classes/admin.ts:150

getHistoricCampaigns()

getHistoricCampaigns(params?): Promise<{
  campaigns: ApiCampaign[];
}>

Get a list of all historic campaigns.

Parameters

Returns

Promise<{ campaigns: ApiCampaign[]; }>

A promise that resolves to an array of ApiCampaign objects.

Throws

If the client is not initialized or there was an error getting the list of campaigns.

Defined in

src/classes/admin.ts:142

getLeaderboard()

getLeaderboard(campaignId): Promise<ApiCampaignLeaderboard>

Get the leaderboard for a specific campaign.

Parameters

Returns

Promise<ApiCampaignLeaderboard>

A Promise that resolves to the leaderboard data for the campaign.

Throws

Throws an error if the client is not initialized or if there is an error getting the leaderboard.

Defined in

src/classes/admin.ts:295

initPublisher()

initPublisher(): Promise<string>

Initialize a publisher account for the current user.

Returns

Promise<string>

A promise that resolves to the signature of the transaction.

Throws

Throws an error if there was an error creating the publisher.

Defined in

src/classes/admin.ts:361

logout()

logout(): Promise<void>

Returns

Promise<void>

Defined in

src/classes/admin.ts:114

payoutPublisher()

payoutPublisher(data): Promise<string>

Process a publisher payout for the current user, if eligible.

Parameters

Returns

Promise<string>

A promise that resolves to the signature of the transaction.

Throws

Throws an error if there was an error paying out the publisher.

Defined in

src/classes/admin.ts:397

raffleRewards()

raffleRewards(campaignId): Promise<ApiRaffleRewards>

Get the raffle rewards for a specific campaign.

Parameters

Returns

Promise<ApiRaffleRewards>

Throws

Throws an error if the client is not initialized or if there is an error getting the raffle rewards.

Defined in

src/classes/admin.ts:325

saveAudience()

saveAudience(metadata, config?): Promise<{
  audienceId: string;
}>

Save an audience to the user's account.

Parameters

Returns

Promise<{ audienceId: string; }>

A promise that resolves to the id of the saved audience.

Throws

If the client is not initialized or there was an error saving the audience.

Defined in

src/classes/admin.ts:598

updateAudience()

updateAudience(
   id, 
   metadata?, 
   config?): Promise<{
  audienceId: string;
}>

Update an existing audience with the provided configuration.

Parameters

Returns

Promise<{ audienceId: string; }>

A promise that resolves to the updated audience.

Throws

If the client is not initialized or if there was an error updating the audience.

Defined in

src/classes/admin.ts:645

getSafeTokenList()

static getSafeTokenList(filter?, apiUrl?): Promise<SafeToken[]>

Retrieves the list of safe tokens from the Jupiter ag.

Parameters

Returns

Promise<SafeToken[]>

A promise that resolves to an array of SafeToken objects.

Throws

If the client is not initialized or there was an error fetching the safe token list.

Defined in

src/classes/admin.ts:439