@taskeren/bungie-api-ts 5.10.0 → 5.10.2

package/generated-src/destiny2/manifest.ts

@@ -1,341 +0,0 @@
-/**
- * these helper functions and definitions are based off the structure of DestinyManifest
- * in the bungie.net API spec, but are not explicity defined endpoints in the spec.
- *
- * they were last hand-checked for OpenAPI spec version 2.8.0,
- * and have been automatically tested for the latest OpenAPI spec version 2.21.9.
- * if there are typing issues with them, please let us know at the below repo.
- *
- * 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 } from '../http.js';
-
-import {
-  DestinyPlaceDefinition,
-  DestinyActivityDefinition,
-  DestinyActivityTypeDefinition,
-  DestinyClassDefinition,
-  DestinyGenderDefinition,
-  DestinyInventoryBucketDefinition,
-  DestinyRaceDefinition,
-  DestinyUnlockDefinition,
-  DestinyStatGroupDefinition,
-  DestinyProgressionMappingDefinition,
-  DestinyFactionDefinition,
-  DestinyVendorGroupDefinition,
-  DestinyRewardSourceDefinition,
-  DestinyUnlockValueDefinition,
-  DestinyItemCategoryDefinition,
-  DestinyDamageTypeDefinition,
-  DestinyActivityModeDefinition,
-  DestinyMedalTierDefinition,
-  DestinyActivityDifficultyTierCollectionDefinition,
-  DestinyActivityFamilyDefinition,
-  DestinyActivityGraphDefinition,
-  DestinyActivityInteractableDefinition,
-  DestinyActivityLoadoutRestrictionDefinition,
-  DestinyActivitySelectableSkullCollectionDefinition,
-  DestinyActivitySelectableSkullExclusionGroupDefinition,
-  DestinyActivitySkullCategoryDefinition,
-  DestinyActivitySkullSubcategoryDefinition,
-  DestinyCollectibleDefinition,
-  DestinyDestinationDefinition,
-  DestinyEquipableItemSetDefinition,
-  DestinyEquipmentSlotDefinition,
-  DestinyEventCardDefinition,
-  DestinyFireteamFinderActivityGraphDefinition,
-  DestinyFireteamFinderActivitySetDefinition,
-  DestinyFireteamFinderLabelDefinition,
-  DestinyFireteamFinderLabelGroupDefinition,
-  DestinyFireteamFinderOptionDefinition,
-  DestinyFireteamFinderOptionGroupDefinition,
-  DestinyIconDefinition,
-  DestinyStatDefinition,
-  DestinyInventoryItemDefinition,
-  DestinyItemFilterDefinition,
-  DestinyItemTierTypeDefinition,
-  DestinyLoadoutColorDefinition,
-  DestinyLoadoutIconDefinition,
-  DestinyLoadoutNameDefinition,
-  DestinyLocationDefinition,
-  DestinyLoreDefinition,
-  DestinyMaterialRequirementSetDefinition,
-  DestinyMetricDefinition,
-  DestinyObjectiveDefinition,
-  DestinySandboxPerkDefinition,
-  DestinyPlugSetDefinition,
-  DestinyPowerCapDefinition,
-  DestinyPresentationNodeDefinition,
-  DestinyProgressionDefinition,
-  DestinyProgressionLevelRequirementDefinition,
-  DestinyRecordDefinition,
-  DestinySandboxPatternDefinition,
-  DestinySeasonDefinition,
-  DestinySeasonPassDefinition,
-  DestinySocialCommendationDefinition,
-  DestinySocketCategoryDefinition,
-  DestinySocketTypeDefinition,
-  DestinyTraitDefinition,
-  DestinyVendorDefinition,
-  DestinyMilestoneDefinition,
-  DestinyActivityModifierDefinition,
-  DestinyReportReasonCategoryDefinition,
-  DestinyArtifactDefinition,
-  DestinyBreakerTypeDefinition,
-  DestinyChecklistDefinition,
-  DestinyEnergyTypeDefinition,
-  DestinySocialCommendationNodeDefinition,
-  DestinyGuardianRankDefinition,
-  DestinyGuardianRankConstantsDefinition,
-  DestinyLoadoutConstantsDefinition,
-  DestinyFireteamFinderConstantsDefinition,
-  DestinyGlobalConstantsDefinition,
-  DestinyInventoryItemConstantsDefinition,
-  DestinyManifest
-} from './interfaces.js';
-
-/**
- * this describes a big object holding several tables of hash-keyed DestinyDefinitions.
- * this is roughly what you get if you decode the gigantic, single-json manifest blob,
- * but also just what we use here to dole out single-table, typed definitions
- */
-export interface AllDestinyManifestComponents {
-  DestinyPlaceDefinition: { [key: number]: DestinyPlaceDefinition };
-  DestinyActivityDefinition: { [key: number]: DestinyActivityDefinition };
-  DestinyActivityTypeDefinition: { [key: number]: DestinyActivityTypeDefinition };
-  DestinyClassDefinition: { [key: number]: DestinyClassDefinition };
-  DestinyGenderDefinition: { [key: number]: DestinyGenderDefinition };
-  DestinyInventoryBucketDefinition: { [key: number]: DestinyInventoryBucketDefinition };
-  DestinyRaceDefinition: { [key: number]: DestinyRaceDefinition };
-  DestinyUnlockDefinition: { [key: number]: DestinyUnlockDefinition };
-  DestinyStatGroupDefinition: { [key: number]: DestinyStatGroupDefinition };
-  DestinyProgressionMappingDefinition: { [key: number]: DestinyProgressionMappingDefinition };
-  DestinyFactionDefinition: { [key: number]: DestinyFactionDefinition };
-  DestinyVendorGroupDefinition: { [key: number]: DestinyVendorGroupDefinition };
-  DestinyRewardSourceDefinition: { [key: number]: DestinyRewardSourceDefinition };
-  DestinyUnlockValueDefinition: { [key: number]: DestinyUnlockValueDefinition };
-  DestinyItemCategoryDefinition: { [key: number]: DestinyItemCategoryDefinition };
-  DestinyDamageTypeDefinition: { [key: number]: DestinyDamageTypeDefinition };
-  DestinyActivityModeDefinition: { [key: number]: DestinyActivityModeDefinition };
-  DestinyMedalTierDefinition: { [key: number]: DestinyMedalTierDefinition };
-  DestinyActivityDifficultyTierCollectionDefinition: { [key: number]: DestinyActivityDifficultyTierCollectionDefinition };
-  DestinyActivityFamilyDefinition: { [key: number]: DestinyActivityFamilyDefinition };
-  DestinyActivityGraphDefinition: { [key: number]: DestinyActivityGraphDefinition };
-  DestinyActivityInteractableDefinition: { [key: number]: DestinyActivityInteractableDefinition };
-  DestinyActivityLoadoutRestrictionDefinition: { [key: number]: DestinyActivityLoadoutRestrictionDefinition };
-  DestinyActivitySelectableSkullCollectionDefinition: { [key: number]: DestinyActivitySelectableSkullCollectionDefinition };
-  DestinyActivitySelectableSkullExclusionGroupDefinition: { [key: number]: DestinyActivitySelectableSkullExclusionGroupDefinition };
-  DestinyActivitySkullCategoryDefinition: { [key: number]: DestinyActivitySkullCategoryDefinition };
-  DestinyActivitySkullSubcategoryDefinition: { [key: number]: DestinyActivitySkullSubcategoryDefinition };
-  DestinyCollectibleDefinition: { [key: number]: DestinyCollectibleDefinition };
-  DestinyDestinationDefinition: { [key: number]: DestinyDestinationDefinition };
-  DestinyEquipableItemSetDefinition: { [key: number]: DestinyEquipableItemSetDefinition };
-  DestinyEquipmentSlotDefinition: { [key: number]: DestinyEquipmentSlotDefinition };
-  DestinyEventCardDefinition: { [key: number]: DestinyEventCardDefinition };
-  DestinyFireteamFinderActivityGraphDefinition: { [key: number]: DestinyFireteamFinderActivityGraphDefinition };
-  DestinyFireteamFinderActivitySetDefinition: { [key: number]: DestinyFireteamFinderActivitySetDefinition };
-  DestinyFireteamFinderLabelDefinition: { [key: number]: DestinyFireteamFinderLabelDefinition };
-  DestinyFireteamFinderLabelGroupDefinition: { [key: number]: DestinyFireteamFinderLabelGroupDefinition };
-  DestinyFireteamFinderOptionDefinition: { [key: number]: DestinyFireteamFinderOptionDefinition };
-  DestinyFireteamFinderOptionGroupDefinition: { [key: number]: DestinyFireteamFinderOptionGroupDefinition };
-  DestinyIconDefinition: { [key: number]: DestinyIconDefinition };
-  DestinyStatDefinition: { [key: number]: DestinyStatDefinition };
-  DestinyInventoryItemDefinition: { [key: number]: DestinyInventoryItemDefinition };
-  DestinyItemFilterDefinition: { [key: number]: DestinyItemFilterDefinition };
-  DestinyItemTierTypeDefinition: { [key: number]: DestinyItemTierTypeDefinition };
-  DestinyLoadoutColorDefinition: { [key: number]: DestinyLoadoutColorDefinition };
-  DestinyLoadoutIconDefinition: { [key: number]: DestinyLoadoutIconDefinition };
-  DestinyLoadoutNameDefinition: { [key: number]: DestinyLoadoutNameDefinition };
-  DestinyLocationDefinition: { [key: number]: DestinyLocationDefinition };
-  DestinyLoreDefinition: { [key: number]: DestinyLoreDefinition };
-  DestinyMaterialRequirementSetDefinition: { [key: number]: DestinyMaterialRequirementSetDefinition };
-  DestinyMetricDefinition: { [key: number]: DestinyMetricDefinition };
-  DestinyObjectiveDefinition: { [key: number]: DestinyObjectiveDefinition };
-  DestinySandboxPerkDefinition: { [key: number]: DestinySandboxPerkDefinition };
-  DestinyPlugSetDefinition: { [key: number]: DestinyPlugSetDefinition };
-  DestinyPowerCapDefinition: { [key: number]: DestinyPowerCapDefinition };
-  DestinyPresentationNodeDefinition: { [key: number]: DestinyPresentationNodeDefinition };
-  DestinyProgressionDefinition: { [key: number]: DestinyProgressionDefinition };
-  DestinyProgressionLevelRequirementDefinition: { [key: number]: DestinyProgressionLevelRequirementDefinition };
-  DestinyRecordDefinition: { [key: number]: DestinyRecordDefinition };
-  DestinySandboxPatternDefinition: { [key: number]: DestinySandboxPatternDefinition };
-  DestinySeasonDefinition: { [key: number]: DestinySeasonDefinition };
-  DestinySeasonPassDefinition: { [key: number]: DestinySeasonPassDefinition };
-  DestinySocialCommendationDefinition: { [key: number]: DestinySocialCommendationDefinition };
-  DestinySocketCategoryDefinition: { [key: number]: DestinySocketCategoryDefinition };
-  DestinySocketTypeDefinition: { [key: number]: DestinySocketTypeDefinition };
-  DestinyTraitDefinition: { [key: number]: DestinyTraitDefinition };
-  DestinyVendorDefinition: { [key: number]: DestinyVendorDefinition };
-  DestinyMilestoneDefinition: { [key: number]: DestinyMilestoneDefinition };
-  DestinyActivityModifierDefinition: { [key: number]: DestinyActivityModifierDefinition };
-  DestinyReportReasonCategoryDefinition: { [key: number]: DestinyReportReasonCategoryDefinition };
-  DestinyArtifactDefinition: { [key: number]: DestinyArtifactDefinition };
-  DestinyBreakerTypeDefinition: { [key: number]: DestinyBreakerTypeDefinition };
-  DestinyChecklistDefinition: { [key: number]: DestinyChecklistDefinition };
-  DestinyEnergyTypeDefinition: { [key: number]: DestinyEnergyTypeDefinition };
-  DestinySocialCommendationNodeDefinition: { [key: number]: DestinySocialCommendationNodeDefinition };
-  DestinyGuardianRankDefinition: { [key: number]: DestinyGuardianRankDefinition };
-  DestinyGuardianRankConstantsDefinition: { [key: number]: DestinyGuardianRankConstantsDefinition };
-  DestinyLoadoutConstantsDefinition: { [key: number]: DestinyLoadoutConstantsDefinition };
-  DestinyFireteamFinderConstantsDefinition: { [key: number]: DestinyFireteamFinderConstantsDefinition };
-  DestinyGlobalConstantsDefinition: { [key: number]: DestinyGlobalConstantsDefinition };
-  DestinyInventoryItemConstantsDefinition: { [key: number]: DestinyInventoryItemConstantsDefinition };
-}
-
-export type DestinyInventoryItemLiteDefinition = Omit<
-  DestinyInventoryItemDefinition,
-  | "iconWatermarkShelved" | "screenshot" | "flavorText" | "tooltipStyle"
-  | "action" | "stats" | "statsEnabledUnlockExpression" | "translationBlock"
-  | "preview" | "sourceData" | "objectives" | "metrics" | "plug"
-  | "gearset" | "sack" | "sockets" | "investmentStats" | "traitIds"
-  | "traitHashes" | "boundToRelease" | "hash" | "index" | "contentIdentifier"
-  | "redacted" | "blacklisted"
->;
-
-/**
- * languages the manifest comes in, as their required keys to download them
- */
-export const destinyManifestLanguages = [
-  'de',
-  'en',
-  'es',
-  'es-mx',
-  'fr',
-  'it',
-  'ja',
-  'ko',
-  'pl',
-  'pt-br',
-  'ru',
-  'zh-chs',
-  'zh-cht',
-] as const;
-
-export type DestinyManifestLanguage = typeof destinyManifestLanguages[number];
-
-
-
-
-// thoughts:
-// this relies on the assumption that the separate
-// manifest pieces offered in jsonWorldComponentContentPaths,
-// will all be present in the big manifest at jsonWorldContentPaths.
-
-// this has been the case so far, but there aren't
-// strict spec standards for how the manifest will be available
-
-export type DestinyManifestComponentName = keyof AllDestinyManifestComponents;
-
-export type DestinyManifestSlice<K extends Readonly<DestinyManifestComponentName[]>> = Pick<
-  AllDestinyManifestComponents,
-  K[number]
->;
-
-/**
- * given a STRING table name, returns that TYPE, so that you can write a function like:
- * func<K extends DestinyManifestComponentName>(arg0:K):DestinyDefinitionFrom<K>{...}
- * i.e.
- * func('DestinyInventoryItemDefinition') will return type DestinyInventoryItemDefinition
- */
-export type DestinyDefinitionFrom<
-  K extends DestinyManifestComponentName
-> = AllDestinyManifestComponents[K][number];
-
-export interface GetAllDestinyManifestComponentsParams {
-  destinyManifest: DestinyManifest;
-  language: DestinyManifestLanguage;
-}
-/** fetches the enormous combined JSON manifest file */
-export function getAllDestinyManifestComponents(
-  http: HttpClient,
-  params: GetAllDestinyManifestComponentsParams
-): Promise<AllDestinyManifestComponents> {
-  return get(http, 'https://www.bungie.net'+params.destinyManifest.jsonWorldContentPaths[params.language]);
-}
-
-export interface GetDestinyManifestComponentParams<T extends DestinyManifestComponentName> {
-  destinyManifest: DestinyManifest;
-  tableName: T;
-  language: DestinyManifestLanguage;
-}
-/**
- * this fetches and returns a single table (Component) from the d2 manifest
- * i.e. DestinyInventoryItemDefinition / DestinyObjectiveDefinition /
- * DestinyVendorDefinition / DestinySeasonDefinition / etc.
- *
- * due to typescript limitations, the table name needs to be recognized by
- * typescript as a const (not mutable between inception and going into the function),
- * so that it considers it a table name and not just a string.
- *
- * this is easy with a string, since
- *
- * `const x = 'thing';` is type `'thing'`, not type `string`,
- *
- * but make sure it's not a `let x =` or a dynamically set string.
- */
- export async function getDestinyManifestComponent<T extends DestinyManifestComponentName>(
-  http: HttpClient,
-  params: GetDestinyManifestComponentParams<T>
-): Promise<AllDestinyManifestComponents[T]> {
-  const url = 'https://www.bungie.net' +
-      params.destinyManifest.jsonWorldComponentContentPaths[params.language][params.tableName];
-  try {
-    return await get(http, url);
-  } catch (e) {
-    try {
-      return await get(http, `${url}?retry`);
-    } catch {
-      throw e;
-    }
-  }
-}
-
-export interface GetDestinyManifestSliceParams<T extends DestinyManifestComponentName[]> {
-  destinyManifest: DestinyManifest;
-  tableNames: T;
-  language: DestinyManifestLanguage;
-}
-/**
- * this returns a similar structure to getAllDestinyManifestComponents (the big manifest json)
- * but only specific components within. it bundles multiple single tables requests,
- * into a single properly typed object with keys named after manifest components
- *
- * i.e. `{ DestinyInventoryItemDefinition: etc...,
- * DestinyObjectiveDefinition: etc... }`
- *
- * due to typescript limitations, the array of tableNames needs to be recognized by
- * typescript as readonly (not mutable between inception and going into the function),
- * so that it considers them table names and not just strings.
- *
- * like `['DestinyInventoryItemDefinition' as const]`
- *
- * or maybe `['DestinyInventoryItemDefinition'] as const`
- *
- * or just feed in into the function hardcoded like
- *
- * `function(['DestinyInventoryItemDefinition'])`
- */
-export async function getDestinyManifestSlice<T extends DestinyManifestComponentName[]>(
-  http: HttpClient,
-  params: GetDestinyManifestSliceParams<T>
-): Promise<DestinyManifestSlice<T>> {
-  const downloadedTables = await Promise.all(
-    params.tableNames.map(async (tableName) => {
-      const tableContent = await getDestinyManifestComponent(http, {
-        destinyManifest: params.destinyManifest,
-        tableName,
-        language: params.language,
-      });
-      return { tableName, tableContent };
-    })
-  );
-  const manifestSlice = {} as AllDestinyManifestComponents;
-  for (const downloadedTable of downloadedTables) {
-    manifestSlice[downloadedTable.tableName] = downloadedTable.tableContent as any;
-  }
-  return manifestSlice as DestinyManifestSlice<T>;
-}
-

