@taskeren/bungie-api-ts 5.10.0 → 5.10.2

package/generated-src/forum/api.ts

@@ -1,197 +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 {
-  ForumPostSortEnum,
-  ForumRecruitmentDetail,
-  ForumTopicsCategoryFiltersEnum,
-  ForumTopicsQuickDateEnum,
-  ForumTopicsSortEnum,
-  PostSearchResponse
-} from './interfaces.js';
-import {
-  ServerResponse
-} from '../common.js';
-import {
-  TagResponse
-} from '../platform.js';
-
-const API_BASE = "https://www.bungie.net/Platform/Forum/";
-
-export interface GetTopicsPagedParams {
-  /** A category filter */
-  categoryFilter: ForumTopicsCategoryFiltersEnum;
-  /** The group, if any. */
-  group: string;
-  /**
-   * Comma seperated list of locales posts must match to return in the result list.
-   * Default 'en'
-   */
-  locales?: string;
-  /** Zero paged page number */
-  page: number;
-  /** Unused */
-  pageSize: number;
-  /** A date filter. */
-  quickDate: ForumTopicsQuickDateEnum;
-  /** The sort mode. */
-  sort: ForumTopicsSortEnum;
-  /** The tags to search, if any. */
-  tagstring?: string;
-}
-
-/** Get topics from any forum. */
-export function getTopicsPaged(http: HttpClient, params: GetTopicsPagedParams): Promise<ServerResponse<PostSearchResponse>> {
-  const strParams: Record<string, string> = {};
-  if (params.locales !== undefined) { strParams.locales = params.locales; }
-  if (params.tagstring !== undefined) { strParams.tagstring = params.tagstring; }
-  return get(http, `${API_BASE}GetTopicsPaged/${params.page}/${params.pageSize}/${params.group}/${params.sort}/${params.quickDate}/${params.categoryFilter}/`, strParams);
-}
-
-export interface GetCoreTopicsPagedParams {
-  /** The category filter. */
-  categoryFilter: ForumTopicsCategoryFiltersEnum;
-  /**
-   * Comma seperated list of locales posts must match to return in the result list.
-   * Default 'en'
-   */
-  locales?: string;
-  /** Zero base page */
-  page: number;
-  /** The date filter. */
-  quickDate: ForumTopicsQuickDateEnum;
-  /** The sort mode. */
-  sort: ForumTopicsSortEnum;
-}
-
-/** Gets a listing of all topics marked as part of the core group. */
-export function getCoreTopicsPaged(http: HttpClient, params: GetCoreTopicsPagedParams): Promise<ServerResponse<PostSearchResponse>> {
-  const strParams: Record<string, string> = {};
-  if (params.locales !== undefined) { strParams.locales = params.locales; }
-  return get(http, `${API_BASE}GetCoreTopicsPaged/${params.page}/${params.sort}/${params.quickDate}/${params.categoryFilter}/`, strParams);
-}
-
-export interface GetPostsThreadedPagedParams {
-  getParentPost: boolean;
-  page: number;
-  pageSize: number;
-  parentPostId: string;
-  replySize: number;
-  rootThreadMode: boolean;
-  /** If this value is not null or empty, banned posts are requested to be returned */
-  showbanned?: string;
-  sortMode: ForumPostSortEnum;
-}
-
-/**
- * Returns a thread of posts at the given parent, optionally returning replies to
- * those posts as well as the original parent.
- */
-export function getPostsThreadedPaged(http: HttpClient, params: GetPostsThreadedPagedParams): Promise<ServerResponse<PostSearchResponse>> {
-  const strParams: Record<string, string> = {};
-  if (params.showbanned !== undefined) { strParams.showbanned = params.showbanned; }
-  return get(http, `${API_BASE}GetPostsThreadedPaged/${params.parentPostId}/${params.page}/${params.pageSize}/${params.replySize}/${params.getParentPost}/${params.rootThreadMode}/${params.sortMode}/`, strParams);
-}
-
-export interface GetPostsThreadedPagedFromChildParams {
-  childPostId: string;
-  page: number;
-  pageSize: number;
-  replySize: number;
-  rootThreadMode: boolean;
-  /** If this value is not null or empty, banned posts are requested to be returned */
-  showbanned?: string;
-  sortMode: ForumPostSortEnum;
-}
-
-/**
- * Returns a thread of posts starting at the topicId of the input childPostId,
- * optionally returning replies to those posts as well as the original parent.
- */
-export function getPostsThreadedPagedFromChild(http: HttpClient, params: GetPostsThreadedPagedFromChildParams): Promise<ServerResponse<PostSearchResponse>> {
-  const strParams: Record<string, string> = {};
-  if (params.showbanned !== undefined) { strParams.showbanned = params.showbanned; }
-  return get(http, `${API_BASE}GetPostsThreadedPagedFromChild/${params.childPostId}/${params.page}/${params.pageSize}/${params.replySize}/${params.rootThreadMode}/${params.sortMode}/`, strParams);
-}
-
-export interface GetPostAndParentParams {
-  childPostId: string;
-  /** If this value is not null or empty, banned posts are requested to be returned */
-  showbanned?: string;
-}
-
-/** Returns the post specified and its immediate parent. */
-export function getPostAndParent(http: HttpClient, params: GetPostAndParentParams): Promise<ServerResponse<PostSearchResponse>> {
-  const strParams: Record<string, string> = {};
-  if (params.showbanned !== undefined) { strParams.showbanned = params.showbanned; }
-  return get(http, `${API_BASE}GetPostAndParent/${params.childPostId}/`, strParams);
-}
-
-export interface GetPostAndParentAwaitingApprovalParams {
-  childPostId: string;
-  /** If this value is not null or empty, banned posts are requested to be returned */
-  showbanned?: string;
-}
-
-/**
- * Returns the post specified and its immediate parent of posts that are awaiting
- * approval.
- */
-export function getPostAndParentAwaitingApproval(http: HttpClient, params: GetPostAndParentAwaitingApprovalParams): Promise<ServerResponse<PostSearchResponse>> {
-  const strParams: Record<string, string> = {};
-  if (params.showbanned !== undefined) { strParams.showbanned = params.showbanned; }
-  return get(http, `${API_BASE}GetPostAndParentAwaitingApproval/${params.childPostId}/`, strParams);
-}
-
-export interface GetTopicForContentParams {
-  contentId: string;
-}
-
-/** Gets the post Id for the given content item's comments, if it exists. */
-export function getTopicForContent(http: HttpClient, params: GetTopicForContentParams): Promise<ServerResponse<string>> {
-  return get(http, `${API_BASE}GetTopicForContent/${params.contentId}/`);
-}
-
-export interface GetForumTagSuggestionsParams {
-  /** The partial tag input to generate suggestions from. */
-  partialtag?: string;
-}
-
-/**
- * Gets tag suggestions based on partial text entry, matching them with other tags
- * previously used in the forums.
- */
-export function getForumTagSuggestions(http: HttpClient, params: GetForumTagSuggestionsParams): Promise<ServerResponse<TagResponse[]>> {
-  const strParams: Record<string, string> = {};
-  if (params.partialtag !== undefined) { strParams.partialtag = params.partialtag; }
-  return get(http, `${API_BASE}GetForumTagSuggestions/`, strParams);
-}
-
-export interface GetPollParams {
-  /** The post id of the topic that has the poll. */
-  topicId: string;
-}
-
-/** Gets the specified forum poll. */
-export function getPoll(http: HttpClient, params: GetPollParams): Promise<ServerResponse<PostSearchResponse>> {
-  return get(http, `${API_BASE}Poll/${params.topicId}/`);
-}
-
-/**
- * Allows the caller to get a list of to 25 recruitment thread summary information
- * objects.
- */
-export function getRecruitmentThreadSummaries(http: HttpClient, body: string[]): Promise<ServerResponse<ForumRecruitmentDetail[]>> {
-    return post(http, `${API_BASE}Recruit/Summaries/`, body);
-}

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

