bungie-net-core/endpoints/Content.d.ts

An easy way to interact with the Bungie.net API

/**
 * 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.
 *
 * Contact: support@bungie.com
 *
 * NOTE: This class is auto generated by the bungie-net-core code generator program
 * Repository: {@link https://github.com/owens1127/bungie-net-core}
 * Do not edit these files manually.
 */
import { BungieHttpProtocol } from './..';
import { BungieNetResponse } from '../interfaces/BungieNetResponse';
import { ContentTypeDescription } from '../models/Content/Models/ContentTypeDescription';
import { ContentItemPublicContract } from '../models/Content/ContentItemPublicContract';
import { SearchResultOfContentItemPublicContract } from '../models/SearchResultOfContentItemPublicContract';
import { NewsArticleRssResponse } from '../models/Content/NewsArticleRssResponse';
/**
 * Gets an object describing a particular variant of content.
 * @see {@link https://bungie-net.github.io/#Content.GetContentType}
 */
export declare function getContentType(http: BungieHttpProtocol, params: {
    type: string;
}): Promise<BungieNetResponse<ContentTypeDescription>>;
/**
 * Returns a content item referenced by id
 * @see {@link https://bungie-net.github.io/#Content.GetContentById}
 */
export declare function getContentById(http: BungieHttpProtocol, params: {
    /** false */
    head?: boolean;
    id: string;
    locale: string;
}): Promise<BungieNetResponse<ContentItemPublicContract>>;
/**
 * Returns the newest item that matches a given tag and Content Type.
 * @see {@link https://bungie-net.github.io/#Content.GetContentByTagAndType}
 */
export declare function getContentByTagAndType(http: BungieHttpProtocol, params: {
    /** Not used. */
    head?: boolean;
    locale: string;
    tag: string;
    type: string;
}): Promise<BungieNetResponse<ContentItemPublicContract>>;
/**
 * Gets content based on querystring information passed in. Provides basic search
 * and text search capabilities.
 * @see {@link https://bungie-net.github.io/#Content.SearchContentWithText}
 */
export declare function searchContentWithText(http: BungieHttpProtocol, params: {
    /** 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;
}): Promise<BungieNetResponse<SearchResultOfContentItemPublicContract>>;
/**
 * Searches for Content Items that match the given Tag and Content Type.
 * @see {@link https://bungie-net.github.io/#Content.SearchContentByTagAndType}
 */
export declare function searchContentByTagAndType(http: BungieHttpProtocol, params: {
    /** 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;
}): Promise<BungieNetResponse<SearchResultOfContentItemPublicContract>>;
/**
 * Search for Help Articles.
 * @see {@link https://bungie-net.github.io/#Content.SearchHelpArticles}
 */
export declare function searchHelpArticles(http: BungieHttpProtocol, params: {
    searchtext: string;
    size: string;
}): Promise<BungieNetResponse<object>>;
/**
 * Returns a JSON string response that is the RSS feed for news articles.
 * @see {@link https://bungie-net.github.io/#Content.RssNewsArticles}
 */
export declare function rssNewsArticles(http: BungieHttpProtocol, params: {
    /** 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;
}): Promise<BungieNetResponse<NewsArticleRssResponse>>;