Class Rewards

Hierarchy

Rewards

Index

Constructors

constructor

Methods

Constructors

constructor

new Rewards(client: RequestController): Rewards

Parameters
- client: RequestController
Returns Rewards

Methods

create

create(reward: RewardsCreate): Promise<RewardsCreateResponse>

see

https://docs.voucherify.io/reference/create-reward

Parameters
- reward: RewardsCreate
Returns Promise<RewardsCreateResponse>

createAssignment

createAssignment(rewardId: string, assignment: RewardsCreateAssignmentRequestBody): Promise<RewardAssignment>

see

https://docs.voucherify.io/reference/create-reward-assignment

Parameters
- rewardId: string
- assignment: RewardsCreateAssignmentRequestBody
Returns Promise<RewardAssignment>

delete

delete(rewardId: string): Promise<unknown>

see

https://docs.voucherify.io/reference/delete-reward

Parameters
- rewardId: string
Returns Promise<unknown>

deleteAssignment

deleteAssignment(rewardId: string, assignmentId: string): Promise<unknown>

Parameters
- rewardId: string
- assignmentId: string
Returns Promise<unknown>

get

get(rewardId: string): Promise<RewardsCreateResponse>

see

https://docs.voucherify.io/reference/get-reward

Parameters
- rewardId: string
Returns Promise<RewardsCreateResponse>

getAssignment

getAssignment(rewardId: string, assignmentId: string): Promise<RewardAssignment>

see

https://docs.voucherify.io/reference/get-reward-assignment

Parameters
- rewardId: string
- assignmentId: string
Returns Promise<RewardAssignment>

list

list(params?: RewardsListParams): Promise<RewardsListResponse>

see

https://docs.voucherify.io/reference/list-rewards

Parameters
- params: RewardsListParams = {}
Returns Promise<RewardsListResponse>

listAssignments

listAssignments(rewardId: string, params?: RewardsListAssignmentsRequestQuery): Promise<RewardsListAssignmentsResponseBody>

see

https://docs.voucherify.io/reference/list-reward-assignments

Parameters
- rewardId: string
- params: RewardsListAssignmentsRequestQuery = {}
Returns Promise<RewardsListAssignmentsResponseBody>

update

update(reward: RewardsUpdate): Promise<RewardsCreateResponse>

see

https://docs.voucherify.io/reference/update-reward

Parameters
- reward: RewardsUpdate
Returns Promise<RewardsCreateResponse>

updateAssignment

updateAssignment(rewardId: string, assignment: RewardsUpdateAssignmentRequestBody): Promise<RewardAssignment>

see

https://docs.voucherify.io/reference/update-reward-assignment

Parameters
- rewardId: string
- assignment: RewardsUpdateAssignmentRequestBody
Returns Promise<RewardAssignment>