@@ -1,171 +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 {
-  GeneralUser
-} from '../user/interfaces.js';
-import {
-  GroupResponse
-} from '../groupv2/interfaces.js';
-import {
-  IgnoreResponse,
-  TagResponse
-} from '../platform.js';
-import {
-  PagedQuery
-} from '../common.js';
-
-/**
- * This enum represents a set of flags - use bitwise operators to check which of
- * these match your value.
- */
-export const enum ForumTopicsCategoryFiltersEnum {
-  None = 0,
-  Links = 1,
-  Questions = 2,
-  AnsweredQuestions = 4,
-  Media = 8,
-  TextOnly = 16,
-  Announcement = 32,
-  BungieOfficial = 64,
-  Polls = 128
-}
-
-export const enum ForumTopicsQuickDateEnum {
-  All = 0,
-  LastYear = 1,
-  LastMonth = 2,
-  LastWeek = 3,
-  LastDay = 4
-}
-
-export const enum ForumTopicsSortEnum {
-  Default = 0,
-  LastReplied = 1,
-  MostReplied = 2,
-  Popularity = 3,
-  Controversiality = 4,
-  Liked = 5,
-  HighestRated = 6,
-  MostUpvoted = 7
-}
-
-export const enum ForumPostSortEnum {
-  Default = 0,
-  OldestFirst = 1
-}
-
-export interface PostSearchResponse {
-  readonly relatedPosts: PostResponse[];
-  readonly authors: GeneralUser[];
-  readonly groups: GroupResponse[];
-  readonly searchedTags: TagResponse[];
-  readonly polls: PollResponse[];
-  readonly recruitmentDetails: ForumRecruitmentDetail[];
-  readonly availablePages?: number;
-  readonly results: PostResponse[];
-  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 PostResponse {
-  readonly lastReplyTimestamp: string;
-  readonly IsPinned: boolean;
-  readonly urlMediaType: ForumMediaType;
-  readonly thumbnail: string;
-  readonly popularity: ForumPostPopularity;
-  readonly isActive: boolean;
-  readonly isAnnouncement: boolean;
-  readonly userRating: number;
-  readonly userHasRated: boolean;
-  readonly userHasMutedPost: boolean;
-  readonly latestReplyPostId: string;
-  readonly latestReplyAuthorId: string;
-  readonly ignoreStatus: IgnoreResponse;
-  readonly locale: string;
-}
-
-export const enum ForumMediaType {
-  None = 0,
-  Image = 1,
-  Video = 2,
-  Youtube = 3
-}
-
-export const enum ForumPostPopularity {
-  Empty = 0,
-  Default = 1,
-  Discussed = 2,
-  CoolStory = 3,
-  HeatingUp = 4,
-  Hot = 5
-}
-
-export interface PollResponse {
-  readonly topicId: string;
-  readonly results: PollResult[];
-  readonly totalVotes: number;
-}
-
-export interface PollResult {
-  readonly answerText: string;
-  readonly answerSlot: number;
-  readonly lastVoteDate: string;
-  readonly votes: number;
-  readonly requestingUserVoted: boolean;
-}
-
-export interface ForumRecruitmentDetail {
-  readonly topicId: string;
-  readonly microphoneRequired: boolean;
-  readonly intensity: ForumRecruitmentIntensityLabel;
-  readonly tone: ForumRecruitmentToneLabel;
-  readonly approved: boolean;
-  readonly conversationId?: string;
-  readonly playerSlotsTotal: number;
-  readonly playerSlotsRemaining: number;
-  readonly Fireteam: GeneralUser[];
-  readonly kickedPlayerIds: string[];
-}
-
-export const enum ForumRecruitmentIntensityLabel {
-  None = 0,
-  Casual = 1,
-  Professional = 2
-}
-
-export const enum ForumRecruitmentToneLabel {
-  None = 0,
-  FamilyFriendly = 1,
-  Rowdy = 2
-}
-
-export const enum CommunityContentSortMode {
-  Trending = 0,
-  Latest = 1,
-  HighestRated = 2
-}