Interface IRedemptionClient

Interface for the Redemption Client that provides functionality for managing redemptions and viewing redemption codes.

interface IRedemptionClient {
redeemCode(code: string): Promise<boolean>;
viewRedeemedCodes(): Promise<ViewRedeemedCodesResponse>;
}

Implemented by

RedemptionClient

Index

Methods

redeemCode viewRedeemedCodes

Methods

redeemCode

redeemCode(code: string): Promise<boolean>
Redeems a code for the redemption.
Parameters
- code: string
  Code to redeem
Returns Promise<boolean>
Promise resolving to true if successful
- Defined in clients/miscellaneous/redemption/abstract/IRedemptionClient.ts:13

viewRedeemedCodes

viewRedeemedCodes(): Promise<ViewRedeemedCodesResponse>
Views the redeemed codes for the redemption.

Returns Promise<ViewRedeemedCodesResponse>
Promise resolving to the redeemed codes
- Defined in clients/miscellaneous/redemption/abstract/IRedemptionClient.ts:19