cloudflare/src/resources/magic-transit/pcaps/download.ts

The official TypeScript library for the Cloudflare API

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

import { APIResource } from '../../../core/resource';
import { APIPromise } from '../../../core/api-promise';
import { buildHeaders } from '../../../internal/headers';
import { RequestOptions } from '../../../internal/request-options';
import { path } from '../../../internal/utils/path';

export class BaseDownload extends APIResource {
  static override readonly _key: readonly ['magicTransit', 'pcaps', 'download'] = Object.freeze([
    'magicTransit',
    'pcaps',
    'download',
  ] as const);

  /**
   * Download PCAP information into a file. Response is a binary PCAP file.
   *
   * @example
   * ```ts
   * const download =
   *   await client.magicTransit.pcaps.download.get(
   *     '023e105f4ecef8ad9ca31a8372d0c353',
   *     { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
   *   );
   *
   * const content = await download.blob();
   * console.log(content);
   * ```
   */
  get(pcapID: string, params: DownloadGetParams, options?: RequestOptions): APIPromise<Response> {
    const { account_id } = params;
    return this._client.get(path`/accounts/${account_id}/pcaps/${pcapID}/download`, {
      ...options,
      headers: buildHeaders([{ Accept: 'application/vnd.tcpdump.pcap' }, options?.headers]),
      __binaryResponse: true,
    });
  }
}
export class Download extends BaseDownload {}

export interface DownloadGetParams {
  /**
   * Identifier.
   */
  account_id: string;
}

export declare namespace Download {
  export { type DownloadGetParams as DownloadGetParams };
}