package/generated-src/fireteam/api.ts

@@ -1,151 +0,0 @@
-/**
- * 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 {
-  FireteamDateRange,
-  FireteamPlatform,
-  FireteamPublicSearchOption,
-  FireteamResponse,
-  FireteamSlotSearch,
-  SearchResultOfFireteamResponse,
-  SearchResultOfFireteamSummary
-} from './interfaces.js';
-import {
-  ServerResponse
-} from '../common.js';
-
-const API_BASE = "https://www.bungie.net/Platform/Fireteam/";
-
-export interface GetActivePrivateClanFireteamCountParams {
-  /** The group id of the clan. */
-  groupId: string;
-}
-
-/**
- * Gets a count of all active non-public fireteams for the specified clan. Maximum
- * value returned is 25.
- */
-export function getActivePrivateClanFireteamCount(http: HttpClient, params: GetActivePrivateClanFireteamCountParams): Promise<ServerResponse<number>> {
-  return get(http, `${API_BASE}Clan/${params.groupId}/ActiveCount/`);
-}
-
-export interface GetAvailableClanFireteamsParams {
-  /** The activity type to filter by. */
-  activityType: number;
-  /** The date range to grab available fireteams. */
-  dateRange: FireteamDateRange;
-  /**
-   * If you wish the result to exclude immediate fireteams, set this to true.
-   * Immediate-only can be forced using the dateRange enum.
-   */
-  excludeImmediate?: boolean;
-  /** The group id of the clan. */
-  groupId: string;
-  /** An optional language filter. */
-  langFilter?: string;
-  /** Zero based page */
-  page: number;
-  /** The platform filter. */
-  platform: FireteamPlatform;
-  /** Determines public/private filtering. */
-  publicOnly: FireteamPublicSearchOption;
-  /** Filters based on available slots */
-  slotFilter: FireteamSlotSearch;
-}
-
-/**
- * Gets a listing of all of this clan's fireteams that are have available slots.
- * Caller is not checked for join criteria so caching is maximized.
- */
-export function getAvailableClanFireteams(http: HttpClient, params: GetAvailableClanFireteamsParams): Promise<ServerResponse<SearchResultOfFireteamSummary>> {
-  const strParams: Record<string, string> = {};
-  if (params.excludeImmediate !== undefined) { strParams.excludeImmediate = params.excludeImmediate.toString(); }
-  if (params.langFilter !== undefined) { strParams.langFilter = params.langFilter; }
-  return get(http, `${API_BASE}Clan/${params.groupId}/Available/${params.platform}/${params.activityType}/${params.dateRange}/${params.slotFilter}/${params.publicOnly}/${params.page}/`, strParams);
-}
-
-export interface SearchPublicAvailableClanFireteamsParams {
-  /** The activity type to filter by. */
-  activityType: number;
-  /** The date range to grab available fireteams. */
-  dateRange: FireteamDateRange;
-  /**
-   * If you wish the result to exclude immediate fireteams, set this to true.
-   * Immediate-only can be forced using the dateRange enum.
-   */
-  excludeImmediate?: boolean;
-  /** An optional language filter. */
-  langFilter?: string;
-  /** Zero based page */
-  page: number;
-  /** The platform filter. */
-  platform: FireteamPlatform;
-  /** Filters based on available slots */
-  slotFilter: FireteamSlotSearch;
-}
-
-/**
- * Gets a listing of all public fireteams starting now with open slots. Caller is
- * not checked for join criteria so caching is maximized.
- */
-export function searchPublicAvailableClanFireteams(http: HttpClient, params: SearchPublicAvailableClanFireteamsParams): Promise<ServerResponse<SearchResultOfFireteamSummary>> {
-  const strParams: Record<string, string> = {};
-  if (params.excludeImmediate !== undefined) { strParams.excludeImmediate = params.excludeImmediate.toString(); }
-  if (params.langFilter !== undefined) { strParams.langFilter = params.langFilter; }
-  return get(http, `${API_BASE}Search/Available/${params.platform}/${params.activityType}/${params.dateRange}/${params.slotFilter}/${params.page}/`, strParams);
-}
-
-export interface GetMyClanFireteamsParams {
-  /**
-   * If true, filter by clan. Otherwise, ignore the clan and show all of the user's
-   * fireteams.
-   */
-  groupFilter?: boolean;
-  /**
-   * The group id of the clan. (This parameter is ignored unless the optional query
-   * parameter groupFilter is true).
-   */
-  groupId: string;
-  /** If true, return fireteams that have been closed. */
-  includeClosed: boolean;
-  /** An optional language filter. */
-  langFilter?: string;
-  /** Deprecated parameter, ignored. */
-  page: number;
-  /** The platform filter. */
-  platform: FireteamPlatform;
-}
-
-/**
- * Gets a listing of all fireteams that caller is an applicant, a member, or an
- * alternate of.
- */
-export function getMyClanFireteams(http: HttpClient, params: GetMyClanFireteamsParams): Promise<ServerResponse<SearchResultOfFireteamResponse>> {
-  const strParams: Record<string, string> = {};
-  if (params.groupFilter !== undefined) { strParams.groupFilter = params.groupFilter.toString(); }
-  if (params.langFilter !== undefined) { strParams.langFilter = params.langFilter; }
-  return get(http, `${API_BASE}Clan/${params.groupId}/My/${params.platform}/${params.includeClosed}/${params.page}/`, strParams);
-}
-
-export interface GetClanFireteamParams {
-  /** The unique id of the fireteam. */
-  fireteamId: string;
-  /** The group id of the clan. */
-  groupId: string;
-}
-
-/** Gets a specific fireteam. */
-export function getClanFireteam(http: HttpClient, params: GetClanFireteamParams): Promise<ServerResponse<FireteamResponse>> {
-  return get(http, `${API_BASE}Clan/${params.groupId}/Summary/${params.fireteamId}/`);
-}

