@taskeren/bungie-api-ts 5.10.0

package/generated-src/http.ts

@@ -0,0 +1,52 @@
+export type HttpQueryParams = Record<string, string>;
+
+export interface HttpClientConfig {
+  method: 'GET' | 'POST';
+  url: string;
+  /** Query string params */
+  params?: HttpQueryParams;
+  /** Request body */
+  body?: any;
+}
+
+/**
+ * A generic, minimal type for providing an HTTP client function.
+ * This gets the necessary config provided as an argument, and then
+ * should produce a promise for the parsed JSON as a result. The API
+ * helper functions will use this to return the right type.
+ */
+export type HttpClient = <Return>(config: HttpClientConfig) => Promise<Return>;
+
+export function get<Return>(
+  http: HttpClient,
+  url: string,
+  params?: HttpQueryParams
+): Promise<Return> {
+  return http(
+    params
+      ? {
+          method: 'GET',
+          url,
+          params,
+        }
+      : {
+          method: 'GET',
+          url,
+        }
+  );
+}
+
+export function post<Return>(http: HttpClient, url: string, body?: any): Promise<Return> {
+  return http(
+    body
+      ? {
+          method: 'POST',
+          url,
+          body,
+        }
+      : {
+          method: 'POST',
+          url,
+        }
+  );
+}

package/generated-src/index.ts

@@ -0,0 +1,37 @@
+/**
+ * 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.21.9
+ * 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 * as AppImport from './app/index.js';
+import * as UserImport from './user/index.js';
+import * as ContentImport from './content/index.js';
+import * as ForumImport from './forum/index.js';
+import * as GroupV2Import from './groupv2/index.js';
+import * as TokensImport from './tokens/index.js';
+import * as Destiny2Import from './destiny2/index.js';
+import * as CommunityContentImport from './communitycontent/index.js';
+import * as TrendingImport from './trending/index.js';
+import * as FireteamImport from './fireteam/index.js';
+import * as SocialImport from './social/index.js';
+import * as CoreImport from './core/index.js';
+
+export const App = AppImport;
+export const User = UserImport;
+export const Content = ContentImport;
+export const Forum = ForumImport;
+export const GroupV2 = GroupV2Import;
+export const Tokens = TokensImport;
+export const Destiny2 = Destiny2Import;
+export const CommunityContent = CommunityContentImport;
+export const Trending = TrendingImport;
+export const Fireteam = FireteamImport;
+export const Social = SocialImport;
+export const Core = CoreImport;

package/generated-src/package.json.notyet

@@ -0,0 +1,99 @@
+{
+  "name": "bungie-api-ts",
+  "version": "5.10.0",
+  "description": "TypeScript mappings for the Bungie.net API",
+  "type": "module",
+  "sideEffects": false,
+  "scripts": {},
+  "jest": {
+    "preset": "ts-jest/presets/js-with-babel-esm",
+    "testEnvironment": "node",
+    "moduleNameMapper": {
+      "^(\\.{1,2}/.*)\\.js$": "$1"
+    }
+  },
+  "engines": {
+    "node": ">=13.2.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DestinyItemManager/bungie-api-ts.git"
+  },
+  "author": "Ben Hollis",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/DestinyItemManager/bungie-api-ts/issues"
+  },
+  "keywords": [
+    "Destiny",
+    "Bungie",
+    "Bungie.net",
+    "TypeScript"
+  ],
+  "homepage": "https://github.com/DestinyItemManager/bungie-api-ts",
+  "devDependencies": {},
+  "packageManager": "pnpm@8.15.9+sha512.499434c9d8fdd1a2794ebf4552b3b25c0a633abcee5bb15e7b5de90f32f47b513aca98cd5cfd001c31f0db454bc3804edccd578501e4ca293a6816166bbd9f81",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "module": "./index.js",
+  "exports": {
+    ".": {
+      "default": "./index.js",
+      "types": "./index.d.ts"
+    },
+    "./http": {
+      "default": "./http.js",
+      "types": "./http.d.ts"
+    },
+    "./package.json": "./package.json",
+    "./app": {
+      "default": "./app/index.js",
+      "types": "./app/index.d.ts"
+    },
+    "./user": {
+      "default": "./user/index.js",
+      "types": "./user/index.d.ts"
+    },
+    "./content": {
+      "default": "./content/index.js",
+      "types": "./content/index.d.ts"
+    },
+    "./forum": {
+      "default": "./forum/index.js",
+      "types": "./forum/index.d.ts"
+    },
+    "./groupv2": {
+      "default": "./groupv2/index.js",
+      "types": "./groupv2/index.d.ts"
+    },
+    "./tokens": {
+      "default": "./tokens/index.js",
+      "types": "./tokens/index.d.ts"
+    },
+    "./destiny2": {
+      "default": "./destiny2/index.js",
+      "types": "./destiny2/index.d.ts"
+    },
+    "./communitycontent": {
+      "default": "./communitycontent/index.js",
+      "types": "./communitycontent/index.d.ts"
+    },
+    "./trending": {
+      "default": "./trending/index.js",
+      "types": "./trending/index.d.ts"
+    },
+    "./fireteam": {
+      "default": "./fireteam/index.js",
+      "types": "./fireteam/index.d.ts"
+    },
+    "./social": {
+      "default": "./social/index.js",
+      "types": "./social/index.d.ts"
+    },
+    "./core": {
+      "default": "./core/index.js",
+      "types": "./core/index.d.ts"
+    }
+  },
+  "dependencies": {}
+}

package/generated-src/platform.ts

@@ -0,0 +1,39 @@
+/**
+ * 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.21.9
+ * 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.
+ */
+
+export interface IgnoreResponse {
+  readonly isIgnored: boolean;
+  /**
+   * This enum represents a set of flags - use bitwise operators to check which of
+   * these match your value.
+   */
+  readonly ignoreFlags: IgnoreStatus;
+}
+
+/**
+ * This enum represents a set of flags - use bitwise operators to check which of
+ * these match your value.
+ */
+export const enum IgnoreStatus {
+  NotIgnored = 0,
+  IgnoredUser = 1,
+  IgnoredGroup = 2,
+  IgnoredByGroup = 4,
+  IgnoredPost = 8,
+  IgnoredTag = 16,
+  IgnoredGlobal = 32
+}
+
+export interface TagResponse {
+  readonly tagText: string;
+  readonly ignoreStatus: IgnoreResponse;
+}

