bungie-api-ts/user/api.d.ts

TypeScript mappings for 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.
 *
 * OpenAPI spec version: 2.20.1
 * Contact: support@bungie.com
 *
 * NOTE: This class is auto generated by the bungie-api-ts code generator program.
 * https://github.com/DestinyItemManager/bungie-api-ts
 * Do not edit these files manually.
 */
import { HttpClient } from '../http.js';
import {
  BungieCredentialType,
  GeneralUser,
  GetCredentialTypesForAccountResponse,
  HardLinkedUserMembership,
  UserMembershipData,
  UserSearchPrefixRequest,
  UserSearchResponse,
  UserTheme,
} from './interfaces.js';
import { BungieMembershipType, ServerResponse } from '../common.js';
export interface GetBungieNetUserByIdParams {
  /** The requested Bungie.net membership id. */
  id: string;
}
/** Loads a bungienet user by membership id. */
export declare function getBungieNetUserById(
  http: HttpClient,
  params: GetBungieNetUserByIdParams
): Promise<ServerResponse<GeneralUser>>;
export interface GetSanitizedPlatformDisplayNamesParams {
  /** The requested membership id to load. */
  membershipId: string;
}
/**
 * Gets a list of all display names linked to this membership id but sanitized (
 * profanity filtered). Obeys all visibility rules of calling user and is heavily
 * cached.
 */
export declare function getSanitizedPlatformDisplayNames(
  http: HttpClient,
  params: GetSanitizedPlatformDisplayNamesParams
): Promise<
  ServerResponse<{
    [key in BungieCredentialType]: string;
  }>
>;
export interface GetCredentialTypesForTargetAccountParams {
  /** The user's membership id */
  membershipId: string;
}
/** Returns a list of credential types attached to the requested account */
export declare function getCredentialTypesForTargetAccount(
  http: HttpClient,
  params: GetCredentialTypesForTargetAccountParams
): Promise<ServerResponse<GetCredentialTypesForAccountResponse[]>>;
/** Returns a list of all available user themes. */
export declare function getAvailableThemes(http: HttpClient): Promise<ServerResponse<UserTheme[]>>;
export interface GetMembershipDataByIdParams {
  /** The membership ID of the target user. */
  membershipId: string;
  /** Type of the supplied membership ID. */
  membershipType: BungieMembershipType;
}
/**
 * Returns a list of accounts associated with the supplied membership ID and
 * membership type. This will include all linked accounts (even when hidden) if
 * supplied credentials permit it.
 */
export declare function getMembershipDataById(
  http: HttpClient,
  params: GetMembershipDataByIdParams
): Promise<ServerResponse<UserMembershipData>>;
/**
 * Returns a list of accounts associated with signed in user. This is useful for
 * OAuth implementations that do not give you access to the token response.
 */
export declare function getMembershipDataForCurrentUser(
  http: HttpClient
): Promise<ServerResponse<UserMembershipData>>;
export interface GetMembershipFromHardLinkedCredentialParams {
  /** The credential to look up. Must be a valid SteamID64. */
  credential: string;
  /** The credential type. 'SteamId' is the only valid value at present. */
  crType: BungieCredentialType;
}
/**
 * Gets any hard linked membership given a credential. Only works for credentials
 * that are public (just SteamID64 right now). Cross Save aware.
 */
export declare function getMembershipFromHardLinkedCredential(
  http: HttpClient,
  params: GetMembershipFromHardLinkedCredentialParams
): Promise<ServerResponse<HardLinkedUserMembership>>;
export interface SearchByGlobalNamePrefixParams {
  /** The display name prefix you're looking for. */
  displayNamePrefix: string;
  /** The zero-based page of results you desire. */
  page: number;
}
/** [OBSOLETE] Do not use this to search users, use SearchByGlobalNamePost instead. */
export declare function searchByGlobalNamePrefix(
  http: HttpClient,
  params: SearchByGlobalNamePrefixParams
): Promise<ServerResponse<UserSearchResponse>>;
export interface SearchByGlobalNamePostParams {
  /** The zero-based page of results you desire. */
  page: number;
}
/** Given the prefix of a global display name, returns all users who share that name. */
export declare function searchByGlobalNamePost(
  http: HttpClient,
  params: SearchByGlobalNamePostParams,
  body: UserSearchPrefixRequest
): Promise<ServerResponse<UserSearchResponse>>;