@taskeren/bungie-api-ts 5.10.0

package/generated-src/tokens/interfaces.ts

@@ -0,0 +1,102 @@
+/**
+ * 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 {
+  DestinyCollectibleDefinition,
+  DestinyInventoryItemDefinition,
+  DestinyRecordDefinition
+} from '../destiny2/interfaces.js';
+
+export interface PartnerOfferClaimRequest {
+  readonly PartnerOfferId: string;
+  readonly BungieNetMembershipId: string;
+  readonly TransactionId: string;
+}
+
+export interface PartnerOfferSkuHistoryResponse {
+  readonly SkuIdentifier: string;
+  readonly LocalizedName: string;
+  readonly LocalizedDescription: string;
+  readonly ClaimDate: string;
+  readonly AllOffersApplied: boolean;
+  readonly TransactionId: string;
+  readonly SkuOffers: PartnerOfferHistoryResponse[];
+}
+
+export interface PartnerOfferHistoryResponse {
+  readonly PartnerOfferKey: string;
+  readonly MembershipId?: string;
+  readonly MembershipType?: BungieMembershipType;
+  readonly LocalizedName: string;
+  readonly LocalizedDescription: string;
+  readonly IsConsumable: boolean;
+  readonly QuantityApplied: number;
+  readonly ApplyDate?: string;
+}
+
+export interface PartnerRewardHistoryResponse {
+  readonly PartnerOffers: PartnerOfferSkuHistoryResponse[];
+  readonly TwitchDrops: TwitchDropHistoryResponse[];
+}
+
+export interface TwitchDropHistoryResponse {
+  readonly Title: string;
+  readonly Description: string;
+  readonly CreatedAt?: string;
+  readonly ClaimState?: DropStateEnum;
+}
+
+export const enum DropStateEnum {
+  Claimed = 0,
+  Applied = 1,
+  Fulfilled = 2
+}
+
+export interface BungieRewardDisplay {
+  readonly UserRewardAvailabilityModel: UserRewardAvailabilityModel;
+  readonly ObjectiveDisplayProperties: RewardDisplayProperties;
+  readonly RewardDisplayProperties: RewardDisplayProperties;
+}
+
+export interface UserRewardAvailabilityModel {
+  readonly AvailabilityModel: RewardAvailabilityModel;
+  readonly IsAvailableForUser: boolean;
+  readonly IsUnlockedForUser: boolean;
+}
+
+export interface RewardAvailabilityModel {
+  readonly HasExistingCode: boolean;
+  readonly RecordDefinitions: DestinyRecordDefinition[];
+  readonly CollectibleDefinitions: CollectibleDefinitions[];
+  readonly IsOffer: boolean;
+  readonly HasOffer: boolean;
+  readonly OfferApplied: boolean;
+  readonly DecryptedToken: string;
+  readonly IsLoyaltyReward: boolean;
+  readonly ShopifyEndDate?: string;
+  readonly GameEarnByDate: string;
+  readonly RedemptionEndDate: string;
+}
+
+export interface CollectibleDefinitions {
+  readonly CollectibleDefinition: DestinyCollectibleDefinition;
+  readonly DestinyInventoryItemDefinition: DestinyInventoryItemDefinition;
+}
+
+export interface RewardDisplayProperties {
+  readonly Name: string;
+  readonly Description: string;
+  readonly ImagePath: string;
+}

package/generated-src/trending/api.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 {
+  SearchResultOfTrendingEntry,
+  TrendingCategories,
+  TrendingDetail,
+  TrendingEntryType
+} from './interfaces.js';
+import {
+  ServerResponse
+} from '../common.js';
+
+const API_BASE = "https://www.bungie.net/Platform/Trending/";
+
+/**
+ * Returns trending items for Bungie.net, collapsed into the first page of items
+ * per category. For pagination within a category, call GetTrendingCategory.
+ */
+export function getTrendingCategories(http: HttpClient): Promise<ServerResponse<TrendingCategories>> {
+  return get(http, `${API_BASE}Categories/`);
+}
+
+export interface GetTrendingCategoryParams {
+  /** The ID of the category for whom you want additional results. */
+  categoryId: string;
+  /** The page # of results to return. */
+  pageNumber: number;
+}
+
+/** Returns paginated lists of trending items for a category. */
+export function getTrendingCategory(http: HttpClient, params: GetTrendingCategoryParams): Promise<ServerResponse<SearchResultOfTrendingEntry>> {
+  return get(http, `${API_BASE}Categories/${params.categoryId}/${params.pageNumber}/`);
+}
+
+export interface GetTrendingEntryDetailParams {
+  /** The identifier for the entity to be returned. */
+  identifier: string;
+  /** The type of entity to be returned. */
+  trendingEntryType: TrendingEntryType;
+}
+
+/**
+ * Returns the detailed results for a specific trending entry. Note that trending
+ * entries are uniquely identified by a combination of *both* the TrendingEntryType
+ * *and* the identifier: the identifier alone is not guaranteed to be globally
+ * unique.
+ */
+export function getTrendingEntryDetail(http: HttpClient, params: GetTrendingEntryDetailParams): Promise<ServerResponse<TrendingDetail>> {
+  return get(http, `${API_BASE}Details/${params.trendingEntryType}/${params.identifier}/`);
+}