package/generated-src/fireteam/index.ts

@@ -1,17 +0,0 @@
-/**
- * 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/fireteam/interfaces.ts

@@ -1,183 +0,0 @@
-/**
- * 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,
-  PagedQuery
-} from '../common.js';
-import {
-  UserInfoCard
-} from '../user/interfaces.js';
-
-export const enum FireteamDateRange {
-  All = 0,
-  Now = 1,
-  TwentyFourHours = 2,
-  FortyEightHours = 3,
-  ThisWeek = 4
-}
-
-export const enum FireteamPlatform {
-  Any = 0,
-  Playstation4 = 1,
-  XboxOne = 2,
-  Blizzard = 3,
-  Steam = 4,
-  Stadia = 5,
-  Egs = 6
-}
-
-export const enum FireteamPublicSearchOption {
-  PublicAndPrivate = 0,
-  PublicOnly = 1,
-  PrivateOnly = 2
-}
-
-export const enum FireteamSlotSearch {
-  NoSlotRestriction = 0,
-  HasOpenPlayerSlots = 1,
-  HasOpenPlayerOrAltSlots = 2
-}
-
-export interface SearchResultOfFireteamSummary {
-  readonly results: FireteamSummary[];
-  readonly totalResults: number;
-  readonly hasMore: boolean;
-  readonly query: PagedQuery;
-  readonly replacementContinuationToken: string;
-  /**
-   * If useTotalResults is true, then totalResults represents an accurate count.
-   *
-   * If False, it does not, and may be estimated/only the size of the current page.
-   *
-   * Either way, you should probably always only trust hasMore.
-   *
-   * This is a long-held historical throwback to when we used to do paging with known
-   * total results. Those queries toasted our database, and we were left to hastily
-   * alter our endpoints and create backward- compatible shims, of which
-   * useTotalResults is one.
-   */
-  readonly useTotalResults: boolean;
-}
-
-export interface FireteamSummary {
-  readonly fireteamId: string;
-  readonly groupId: string;
-  readonly platform: FireteamPlatform;
-  readonly activityType: number;
-  readonly isImmediate: boolean;
-  readonly scheduledTime?: string;
-  readonly ownerMembershipId: string;
-  readonly playerSlotCount: number;
-  readonly alternateSlotCount?: number;
-  readonly availablePlayerSlotCount: number;
-  readonly availableAlternateSlotCount: number;
-  readonly title: string;
-  readonly dateCreated: string;
-  readonly dateModified?: string;
-  readonly isPublic: boolean;
-  readonly locale: string;
-  readonly isValid: boolean;
-  readonly datePlayerModified: string;
-  readonly titleBeforeModeration: string;
-  /** Mapped to DestinyGuardianRankDefinition in the manifest. */
-  readonly ownerCurrentGuardianRankSnapshot: number;
-  /** Mapped to DestinyGuardianRankDefinition in the manifest. */
-  readonly ownerHighestLifetimeGuardianRankSnapshot: number;
-  readonly ownerTotalCommendationScoreSnapshot: number;
-}
-
-export interface SearchResultOfFireteamResponse {
-  readonly results: FireteamResponse[];
-  readonly totalResults: number;
-  readonly hasMore: boolean;
-  readonly query: PagedQuery;
-  readonly replacementContinuationToken: string;
-  /**
-   * If useTotalResults is true, then totalResults represents an accurate count.
-   *
-   * If False, it does not, and may be estimated/only the size of the current page.
-   *
-   * Either way, you should probably always only trust hasMore.
-   *
-   * This is a long-held historical throwback to when we used to do paging with known
-   * total results. Those queries toasted our database, and we were left to hastily
-   * alter our endpoints and create backward- compatible shims, of which
-   * useTotalResults is one.
-   */
-  readonly useTotalResults: boolean;
-}
-
-export interface FireteamResponse {
-  readonly Summary: FireteamSummary;
-  readonly Members: FireteamMember[];
-  readonly Alternates: FireteamMember[];
-}
-
-export interface FireteamMember {
-  readonly destinyUserInfo: FireteamUserInfoCard;
-  readonly bungieNetUserInfo: UserInfoCard;
-  readonly characterId: string;
-  readonly dateJoined: string;
-  readonly hasMicrophone: boolean;
-  readonly lastPlatformInviteAttemptDate: string;
-  readonly lastPlatformInviteAttemptResult: FireteamPlatformInviteResult;
-}
-
-export interface FireteamUserInfoCard {
-  readonly FireteamDisplayName: string;
-  readonly FireteamMembershipType: BungieMembershipType;
-  /**
-   * A platform specific additional display name - ex: psn Real Name, bnet Unique
-   * Name, etc.
-   */
-  readonly supplementalDisplayName: string;
-  /** URL the Icon if available. */
-  readonly iconPath: string;
-  /**
-   * If there is a cross save override in effect, this value will tell you the type
-   * that is overridding this one.
-   */
-  readonly crossSaveOverride: BungieMembershipType;
-  /**
-   * The list of Membership Types indicating the platforms on which this Membership
-   * can be used.
-   *
-   * Not in Cross Save = its original membership type. Cross Save Primary = Any
-   * membership types it is overridding, and its original membership type Cross Save
-   * Overridden = Empty list
-   */
-  readonly applicableMembershipTypes: BungieMembershipType[];
-  /** If True, this is a public user membership. */
-  readonly isPublic: boolean;
-  /** Type of the membership. Not necessarily the native type. */
-  readonly membershipType: BungieMembershipType;
-  /** Membership ID as they user is known in the Accounts service */
-  readonly membershipId: string;
-  /**
-   * Display Name the player has chosen for themselves. The display name is optional
-   * when the data type is used as input to a platform API.
-   */
-  readonly displayName: string;
-  /** The bungie global display name, if set. */
-  readonly bungieGlobalDisplayName: string;
-  /** The bungie global display name code, if set. */
-  readonly bungieGlobalDisplayNameCode?: number;
-}
-
-export const enum FireteamPlatformInviteResult {
-  None = 0,
-  Success = 1,
-  AlreadyInFireteam = 2,
-  Throttled = 3,
-  ServiceError = 4
-}