@taskeren/bungie-api-ts 5.10.0

package/lib/communitycontent/api.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 } from '../http.js';
+import {
+  CommunityContentSortMode,
+  ForumTopicsCategoryFiltersEnum,
+  PostSearchResponse,
+} from '../forum/interfaces.js';
+import { ServerResponse } from '../common.js';
+export interface GetCommunityContentParams {
+  /** The type of media to get */
+  mediaFilter: ForumTopicsCategoryFiltersEnum;
+  /** Zero based page */
+  page: number;
+  /** The sort mode. */
+  sort: CommunityContentSortMode;
+}
+/** Returns community content. */
+export declare function getCommunityContent(
+  http: HttpClient,
+  params: GetCommunityContentParams
+): Promise<ServerResponse<PostSearchResponse>>;

package/lib/communitycontent/api.js

@@ -0,0 +1,7 @@
+import { get } from '../http.js';
+export function getCommunityContent(http, params) {
+  return get(
+    http,
+    `https://www.bungie.net/Platform/CommunityContent/Get/${params.sort}/${params.mediaFilter}/${params.page}/`
+  );
+}

package/lib/communitycontent/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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';

package/lib/communitycontent/index.js

@@ -0,0 +1,4 @@
+export * from '../common.js';
+export * from '../platform.js';
+export * from './api.js';
+export {};

package/lib/content/api.d.ts

@@ -0,0 +1,111 @@
+/**
+ * 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 } from '../http.js';
+import {
+  ContentItemPublicContract,
+  ContentTypeDescription,
+  NewsArticleRssResponse,
+  SearchResultOfContentItemPublicContract,
+} from './interfaces.js';
+import { ServerResponse } from '../common.js';
+export interface GetContentTypeParams {
+  type: string;
+}
+/** Gets an object describing a particular variant of content. */
+export declare function getContentType(
+  http: HttpClient,
+  params: GetContentTypeParams
+): Promise<ServerResponse<ContentTypeDescription>>;
+export interface GetContentByIdParams {
+  /** false */
+  head?: boolean;
+  id: string;
+  locale: string;
+}
+/** Returns a content item referenced by id */
+export declare function getContentById(
+  http: HttpClient,
+  params: GetContentByIdParams
+): Promise<ServerResponse<ContentItemPublicContract>>;
+export interface GetContentByTagAndTypeParams {
+  /** Not used. */
+  head?: boolean;
+  locale: string;
+  tag: string;
+  type: string;
+}
+/** Returns the newest item that matches a given tag and Content Type. */
+export declare function getContentByTagAndType(
+  http: HttpClient,
+  params: GetContentByTagAndTypeParams
+): Promise<ServerResponse<ContentItemPublicContract>>;
+export interface SearchContentWithTextParams {
+  /** Content type tag: Help, News, etc. Supply multiple ctypes separated by space. */
+  ctype?: string;
+  /** Page number for the search results, starting with page 1. */
+  currentpage?: number;
+  /** Not used. */
+  head?: boolean;
+  locale: string;
+  /** Word or phrase for the search. */
+  searchtext?: string;
+  /** For analytics, hint at the part of the app that triggered the search. Optional. */
+  source?: string;
+  /** Tag used on the content to be searched. */
+  tag?: string;
+}
+/**
+ * Gets content based on querystring information passed in. Provides basic search
+ * and text search capabilities.
+ */
+export declare function searchContentWithText(
+  http: HttpClient,
+  params: SearchContentWithTextParams
+): Promise<ServerResponse<SearchResultOfContentItemPublicContract>>;
+export interface SearchContentByTagAndTypeParams {
+  /** Page number for the search results starting with page 1. */
+  currentpage?: number;
+  /** Not used. */
+  head?: boolean;
+  /** Not used. */
+  itemsperpage?: number;
+  locale: string;
+  tag: string;
+  type: string;
+}
+/** Searches for Content Items that match the given Tag and Content Type. */
+export declare function searchContentByTagAndType(
+  http: HttpClient,
+  params: SearchContentByTagAndTypeParams
+): Promise<ServerResponse<SearchResultOfContentItemPublicContract>>;
+export interface SearchHelpArticlesParams {
+  searchtext: string;
+  size: string;
+}
+/** Search for Help Articles. */
+export declare function searchHelpArticles(
+  http: HttpClient,
+  params: SearchHelpArticlesParams
+): Promise<ServerResponse<object>>;
+export interface RssNewsArticlesParams {
+  /** Optionally filter response to only include news items in a certain category. */
+  categoryfilter?: string;
+  /** Optionally include full content body for each news item. */
+  includebody?: boolean;
+  /** Zero-based pagination token for paging through result sets. */
+  pageToken: string;
+}
+/** Returns a JSON string response that is the RSS feed for news articles. */
+export declare function rssNewsArticles(
+  http: HttpClient,
+  params: RssNewsArticlesParams
+): Promise<ServerResponse<NewsArticleRssResponse>>;