package/generated-src/trending/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/trending/interfaces.ts

@@ -0,0 +1,188 @@
+/**
+ * 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 {
+  ContentItemPublicContract
+} from '../content/interfaces.js';
+import {
+  DestinyMilestoneContent,
+  DestinyPublicActivityStatus,
+  DestinyPublicMilestone
+} from '../destiny2/interfaces.js';
+import {
+  PagedQuery
+} from '../common.js';
+
+/** The known entity types that you can have returned from Trending. */
+export const enum TrendingEntryType {
+  News = 0,
+  DestinyItem = 1,
+  DestinyActivity = 2,
+  DestinyRitual = 3,
+  SupportArticle = 4,
+  Creation = 5,
+  Stream = 6,
+  Update = 7,
+  Link = 8,
+  ForumTag = 9,
+  Container = 10,
+  Release = 11
+}
+
+export interface TrendingCategories {
+  readonly categories: TrendingCategory[];
+}
+
+export interface TrendingCategory {
+  readonly categoryName: string;
+  readonly entries: SearchResultOfTrendingEntry;
+  readonly categoryId: string;
+}
+
+export interface SearchResultOfTrendingEntry {
+  readonly results: TrendingEntry[];
+  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;
+}
+
+/**
+ * The list entry view for trending items. Returns just enough to show the item on
+ * the trending page.
+ */
+export interface TrendingEntry {
+  /** The weighted score of this trending item. */
+  readonly weight: number;
+  readonly isFeatured: boolean;
+  /**
+   * We don't know whether the identifier will be a string, a uint, or a long... so
+   * we're going to cast it all to a string. But either way, we need any trending
+   * item created to have a single unique identifier for its type.
+   */
+  readonly identifier: string;
+  /**
+   * An enum - unfortunately - dictating all of the possible kinds of trending items
+   * that you might get in your result set, in case you want to do custom rendering
+   * or call to get the details of the item.
+   */
+  readonly entityType: TrendingEntryType;
+  /**
+   * The localized "display name/article title/'primary localized identifier'" of the
+   * entity.
+   */
+  readonly displayName: string;
+  /**
+   * If the entity has a localized tagline/subtitle/motto/whatever, that is found
+   * here.
+   */
+  readonly tagline: string;
+  readonly image: string;
+  readonly startDate?: string;
+  readonly endDate?: string;
+  readonly link: string;
+  /**
+   * If this is populated, the entry has a related WebM video to show. I am 100%
+   * certain I am going to regret putting this directly on TrendingEntry, but it will
+   * work so yolo
+   */
+  readonly webmVideo: string;
+  /**
+   * If this is populated, the entry has a related MP4 video to show. I am 100%
+   * certain I am going to regret putting this directly on TrendingEntry, but it will
+   * work so yolo
+   */
+  readonly mp4Video: string;
+  /**
+   * If isFeatured, this image will be populated with whatever the featured image is.
+   * Note that this will likely be a very large image, so don't use it all the time.
+   */
+  readonly featureImage: string;
+  /**
+   * If the item is of entityType TrendingEntryType.Container, it may have items -
+   * also Trending Entries - contained within it. This is the ordered list of those
+   * to display under the Container's header.
+   */
+  readonly items: TrendingEntry[];
+  /** If the entry has a date at which it was created, this is that date. */
+  readonly creationDate?: string;
+}
+
+export interface TrendingDetail {
+  readonly identifier: string;
+  readonly entityType: TrendingEntryType;
+  readonly news: TrendingEntryNews;
+  readonly support: TrendingEntrySupportArticle;
+  readonly destinyItem: TrendingEntryDestinyItem;
+  readonly destinyActivity: TrendingEntryDestinyActivity;
+  readonly destinyRitual: TrendingEntryDestinyRitual;
+  readonly creation: TrendingEntryCommunityCreation;
+}
+
+export interface TrendingEntryNews {
+  readonly article: ContentItemPublicContract;
+}
+
+export interface TrendingEntrySupportArticle {
+  readonly article: ContentItemPublicContract;
+}
+
+export interface TrendingEntryDestinyItem {
+  readonly itemHash: number;
+}
+
+export interface TrendingEntryDestinyActivity {
+  readonly activityHash: number;
+  readonly status: DestinyPublicActivityStatus;
+}
+
+export interface TrendingEntryDestinyRitual {
+  readonly image: string;
+  readonly icon: string;
+  readonly title: string;
+  readonly subtitle: string;
+  readonly dateStart?: string;
+  readonly dateEnd?: string;
+  /**
+   * A destiny event does not necessarily have a related Milestone, but if it does
+   * the details will be returned here.
+   */
+  readonly milestoneDetails: DestinyPublicMilestone;
+  /**
+   * A destiny event will not necessarily have milestone "custom content", but if it
+   * does the details will be here.
+   */
+  readonly eventContent: DestinyMilestoneContent;
+}
+
+export interface TrendingEntryCommunityCreation {
+  readonly media: string;
+  readonly title: string;
+  readonly author: string;
+  readonly authorMembershipId: string;
+  readonly postId: string;
+  readonly body: string;
+  readonly upvotes: number;
+}

