Kiai Docs - Rewards

Extends

BaseHandler

Constructors

Constructor

new Rewards(handler): Rewards

Parameters

Parameter	Type
`handler`	`RequestHandler`

Returns

Rewards

Inherited from

BaseHandler.constructor

Properties

Property	Modifier	Type	Inherited from
`_handler`	`public`	`RequestHandler`	`BaseHandler._handler`

Methods

clearRewards()

clearRewards(guildId): Promise<CountResponse>

Parameters

Parameter	Type
`guildId`	`string`

Returns

Promise<CountResponse>

createReward()

createReward(guildId, data): Promise<Reward>

Parameters

Parameter	Type
`guildId`	`string`
`data`	`CreateReward`

Returns

Promise<Reward>

deleteReward()

deleteReward(guildId, rewardId): Promise<RewardDeletionResponse>

Parameters

Parameter	Type
`guildId`	`string`
`rewardId`	`string`

Returns

Promise<RewardDeletionResponse>

getCapabilities()

getCapabilities(guildId): Promise<RewardCapabilities>

Parameters

Parameter	Type
`guildId`	`string`

Returns

Promise<RewardCapabilities>

getReconciliationJob()

getReconciliationJob(guildId, jobId): Promise<RewardReconciliationJob>

Parameters

Parameter	Type
`guildId`	`string`
`jobId`	`string`

Returns

Promise<RewardReconciliationJob>

getReward()

getReward(guildId, rewardId): Promise<Reward>

Parameters

Parameter	Type
`guildId`	`string`
`rewardId`	`string`

Returns

Promise<Reward>

getRewards()

getRewards(guildId, filters?): Promise<Reward[]>

Parameters

Parameter	Type
`guildId`	`string`
`filters`	{ `level?`: `number`; `prestige?`: `number`; `type?`: `RewardType`; }
`filters.level?`	`number`
`filters.prestige?`	`number`
`filters.type?`	`RewardType`

Returns

Promise<Reward[]>

queueReconciliation()

queueReconciliation(guildId): Promise<QueuedRewardReconciliation>

Parameters

Parameter	Type
`guildId`	`string`

Returns

Promise<QueuedRewardReconciliation>

updateReward()

updateReward(guildId, rewardId, data): Promise<Reward>

Parameters

Parameter	Type
`guildId`	`string`
`rewardId`	`string`
`data`	`CreateReward`

Returns

Promise<Reward>