// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../resource';
import { isRequestOptions } from '../../core';
import * as Core from '../../core';
import * as BlockDocumentsAPI from './block-documents';
import * as Shared from '../shared';

export class BlockDocuments extends APIResource {
  /**
   * Read Block Document By Name For Block Type
   */
  retrieve(
    slug: string,
    blockDocumentName: string,
    params?: BlockDocumentRetrieveParams,
    options?: Core.RequestOptions,
  ): Core.APIPromise<Shared.BlockDocument>;
  retrieve(
    slug: string,
    blockDocumentName: string,
    options?: Core.RequestOptions,
  ): Core.APIPromise<Shared.BlockDocument>;
  retrieve(
    slug: string,
    blockDocumentName: string,
    params: BlockDocumentRetrieveParams | Core.RequestOptions = {},
    options?: Core.RequestOptions,
  ): Core.APIPromise<Shared.BlockDocument> {
    if (isRequestOptions(params)) {
      return this.retrieve(slug, blockDocumentName, {}, params);
    }
    const { 'x-prefect-api-version': xPrefectAPIVersion, ...query } = params;
    return this._client.get(`/api/block_types/slug/${slug}/block_documents/name/${blockDocumentName}`, {
      query,
      ...options,
      headers: {
        ...(xPrefectAPIVersion != null ? { 'x-prefect-api-version': xPrefectAPIVersion } : undefined),
        ...options?.headers,
      },
    });
  }
}

export interface BlockDocumentRetrieveParams {
  /**
   * Query param: Whether to include sensitive values in the block document.
   */
  include_secrets?: boolean;

  /**
   * Header param:
   */
  'x-prefect-api-version'?: string;
}

export namespace BlockDocuments {
  export import BlockDocumentRetrieveParams = BlockDocumentsAPI.BlockDocumentRetrieveParams;
}