package/generated-src/user/api.ts

@@ -0,0 +1,130 @@
+/**
+ * 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 {
+  BungieCredentialType,
+  GeneralUser,
+  GetCredentialTypesForAccountResponse,
+  HardLinkedUserMembership,
+  UserMembershipData,
+  UserSearchPrefixRequest,
+  UserSearchResponse,
+  UserTheme
+} from './interfaces.js';
+import {
+  BungieMembershipType,
+  ServerResponse
+} from '../common.js';
+
+const API_BASE = "https://www.bungie.net/Platform/User/";
+
+export interface GetBungieNetUserByIdParams {
+  /** The requested Bungie.net membership id. */
+  id: string;
+}
+
+/** Loads a bungienet user by membership id. */
+export function getBungieNetUserById(http: HttpClient, params: GetBungieNetUserByIdParams): Promise<ServerResponse<GeneralUser>> {
+  return get(http, `${API_BASE}GetBungieNetUserById/${params.id}/`);
+}
+
+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 function getSanitizedPlatformDisplayNames(http: HttpClient, params: GetSanitizedPlatformDisplayNamesParams): Promise<ServerResponse<{ [key in BungieCredentialType]: string }>> {
+  return get(http, `${API_BASE}GetSanitizedPlatformDisplayNames/${params.membershipId}/`);
+}
+
+export interface GetCredentialTypesForTargetAccountParams {
+  /** The user's membership id */
+  membershipId: string;
+}
+
+/** Returns a list of credential types attached to the requested account */
+export function getCredentialTypesForTargetAccount(http: HttpClient, params: GetCredentialTypesForTargetAccountParams): Promise<ServerResponse<GetCredentialTypesForAccountResponse[]>> {
+  return get(http, `${API_BASE}GetCredentialTypesForTargetAccount/${params.membershipId}/`);
+}
+
+/** Returns a list of all available user themes. */
+export function getAvailableThemes(http: HttpClient): Promise<ServerResponse<UserTheme[]>> {
+  return get(http, `${API_BASE}GetAvailableThemes/`);
+}
+
+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 function getMembershipDataById(http: HttpClient, params: GetMembershipDataByIdParams): Promise<ServerResponse<UserMembershipData>> {
+  return get(http, `${API_BASE}GetMembershipsById/${params.membershipId}/${params.membershipType}/`);
+}
+
+/**
+ * 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 function getMembershipDataForCurrentUser(http: HttpClient): Promise<ServerResponse<UserMembershipData>> {
+  return get(http, `${API_BASE}GetMembershipsForCurrentUser/`);
+}
+
+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 function getMembershipFromHardLinkedCredential(http: HttpClient, params: GetMembershipFromHardLinkedCredentialParams): Promise<ServerResponse<HardLinkedUserMembership>> {
+  return get(http, `${API_BASE}GetMembershipFromHardLinkedCredential/${params.crType}/${params.credential}/`);
+}
+
+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 function searchByGlobalNamePrefix(http: HttpClient, params: SearchByGlobalNamePrefixParams): Promise<ServerResponse<UserSearchResponse>> {
+  return get(http, `${API_BASE}Search/Prefix/${params.displayNamePrefix}/${params.page}/`);
+}
+
+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 function searchByGlobalNamePost(http: HttpClient, params: SearchByGlobalNamePostParams, body: UserSearchPrefixRequest): Promise<ServerResponse<UserSearchResponse>> {
+    return post(http, `${API_BASE}Search/GlobalName/${params.page}/`, body);
+}

package/generated-src/user/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';