package/lib/content/api.js

@@ -0,0 +1,75 @@
+import { get } from '../http.js';
+const API_BASE = 'https://www.bungie.net/Platform/Content/';
+export function getContentType(http, params) {
+  return get(http, `${API_BASE}GetContentType/${params.type}/`);
+}
+export function getContentById(http, params) {
+  const strParams = {};
+  if (params.head !== undefined) {
+    strParams.head = params.head.toString();
+  }
+  return get(http, `${API_BASE}GetContentById/${params.id}/${params.locale}/`, strParams);
+}
+export function getContentByTagAndType(http, params) {
+  const strParams = {};
+  if (params.head !== undefined) {
+    strParams.head = params.head.toString();
+  }
+  return get(
+    http,
+    `${API_BASE}GetContentByTagAndType/${params.tag}/${params.type}/${params.locale}/`,
+    strParams
+  );
+}
+export function searchContentWithText(http, params) {
+  const strParams = {};
+  if (params.ctype !== undefined) {
+    strParams.ctype = params.ctype;
+  }
+  if (params.currentpage !== undefined) {
+    strParams.currentpage = params.currentpage.toString();
+  }
+  if (params.head !== undefined) {
+    strParams.head = params.head.toString();
+  }
+  if (params.searchtext !== undefined) {
+    strParams.searchtext = params.searchtext;
+  }
+  if (params.source !== undefined) {
+    strParams.source = params.source;
+  }
+  if (params.tag !== undefined) {
+    strParams.tag = params.tag;
+  }
+  return get(http, `${API_BASE}Search/${params.locale}/`, strParams);
+}
+export function searchContentByTagAndType(http, params) {
+  const strParams = {};
+  if (params.currentpage !== undefined) {
+    strParams.currentpage = params.currentpage.toString();
+  }
+  if (params.head !== undefined) {
+    strParams.head = params.head.toString();
+  }
+  if (params.itemsperpage !== undefined) {
+    strParams.itemsperpage = params.itemsperpage.toString();
+  }
+  return get(
+    http,
+    `${API_BASE}SearchContentByTagAndType/${params.tag}/${params.type}/${params.locale}/`,
+    strParams
+  );
+}
+export function searchHelpArticles(http, params) {
+  return get(http, `${API_BASE}SearchHelpArticles/${params.searchtext}/${params.size}/`);
+}
+export function rssNewsArticles(http, params) {
+  const strParams = {};
+  if (params.categoryfilter !== undefined) {
+    strParams.categoryfilter = params.categoryfilter;
+  }
+  if (params.includebody !== undefined) {
+    strParams.includebody = params.includebody.toString();
+  }
+  return get(http, `${API_BASE}Rss/NewsArticles/${params.pageToken}/`, strParams);
+}

package/lib/content/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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/lib/content/index.js

@@ -0,0 +1,5 @@
+export * from '../common.js';
+export * from '../platform.js';
+export * from './api.js';
+export * from './interfaces.js';
+export {};

package/lib/content/interfaces.d.ts

