suggest.ts

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

import { suggestSuggest } from "../funcs/suggestSuggest.js";
import { suggestSuggestOpenAPI } from "../funcs/suggestSuggestOpenAPI.js";
import { suggestSuggestOpenAPIRegistry } from "../funcs/suggestSuggestOpenAPIRegistry.js";
import { ClientSDK, RequestOptions } from "../lib/sdks.js";
import * as operations from "./models/operations/index.js";
import { unwrapAsync } from "./types/fp.js";

export class Suggest extends ClientSDK {
  /**
   * Generate suggestions for improving an OpenAPI document.
   *
   * @remarks
   * Get suggestions from an LLM model for improving an OpenAPI document.
   */
  async suggest(
    request: operations.SuggestRequest,
    options?: RequestOptions,
  ): Promise<ReadableStream<Uint8Array>> {
    return unwrapAsync(suggestSuggest(
      this,
      request,
      options,
    ));
  }

  /**
   * (DEPRECATED) Generate suggestions for improving an OpenAPI document.
   *
   * @remarks
   * Get suggestions from an LLM model for improving an OpenAPI document.
   */
  async suggestOpenAPI(
    request: operations.SuggestOpenAPIRequest,
    options?: RequestOptions,
  ): Promise<ReadableStream<Uint8Array>> {
    return unwrapAsync(suggestSuggestOpenAPI(
      this,
      request,
      options,
    ));
  }

  /**
   * Generate suggestions for improving an OpenAPI document stored in the registry.
   *
   * @remarks
   * Get suggestions from an LLM model for improving an OpenAPI document stored in the registry.
   */
  async suggestOpenAPIRegistry(
    request: operations.SuggestOpenAPIRegistryRequest,
    options?: RequestOptions,
  ): Promise<ReadableStream<Uint8Array>> {
    return unwrapAsync(suggestSuggestOpenAPIRegistry(
      this,
      request,
      options,
    ));
  }
}