package/generated-src/social/api.ts

@@ -0,0 +1,115 @@
+/**
+ * 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.21.9
+ * 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, get, post } from '../http.js';
+
+import {
+  BungieFriendListResponse,
+  BungieFriendRequestListResponse,
+  PlatformFriendResponse,
+  PlatformFriendType
+} from './interfaces.js';
+import {
+  ServerResponse
+} from '../common.js';
+
+const API_BASE = "https://www.bungie.net/Platform/Social/";
+
+/** Returns your Bungie Friend list */
+export function getFriendList(http: HttpClient): Promise<ServerResponse<BungieFriendListResponse>> {
+  return get(http, `${API_BASE}Friends/`);
+}
+
+/** Returns your friend request queue. */
+export function getFriendRequestList(http: HttpClient): Promise<ServerResponse<BungieFriendRequestListResponse>> {
+  return get(http, `${API_BASE}Friends/Requests/`);
+}
+
+export interface IssueFriendRequestParams {
+  /** The membership id of the user you wish to add. */
+  membershipId: string;
+}
+
+/**
+ * Requests a friend relationship with the target user. Any of the target user's
+ * linked membership ids are valid inputs.
+ */
+export function issueFriendRequest(http: HttpClient, params: IssueFriendRequestParams): Promise<ServerResponse<boolean>> {
+    return post(http, `${API_BASE}Friends/Add/${params.membershipId}/`);
+}
+
+export interface AcceptFriendRequestParams {
+  /** The membership id of the user you wish to accept. */
+  membershipId: string;
+}
+
+/**
+ * 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.
+ */
+export function acceptFriendRequest(http: HttpClient, params: AcceptFriendRequestParams): Promise<ServerResponse<boolean>> {
+    return post(http, `${API_BASE}Friends/Requests/Accept/${params.membershipId}/`);
+}
+
+export interface DeclineFriendRequestParams {
+  /** The membership id of the user you wish to decline. */
+  membershipId: string;
+}
+
+/**
+ * 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.
+ */
+export function declineFriendRequest(http: HttpClient, params: DeclineFriendRequestParams): Promise<ServerResponse<boolean>> {
+    return post(http, `${API_BASE}Friends/Requests/Decline/${params.membershipId}/`);
+}
+
+export interface RemoveFriendParams {
+  /** The membership id of the user you wish to remove. */
+  membershipId: string;
+}
+
+/**
+ * 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.
+ */
+export function removeFriend(http: HttpClient, params: RemoveFriendParams): Promise<ServerResponse<boolean>> {
+    return post(http, `${API_BASE}Friends/Remove/${params.membershipId}/`);
+}
+
+export interface RemoveFriendRequestParams {
+  /** The membership id of the user you wish to remove. */
+  membershipId: string;
+}
+
+/**
+ * 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.
+ */
+export function removeFriendRequest(http: HttpClient, params: RemoveFriendRequestParams): Promise<ServerResponse<boolean>> {
+    return post(http, `${API_BASE}Friends/Requests/Remove/${params.membershipId}/`);
+}
+
+export interface GetPlatformFriendListParams {
+  /** The platform friend type. */
+  friendPlatform: PlatformFriendType;
+  /** The zero based page to return. Page size is 100. */
+  page: string;
+}
+
+/**
+ * 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.
+ */
+export function getPlatformFriendList(http: HttpClient, params: GetPlatformFriendListParams): Promise<ServerResponse<PlatformFriendResponse>> {
+  return get(http, `${API_BASE}PlatformFriends/${params.friendPlatform}/${params.page}/`);
+}