@@ -0,0 +1,214 @@
+/**
+ * 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 { GeneralUser } from '../user/interfaces.js';
+import { PagedQuery } from '../common.js';
+export interface ContentTypeDescription {
+  readonly cType: string;
+  readonly name: string;
+  readonly contentDescription: string;
+  readonly previewImage: string;
+  readonly priority: number;
+  readonly reminder: string;
+  readonly properties: ContentTypeProperty[];
+  readonly tagMetadata: TagMetadataDefinition[];
+  readonly tagMetadataItems: {
+    [key: string]: TagMetadataItem;
+  };
+  readonly usageExamples: string[];
+  readonly showInContentEditor: boolean;
+  readonly typeOf: string;
+  readonly bindIdentifierToProperty: string;
+  readonly boundRegex: string;
+  readonly forceIdentifierBinding: boolean;
+  readonly allowComments: boolean;
+  readonly autoEnglishPropertyFallback: boolean;
+  readonly bulkUploadable: boolean;
+  readonly previews: ContentPreview[];
+  readonly suppressCmsPath: boolean;
+  readonly propertySections: ContentTypePropertySection[];
+}
+export interface ContentTypeProperty {
+  readonly name: string;
+  readonly rootPropertyName: string;
+  readonly readableName: string;
+  readonly value: string;
+  readonly propertyDescription: string;
+  readonly localizable: boolean;
+  readonly fallback: boolean;
+  readonly enabled: boolean;
+  readonly order: number;
+  readonly visible: boolean;
+  readonly isTitle: boolean;
+  readonly required: boolean;
+  readonly maxLength: number;
+  readonly maxByteLength: number;
+  readonly maxFileSize: number;
+  readonly regexp: string;
+  readonly validateAs: string;
+  readonly rssAttribute: string;
+  readonly visibleDependency: string;
+  readonly visibleOn: string;
+  readonly datatype: ContentPropertyDataTypeEnum;
+  readonly attributes: {
+    [key: string]: string;
+  };
+  readonly childProperties: ContentTypeProperty[];
+  readonly contentTypeAllowed: string;
+  readonly bindToProperty: string;
+  readonly boundRegex: string;
+  readonly representationSelection: {
+    [key: string]: string;
+  };
+  readonly defaultValues: ContentTypeDefaultValue[];
+  readonly isExternalAllowed: boolean;
+  readonly propertySection: string;
+  readonly weight: number;
+  readonly entitytype: string;
+  readonly isCombo: boolean;
+  readonly suppressProperty: boolean;
+  readonly legalContentTypes: string[];
+  readonly representationValidationString: string;
+  readonly minWidth: number;
+  readonly maxWidth: number;
+  readonly minHeight: number;
+  readonly maxHeight: number;
+  readonly isVideo: boolean;
+  readonly isImage: boolean;
+}
+export declare const enum ContentPropertyDataTypeEnum {
+  None = 0,
+  Plaintext = 1,
+  Html = 2,
+  Dropdown = 3,
+  List = 4,
+  Json = 5,
+  Content = 6,
+  Representation = 7,
+  Set = 8,
+  File = 9,
+  FolderSet = 10,
+  Date = 11,
+  MultilinePlaintext = 12,
+  DestinyContent = 13,
+  Color = 14,
+}
+export interface ContentTypeDefaultValue {
+  readonly whenClause: string;
+  readonly whenValue: string;
+  readonly defaultValue: string;
+}
+export interface TagMetadataDefinition {
+  readonly description: string;
+  readonly order: number;
+  readonly items: TagMetadataItem[];
+  readonly datatype: string;
+  readonly name: string;
+  readonly isRequired: boolean;
+}
+export interface TagMetadataItem {
+  readonly description: string;
+  readonly tagText: string;
+  readonly groups: string[];
+  readonly isDefault: boolean;
+  readonly name: string;
+}
+export interface ContentPreview {
+  readonly name: string;
+  readonly path: string;
+  readonly itemInSet: boolean;
+  readonly setTag: string;
+  readonly setNesting: number;
+  readonly useSetId: number;
+}
+export interface ContentTypePropertySection {
+  readonly name: string;
+  readonly readableName: string;
+  readonly collapsed: boolean;
+}
+export interface ContentItemPublicContract {
+  readonly contentId: string;
+  readonly cType: string;
+  readonly cmsPath: string;
+  readonly creationDate: string;
+  readonly modifyDate: string;
+  readonly allowComments: boolean;
+  readonly hasAgeGate: boolean;
+  readonly minimumAge: number;
+  readonly ratingImagePath: string;
+  readonly author: GeneralUser;
+  readonly autoEnglishPropertyFallback: boolean;
+  /**
+   * Firehose content is really a collection of metadata and "properties", which are
+   * the potentially-but-not-strictly localizable data that comprises the meat of
+   * whatever content is being shown.
+   *
+   * As Cole Porter would have crooned, "Anything Goes" with Firehose properties.
+   * They are most often strings, but they can theoretically be anything. They are
+   * JSON encoded, and could be JSON structures, simple strings, numbers etc... The
+   * Content Type of the item (cType) will describe the properties, and thus how they
+   * ought to be deserialized.
+   */
+  readonly properties: {
+    [key: string]: object;
+  };
+  readonly representations: ContentRepresentation[];
+  /** NOTE: Tags will always be lower case. */
+  readonly tags: string[];
+  readonly commentSummary: CommentSummary;
+}
+export interface ContentRepresentation {
+  readonly name: string;
+  readonly path: string;
+  readonly validationString: string;
+}
+export interface CommentSummary {
+  readonly topicId: string;
+  readonly commentCount: number;
+}
+export interface SearchResultOfContentItemPublicContract {
+  readonly results: ContentItemPublicContract[];
+  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 NewsArticleRssResponse {
+  readonly CurrentPaginationToken: number;
+  readonly NextPaginationToken?: number;
+  readonly ResultCountThisPage: number;
+  readonly NewsArticles: NewsArticleRssItem[];
+  readonly CategoryFilter: string;
+  readonly PagerAction: string;
+}
+export interface NewsArticleRssItem {
+  readonly Title: string;
+  readonly Link: string;
+  readonly PubDate: string;
+  readonly UniqueIdentifier: string;
+  readonly Description: string;
+  readonly HtmlContent: string;
+  readonly ImagePath: string;
+  readonly OptionalMobileImagePath: string;
+}

package/lib/content/interfaces.js

@@ -0,0 +1,17 @@
+export var ContentPropertyDataTypeEnum = {
+  None: 0,
+  Plaintext: 1,
+  Html: 2,
+  Dropdown: 3,
+  List: 4,
+  Json: 5,
+  Content: 6,
+  Representation: 7,
+  Set: 8,
+  File: 9,
+  FolderSet: 10,
+  Date: 11,
+  MultilinePlaintext: 12,
+  DestinyContent: 13,
+  Color: 14,
+};

package/lib/core/api.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 } from '../http.js';
+import { CoreSettingsConfiguration, CoreSystem, GlobalAlert } from './interfaces.js';
+import { ServerResponse } from '../common.js';
+/** List of available localization cultures */
+export declare function getAvailableLocales(http: HttpClient): Promise<
+  ServerResponse<{
+    [key: string]: string;
+  }>
+>;
+/** Get the common settings used by the Bungie.Net environment. */
+export declare function getCommonSettings(
+  http: HttpClient
+): Promise<ServerResponse<CoreSettingsConfiguration>>;
+/**
+ * Get the user-specific system overrides that should be respected alongside common
+ * systems.
+ */
+export declare function getUserSystemOverrides(http: HttpClient): Promise<
+  ServerResponse<{
+    [key: string]: CoreSystem;
+  }>
+>;
+export interface GetGlobalAlertsParams {
+  /** Determines whether Streaming Alerts are included in results */
+  includestreaming?: boolean;
+}
+/**
+ * Gets any active global alert for display in the forum banners, help pages, etc.
+ * Usually used for DOC alerts.
+ */
+export declare function getGlobalAlerts(
+  http: HttpClient,
+  params: GetGlobalAlertsParams
+): Promise<ServerResponse<GlobalAlert[]>>;

package/lib/core/api.js

@@ -0,0 +1,18 @@
+import { get } from '../http.js';
+const API_BASE = 'https://www.bungie.net/Platform/';
+export function getAvailableLocales(http) {
+  return get(http, `${API_BASE}GetAvailableLocales/`);
+}
+export function getCommonSettings(http) {
+  return get(http, `${API_BASE}Settings/`);
+}
+export function getUserSystemOverrides(http) {
+  return get(http, `${API_BASE}UserSystemOverrides/`);
+}
+export function getGlobalAlerts(http, params) {
+  const strParams = {};
+  if (params.includestreaming !== undefined) {
+    strParams.includestreaming = params.includestreaming.toString();
+  }
+  return get(http, `${API_BASE}GlobalAlerts/`, strParams);
+}

package/lib/core/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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/lib/core/index.js

@@ -0,0 +1,5 @@
+export * from '../common.js';
+export * from '../platform.js';
+export * from './api.js';
+export * from './interfaces.js';
+export {};