bungie-net-core/endpoints/Social.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 { BungieFriendListResponse } from '../models/Social/Friends/BungieFriendListResponse';
import { BungieFriendRequestListResponse } from '../models/Social/Friends/BungieFriendRequestListResponse';
import { PlatformFriendType } from '../models/Social/Friends/PlatformFriendType';
import { PlatformFriendResponse } from '../models/Social/Friends/PlatformFriendResponse';
/**
 * Returns your Bungie Friend list
 * @see {@link https://bungie-net.github.io/#Social.GetFriendList}
 */
export declare function getFriendList(http: BungieHttpProtocol): Promise<BungieNetResponse<BungieFriendListResponse>>;
/**
 * Returns your friend request queue.
 * @see {@link https://bungie-net.github.io/#Social.GetFriendRequestList}
 */
export declare function getFriendRequestList(http: BungieHttpProtocol): Promise<BungieNetResponse<BungieFriendRequestListResponse>>;
/**
 * Requests a friend relationship with the target user. Any of the target user's
 * linked membership ids are valid inputs.
 * @see {@link https://bungie-net.github.io/#Social.IssueFriendRequest}
 */
export declare function issueFriendRequest(http: BungieHttpProtocol, params: {
    /** The membership id of the user you wish to add. */
    membershipId: string;
}): Promise<BungieNetResponse<boolean>>;
/**
 * Accepts a friend relationship with the target user. The user must be on your
 * incoming friend request list, though no error will occur if they are not.
 * @see {@link https://bungie-net.github.io/#Social.AcceptFriendRequest}
 */
export declare function acceptFriendRequest(http: BungieHttpProtocol, params: {
    /** The membership id of the user you wish to accept. */
    membershipId: string;
}): Promise<BungieNetResponse<boolean>>;
/**
 * Declines a friend relationship with the target user. The user must be on your
 * incoming friend request list, though no error will occur if they are not.
 * @see {@link https://bungie-net.github.io/#Social.DeclineFriendRequest}
 */
export declare function declineFriendRequest(http: BungieHttpProtocol, params: {
    /** The membership id of the user you wish to decline. */
    membershipId: string;
}): Promise<BungieNetResponse<boolean>>;
/**
 * Remove a friend relationship with the target user. The user must be on your
 * friend list, though no error will occur if they are not.
 * @see {@link https://bungie-net.github.io/#Social.RemoveFriend}
 */
export declare function removeFriend(http: BungieHttpProtocol, params: {
    /** The membership id of the user you wish to remove. */
    membershipId: string;
}): Promise<BungieNetResponse<boolean>>;
/**
 * Remove a friend relationship with the target user. The user must be on your
 * outgoing request friend list, though no error will occur if they are not.
 * @see {@link https://bungie-net.github.io/#Social.RemoveFriendRequest}
 */
export declare function removeFriendRequest(http: BungieHttpProtocol, params: {
    /** The membership id of the user you wish to remove. */
    membershipId: string;
}): Promise<BungieNetResponse<boolean>>;
/**
 * Gets the platform friend of the requested type, with additional information if
 * they have Bungie accounts. Must have a recent login session with said platform.
 * @see {@link https://bungie-net.github.io/#Social.GetPlatformFriendList}
 */
export declare function getPlatformFriendList(http: BungieHttpProtocol, params: {
    /** The platform friend type. */
    friendPlatform: PlatformFriendType;
    /** The zero based page to return. Page size is 100. */
    page: string;
}): Promise<BungieNetResponse<PlatformFriendResponse>>;