bungie-net-core/endpoints/Tokens.d.ts

An easy way to interact with the Bungie.net API

/**
 * Bungie.Net API
 * These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
 *
 * Contact: support@bungie.com
 *
 * NOTE: This class is auto generated by the bungie-net-core code generator program
 * Repository: {@link https://github.com/owens1127/bungie-net-core}
 * Do not edit these files manually.
 */
import { BungieHttpProtocol } from './..';
import { BungieNetResponse } from '../interfaces/BungieNetResponse';
import { PartnerOfferClaimRequest } from '../models/Tokens/PartnerOfferClaimRequest';
import { PartnerOfferSkuHistoryResponse } from '../models/Tokens/PartnerOfferSkuHistoryResponse';
import { PartnerRewardHistoryResponse } from '../models/Tokens/PartnerRewardHistoryResponse';
import { BungieRewardDisplay } from '../models/Tokens/BungieRewardDisplay';
import { BungieMembershipType } from '../models/BungieMembershipType';
/**
 * Twitch Drops self-repair function - scans twitch for drops not marked as
 * fulfilled and resyncs them.
 * @see {@link https://bungie-net.github.io/#Tokens.ForceDropsRepair}
 */
export declare function forceDropsRepair(http: BungieHttpProtocol): Promise<BungieNetResponse<boolean>>;
/**
 * Claim a partner offer as the authenticated user.
 * @see {@link https://bungie-net.github.io/#Tokens.ClaimPartnerOffer}
 */
export declare function claimPartnerOffer(http: BungieHttpProtocol, body: PartnerOfferClaimRequest): Promise<BungieNetResponse<boolean>>;
/**
 * Apply a partner offer to the targeted user. This endpoint does not claim a new
 * offer, but any already claimed offers will be applied to the game if not already.
 * @see {@link https://bungie-net.github.io/#Tokens.ApplyMissingPartnerOffersWithoutClaim}
 */
export declare function applyMissingPartnerOffersWithoutClaim(http: BungieHttpProtocol, params: {
    /** The partner application identifier. */
    partnerApplicationId: number;
    /**
     * The bungie.net user to apply missing offers to. If not self, elevated
     * permissions are required.
     */
    targetBnetMembershipId: string;
}): Promise<BungieNetResponse<boolean>>;
/**
 * Returns the partner sku and offer history of the targeted user. Elevated
 * permissions are required to see users that are not yourself.
 * @see {@link https://bungie-net.github.io/#Tokens.GetPartnerOfferSkuHistory}
 */
export declare function getPartnerOfferSkuHistory(http: BungieHttpProtocol, params: {
    /** The partner application identifier. */
    partnerApplicationId: number;
    /**
     * The bungie.net user to apply missing offers to. If not self, elevated
     * permissions are required.
     */
    targetBnetMembershipId: string;
}): Promise<BungieNetResponse<PartnerOfferSkuHistoryResponse[]>>;
/**
 * Returns the partner rewards history of the targeted user, both partner offers
 * and Twitch drops.
 * @see {@link https://bungie-net.github.io/#Tokens.GetPartnerRewardHistory}
 */
export declare function getPartnerRewardHistory(http: BungieHttpProtocol, params: {
    /** The partner application identifier. */
    partnerApplicationId: number;
    /** The bungie.net user to return reward history for. */
    targetBnetMembershipId: string;
}): Promise<BungieNetResponse<PartnerRewardHistoryResponse>>;
/**
 * Returns the bungie rewards for the targeted user.
 * @see {@link https://bungie-net.github.io/#Tokens.GetBungieRewardsForUser}
 */
export declare function getBungieRewardsForUser(http: BungieHttpProtocol, params: {
    /**
     * bungie.net user membershipId for requested user rewards. If not self, elevated
     * permissions are required.
     */
    membershipId: string;
}): Promise<BungieNetResponse<{
    [key: string]: BungieRewardDisplay;
}>>;
/**
 * Returns the bungie rewards for the targeted user when a platform membership Id
 * and Type are used.
 * @see {@link https://bungie-net.github.io/#Tokens.GetBungieRewardsForPlatformUser}
 */
export declare function getBungieRewardsForPlatformUser(http: BungieHttpProtocol, params: {
    /**
     * users platform membershipId for requested user rewards. If not self, elevated
     * permissions are required.
     */
    membershipId: string;
    /** The target Destiny 2 membership type. */
    membershipType: BungieMembershipType;
}): Promise<BungieNetResponse<{
    [key: string]: BungieRewardDisplay;
}>>;
/**
 * Returns a list of the current bungie rewards
 * @see {@link https://bungie-net.github.io/#Tokens.GetBungieRewardsList}
 */
export declare function getBungieRewardsList(http: BungieHttpProtocol): Promise<BungieNetResponse<{
    [key: string]: BungieRewardDisplay;
}>>;