cloudflare/src/resources/logpush/datasets/jobs.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 * as JobsAPI from '../jobs';
import { LogpushJobsSinglePage } from '../jobs';
import { CloudflareError } from '../../../core/error';
import { PagePromise, SinglePage } from '../../../core/pagination';
import { RequestOptions } from '../../../internal/request-options';
import { path } from '../../../internal/utils/path';

export class BaseJobs extends APIResource {
  static override readonly _key: readonly ['logpush', 'datasets', 'jobs'] = Object.freeze([
    'logpush',
    'datasets',
    'jobs',
  ] as const);

  /**
   * Lists Logpush jobs for an account or zone for a dataset.
   *
   * @example
   * ```ts
   * // Automatically fetches more pages as needed.
   * for await (const logpushJob of client.logpush.datasets.jobs.get(
   *   'gateway_dns',
   *   { account_id: 'account_id' },
   * )) {
   *   // ...
   * }
   * ```
   */
  get(
    datasetID:
      | 'access_requests'
      | 'account_abuse_protection_events'
      | 'audit_logs'
      | 'audit_logs_v2'
      | 'biso_user_actions'
      | 'casb_findings'
      | 'device_posture_results'
      | 'dex_application_tests'
      | 'dex_device_state_events'
      | 'dlp_forensic_copies'
      | 'dns_firewall_logs'
      | 'dns_logs'
      | 'email_security_alerts'
      | 'email_security_post_delivery_events'
      | 'firewall_events'
      | 'gateway_dns'
      | 'gateway_http'
      | 'gateway_network'
      | 'http_requests'
      | 'ipsec_logs'
      | 'magic_bgp_logs'
      | 'magic_ids_detections'
      | 'mcp_portal_logs'
      | 'mnm_flow_logs'
      | 'nel_reports'
      | 'network_analytics_logs'
      | 'page_shield_events'
      | 'sinkhole_http_logs'
      | 'spectrum_events'
      | 'ssh_logs'
      | 'turnstile_events'
      | 'warp_config_changes'
      | 'warp_toggle_changes'
      | 'websocket_analytics'
      | 'workers_trace_events'
      | 'zaraz_events'
      | 'zero_trust_network_sessions',
    params: JobGetParams | null | undefined = {},
    options?: RequestOptions,
  ): PagePromise<LogpushJobsSinglePage, JobsAPI.LogpushJob | null> {
    const { account_id, zone_id } = params ?? {};
    if (!account_id && !zone_id) {
      throw new CloudflareError('You must provide either account_id or zone_id.');
    }
    if (account_id && zone_id) {
      throw new CloudflareError('You cannot provide both account_id and zone_id.');
    }
    const { accountOrZone, accountOrZoneId } =
      account_id ?
        {
          accountOrZone: 'accounts',
          accountOrZoneId: account_id,
        }
      : {
          accountOrZone: 'zones',
          accountOrZoneId: zone_id,
        };
    return this._client.getAPIList(
      path`/${accountOrZone}/${accountOrZoneId}/logpush/datasets/${datasetID}/jobs`,
      SinglePage<JobsAPI.LogpushJob | null>,
      options,
    );
  }
}
export class Jobs extends BaseJobs {}

export interface JobGetParams {
  /**
   * The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
   */
  account_id?: string;

  /**
   * The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
   */
  zone_id?: string;
}

export declare namespace Jobs {
  export { type JobGetParams as JobGetParams };
}

export { type LogpushJobsSinglePage };