trending.ts

/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import { trendingByCountry } from "../funcs/trending-by-country.js";
import { trendingContents } from "../funcs/trending-contents.js";
import { trendingCountries } from "../funcs/trending-countries.js";
import { trendingTopics } from "../funcs/trending-topics.js";
import { trendingTweets } from "../funcs/trending-tweets.js";
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
import * as models from "../models/index.js";
import * as operations from "../models/operations/index.js";
import { unwrapAsync } from "../types/fp.js";

export class Trending extends ClientSDK {
  /**
   * List Global Trend Countries
   *
   * @remarks
   * Get the supported country and global options that can be used to filter trending tweets.
   */
  async countries(
    options?: RequestOptions,
  ): Promise<models.StandardResponse> {
    return unwrapAsync(trendingCountries(
      this,
      options,
    ));
  }

  /**
   * List Global Trend Topics
   *
   * @remarks
   * Get the topic categories available for filtering global trending tweets.
   */
  async topics(
    options?: RequestOptions,
  ): Promise<models.StandardResponse> {
    return unwrapAsync(trendingTopics(
      this,
      options,
    ));
  }

  /**
   * List Global Trend Content Tags
   *
   * @remarks
   * Get content tags for a selected country and topic so tweets can be filtered more precisely.
   */
  async contents(
    request: operations.TrendingContentsRequest,
    options?: RequestOptions,
  ): Promise<models.StandardResponse> {
    return unwrapAsync(trendingContents(
      this,
      request,
      options,
    ));
  }

  /**
   * Get Global Trending Tweets
   *
   * @remarks
   * Get trending tweets for a country, with optional topic and content tag filters.
   */
  async tweets(
    request: operations.TrendingTweetsRequest,
    options?: RequestOptions,
  ): Promise<models.SearchResponse> {
    return unwrapAsync(trendingTweets(
      this,
      request,
      options,
    ));
  }

  /**
   * Get Trending Topics
   *
   * @remarks
   * Get X Explore trending topics for a given country. Use 'worldwide' for account-default trends or a country slug such as 'united-states'.
   */
  async byCountry(
    request: operations.TrendingByCountryRequest,
    options?: RequestOptions,
  ): Promise<models.StandardResponse> {
    return unwrapAsync(trendingByCountry(
      this,
      request,
      options,
    ));
  }
}