package/generated-src/social/index.ts

@@ -0,0 +1,17 @@
+/**
+ * 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.21.9
+ * 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.
+ */
+
+export * from '../common.js';
+export * from '../platform.js';
+export type {HttpClientConfig, HttpClient} from '../http.js';
+export * from './api.js';
+export * from './interfaces.js';

package/generated-src/social/interfaces.ts

@@ -0,0 +1,89 @@
+/**
+ * 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.21.9
+ * 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 {
+  BungieMembershipType
+} from '../common.js';
+import {
+  GeneralUser
+} from '../user/interfaces.js';
+
+export const enum PlatformFriendType {
+  Unknown = 0,
+  Xbox = 1,
+  PSN = 2,
+  Steam = 3,
+  Egs = 4
+}
+
+export interface BungieFriendListResponse {
+  readonly friends: BungieFriend[];
+}
+
+export interface BungieFriend {
+  readonly lastSeenAsMembershipId: string;
+  readonly lastSeenAsBungieMembershipType: BungieMembershipType;
+  readonly bungieGlobalDisplayName: string;
+  readonly bungieGlobalDisplayNameCode?: number;
+  readonly onlineStatus: PresenceStatus;
+  /**
+   * This enum represents a set of flags - use bitwise operators to check which of
+   * these match your value.
+   */
+  readonly onlineTitle: PresenceOnlineStateFlags;
+  readonly relationship: FriendRelationshipState;
+  readonly bungieNetUser: GeneralUser;
+}
+
+export const enum PresenceStatus {
+  OfflineOrUnknown = 0,
+  Online = 1
+}
+
+/**
+ * This enum represents a set of flags - use bitwise operators to check which of
+ * these match your value.
+ */
+export const enum PresenceOnlineStateFlags {
+  None = 0,
+  Destiny1 = 1,
+  Destiny2 = 2
+}
+
+export const enum FriendRelationshipState {
+  Unknown = 0,
+  Friend = 1,
+  IncomingRequest = 2,
+  OutgoingRequest = 3
+}
+
+export interface BungieFriendRequestListResponse {
+  readonly incomingRequests: BungieFriend[];
+  readonly outgoingRequests: BungieFriend[];
+}
+
+export interface PlatformFriendResponse {
+  readonly itemsPerPage: number;
+  readonly currentPage: number;
+  readonly hasMore: boolean;
+  readonly platformFriends: PlatformFriend[];
+}
+
+export interface PlatformFriend {
+  readonly platformDisplayName: string;
+  readonly friendPlatform: PlatformFriendType;
+  readonly destinyMembershipId?: string;
+  readonly destinyMembershipType?: BungieMembershipType;
+  readonly bungieNetMembershipId?: string;
+  readonly bungieGlobalDisplayName: string;
+  readonly bungieGlobalDisplayNameCode?: number;
+}

package/generated-src/tokens/api.ts

@@ -0,0 +1,126 @@
+/**
+ * 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.21.9
+ * 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, get, post } from '../http.js';
+
+import {
+  BungieMembershipType,
+  ServerResponse
+} from '../common.js';
+import {
+  BungieRewardDisplay,
+  PartnerOfferClaimRequest,
+  PartnerOfferSkuHistoryResponse,
+  PartnerRewardHistoryResponse
+} from './interfaces.js';
+
+const API_BASE = "https://www.bungie.net/Platform/Tokens/";
+
+/**
+ * Twitch Drops self-repair function - scans twitch for drops not marked as
+ * fulfilled and resyncs them.
+ */
+export function forceDropsRepair(http: HttpClient): Promise<ServerResponse<boolean>> {
+    return post(http, `${API_BASE}Partner/ForceDropsRepair/`);
+}
+
+/** Claim a partner offer as the authenticated user. */
+export function claimPartnerOffer(http: HttpClient, body: PartnerOfferClaimRequest): Promise<ServerResponse<boolean>> {
+    return post(http, `${API_BASE}Partner/ClaimOffer/`, body);
+}
+
+export interface ApplyMissingPartnerOffersWithoutClaimParams {
+  /** The partner application identifier. */
+  partnerApplicationId: number;
+  /**
+   * The bungie.net user to apply missing offers to. If not self, elevated
+   * permissions are required.
+   */
+  targetBnetMembershipId: string;
+}
+
+/**
+ * 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.
+ */
+export function applyMissingPartnerOffersWithoutClaim(http: HttpClient, params: ApplyMissingPartnerOffersWithoutClaimParams): Promise<ServerResponse<boolean>> {
+    return post(http, `${API_BASE}Partner/ApplyMissingOffers/${params.partnerApplicationId}/${params.targetBnetMembershipId}/`);
+}
+
+export interface GetPartnerOfferSkuHistoryParams {
+  /** The partner application identifier. */
+  partnerApplicationId: number;
+  /**
+   * The bungie.net user to apply missing offers to. If not self, elevated
+   * permissions are required.
+   */
+  targetBnetMembershipId: string;
+}
+
+/**
+ * Returns the partner sku and offer history of the targeted user. Elevated
+ * permissions are required to see users that are not yourself.
+ */
+export function getPartnerOfferSkuHistory(http: HttpClient, params: GetPartnerOfferSkuHistoryParams): Promise<ServerResponse<PartnerOfferSkuHistoryResponse[]>> {
+  return get(http, `${API_BASE}Partner/History/${params.partnerApplicationId}/${params.targetBnetMembershipId}/`);
+}
+
+export interface GetPartnerRewardHistoryParams {
+  /** The partner application identifier. */
+  partnerApplicationId: number;
+  /** The bungie.net user to return reward history for. */
+  targetBnetMembershipId: string;
+}
+
+/**
+ * Returns the partner rewards history of the targeted user, both partner offers
+ * and Twitch drops.
+ */
+export function getPartnerRewardHistory(http: HttpClient, params: GetPartnerRewardHistoryParams): Promise<ServerResponse<PartnerRewardHistoryResponse>> {
+  return get(http, `${API_BASE}Partner/History/${params.targetBnetMembershipId}/Application/${params.partnerApplicationId}/`);
+}
+
+export interface GetBungieRewardsForUserParams {
+  /**
+   * bungie.net user membershipId for requested user rewards. If not self, elevated
+   * permissions are required.
+   */
+  membershipId: string;
+}
+
+/** Returns the bungie rewards for the targeted user. */
+export function getBungieRewardsForUser(http: HttpClient, params: GetBungieRewardsForUserParams): Promise<ServerResponse<{ [key: string]: BungieRewardDisplay }>> {
+  return get(http, `${API_BASE}Rewards/GetRewardsForUser/${params.membershipId}/`);
+}
+
+export interface GetBungieRewardsForPlatformUserParams {
+  /**
+   * users platform membershipId for requested user rewards. If not self, elevated
+   * permissions are required.
+   */
+  membershipId: string;
+  /** The target Destiny 2 membership type. */
+  membershipType: BungieMembershipType;
+}
+
+/**
+ * Returns the bungie rewards for the targeted user when a platform membership Id
+ * and Type are used.
+ */
+export function getBungieRewardsForPlatformUser(http: HttpClient, params: GetBungieRewardsForPlatformUserParams): Promise<ServerResponse<{ [key: string]: BungieRewardDisplay }>> {
+  return get(http, `${API_BASE}Rewards/GetRewardsForPlatformUser/${params.membershipId}/${params.membershipType}/`);
+}
+
+/** Returns a list of the current bungie rewards */
+export function getBungieRewardsList(http: HttpClient): Promise<ServerResponse<{ [key: string]: BungieRewardDisplay }>> {
+  return get(http, `${API_BASE}Rewards/BungieRewards/`);
+}

package/generated-src/tokens/index.ts

@@ -0,0 +1,17 @@
+/**
+ * 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.21.9
+ * 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.
+ */
+
+export * from '../common.js';
+export * from '../platform.js';
+export type {HttpClientConfig, HttpClient} from '../http.js';
+export * from './api.js';
+export * from './interfaces.js';