cloudflare 6.4.0 → 6.5.0

package/src/resources/logs/log-explorer/datasets/available.ts

@@ -0,0 +1,138 @@
+// 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 Shared from '../../../shared';
+import { CloudflareError } from '../../../../error';
+import { SinglePage } from '../../../../pagination';
+
+export class Available extends APIResource {
+  /**
+   * Returns all dataset types that this account or zone can create. Each entry
+   * includes the dataset schema and timestamp field.
+   *
+   * The schema shows all possible fields for a dataset. However, not all fields may
+   * be available for your account or zone. When creating or updating a dataset, only
+   * fields available to your account or zone can be enabled. If you request a field
+   * that is not available, you will receive an error.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const availableDataset of client.logs.logExplorer.datasets.available.list(
+   *   { account_id: 'account_id' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params?: AvailableListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<AvailableDatasetsSinglePage, AvailableDataset>;
+  list(options?: Core.RequestOptions): Core.PagePromise<AvailableDatasetsSinglePage, AvailableDataset>;
+  list(
+    params: AvailableListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<AvailableDatasetsSinglePage, AvailableDataset> {
+    if (isRequestOptions(params)) {
+      return this.list({}, params);
+    }
+    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(
+      `/${accountOrZone}/${accountOrZoneId}/logs/explorer/datasets/available`,
+      AvailableDatasetsSinglePage,
+      options,
+    );
+  }
+}
+
+export class AvailableDatasetsSinglePage extends SinglePage<AvailableDataset> {}
+
+/**
+ * A dataset type that the account or zone can create.
+ */
+export interface AvailableDataset {
+  /**
+   * Dataset type name (e.g. `http_requests`).
+   */
+  dataset: string;
+
+  /**
+   * Whether this dataset type is account-scoped or zone-scoped.
+   */
+  object_type: 'account' | 'zone';
+
+  /**
+   * JSON Schema that describes the fields this dataset exposes.
+   */
+  schema: AvailableDataset.Schema;
+
+  /**
+   * The primary timestamp field name for this dataset.
+   */
+  timestamp_field: string;
+}
+
+export namespace AvailableDataset {
+  /**
+   * JSON Schema that describes the fields this dataset exposes.
+   */
+  export interface Schema {
+    properties?: { [key: string]: unknown };
+
+    required?: Array<string>;
+
+    type?: 'object';
+  }
+}
+
+export interface AvailableList {
+  errors: Array<Shared.ResponseInfo>;
+
+  messages: Array<string>;
+
+  success: boolean;
+
+  result?: Array<AvailableDataset> | null;
+}
+
+export interface AvailableListParams {
+  /**
+   * 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;
+}
+
+Available.AvailableDatasetsSinglePage = AvailableDatasetsSinglePage;
+
+export declare namespace Available {
+  export {
+    type AvailableDataset as AvailableDataset,
+    type AvailableList as AvailableList,
+    AvailableDatasetsSinglePage as AvailableDatasetsSinglePage,
+    type AvailableListParams as AvailableListParams,
+  };
+}

package/src/resources/logs/log-explorer/datasets/datasets.ts

@@ -0,0 +1,505 @@
+// 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 AvailableAPI from './available';
+import {
+  Available,
+  AvailableDataset,
+  AvailableDatasetsSinglePage,
+  AvailableList,
+  AvailableListParams,
+} from './available';
+import { CloudflareError } from '../../../../error';
+import { SinglePage } from '../../../../pagination';
+
+export class Datasets extends APIResource {
+  available: AvailableAPI.Available = new AvailableAPI.Available(this._client);
+
+  /**
+   * Create a new Log Explorer dataset for the account or zone.
+   *
+   * Use the
+   * `/account or zones/{account or zone_id}/logs/explorer/datasets/available`
+   * endpoint to list dataset types you can create along with their available fields.
+   *
+   * The `fields` property is optional. If not specified, all available fields will
+   * be enabled.
+   *
+   * For zone-level datasets use the zone-scoped endpoint: POST
+   * /zones/{zone_id}/logs/explorer/datasets
+   *
+   * For dataset field definitions, see:
+   * https://developers.cloudflare.com/logs/logpush/logpush-job/datasets/
+   *
+   * @example
+   * ```ts
+   * const dataset =
+   *   await client.logs.logExplorer.datasets.create({
+   *     dataset: 'dataset',
+   *     account_id: 'account_id',
+   *   });
+   * ```
+   */
+  create(params: DatasetCreateParams, options?: Core.RequestOptions): Core.APIPromise<Dataset> {
+    const { account_id, zone_id, ...body } = 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.post(`/${accountOrZone}/${accountOrZoneId}/logs/explorer/datasets`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: Dataset }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Updates the enabled state and/or field configuration of an account or zone
+   * dataset.
+   *
+   * @example
+   * ```ts
+   * const dataset =
+   *   await client.logs.logExplorer.datasets.update(
+   *     'dataset_id',
+   *     { enabled: true, account_id: 'account_id' },
+   *   );
+   * ```
+   */
+  update(
+    datasetId: string,
+    params: DatasetUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Dataset> {
+    const { account_id, zone_id, ...body } = 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.put(`/${accountOrZone}/${accountOrZoneId}/logs/explorer/datasets/${datasetId}`, {
+        body,
+        ...options,
+      }) as Core.APIPromise<{ result: Dataset }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+
+  /**
+   * Returns all Log Explorer datasets configured for the account or zone.
+   *
+   * Pass `include_zones=true` to also include zone-level datasets that belong to
+   * this account or zone. List responses omit the `fields` property; use the
+   * single-dataset endpoint to retrieve field configuration.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const datasetSummary of client.logs.logExplorer.datasets.list(
+   *   { account_id: 'account_id' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    params?: DatasetListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<DatasetSummariesSinglePage, DatasetSummary>;
+  list(options?: Core.RequestOptions): Core.PagePromise<DatasetSummariesSinglePage, DatasetSummary>;
+  list(
+    params: DatasetListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<DatasetSummariesSinglePage, DatasetSummary> {
+    if (isRequestOptions(params)) {
+      return this.list({}, params);
+    }
+    const { account_id, zone_id, ...query } = 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(
+      `/${accountOrZone}/${accountOrZoneId}/logs/explorer/datasets`,
+      DatasetSummariesSinglePage,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Retrieve a single Log Explorer dataset by ID for the account or zone.
+   *
+   * @example
+   * ```ts
+   * const dataset = await client.logs.logExplorer.datasets.get(
+   *   'dataset_id',
+   *   { account_id: 'account_id' },
+   * );
+   * ```
+   */
+  get(datasetId: string, params?: DatasetGetParams, options?: Core.RequestOptions): Core.APIPromise<Dataset>;
+  get(datasetId: string, options?: Core.RequestOptions): Core.APIPromise<Dataset>;
+  get(
+    datasetId: string,
+    params: DatasetGetParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Dataset> {
+    if (isRequestOptions(params)) {
+      return this.get(datasetId, {}, params);
+    }
+    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.get(
+        `/${accountOrZone}/${accountOrZoneId}/logs/explorer/datasets/${datasetId}`,
+        options,
+      ) as Core.APIPromise<{ result: Dataset }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export class DatasetSummariesSinglePage extends SinglePage<DatasetSummary> {}
+
+export interface CreateRequest {
+  /**
+   * Dataset type name to create (e.g. `http_requests`).
+   */
+  dataset: string;
+
+  /**
+   * Controls which fields the API ingests. Defaults to all available fields when
+   * absent.
+   */
+  fields?: Array<CreateRequest.Field>;
+}
+
+export namespace CreateRequest {
+  export interface Field {
+    /**
+     * Whether the API includes this field in log ingest.
+     */
+    enabled: boolean;
+
+    /**
+     * Field name in lowercase.
+     */
+    name: string;
+  }
+}
+
+/**
+ * A Log Explorer dataset summary. List endpoints return this type and omit field
+ * configuration; use the single-dataset endpoint to retrieve it.
+ */
+export interface Dataset {
+  /**
+   * RFC3339 timestamp recording when the API created this dataset.
+   */
+  created_at: string;
+
+  /**
+   * Dataset type name (e.g. `http_requests`).
+   */
+  dataset: string;
+
+  /**
+   * Unique dataset ID.
+   */
+  dataset_id: string;
+
+  /**
+   * Whether log ingest is currently active for this dataset.
+   */
+  enabled: boolean;
+
+  /**
+   * Public ID of the account or zone that owns this dataset.
+   */
+  object_id: string;
+
+  /**
+   * Whether this dataset belongs to an account or a zone.
+   */
+  object_type: 'account' | 'zone';
+
+  /**
+   * RFC3339 timestamp recording when the API last updated this dataset.
+   */
+  updated_at: string;
+
+  /**
+   * The field configuration for this dataset.
+   */
+  fields?: Array<Dataset.Field>;
+}
+
+export namespace Dataset {
+  export interface Field {
+    /**
+     * Whether the API includes this field in log ingest.
+     */
+    enabled: boolean;
+
+    /**
+     * Field name in lowercase.
+     */
+    name: string;
+  }
+}
+
+/**
+ * A Log Explorer dataset summary. List endpoints return this type and omit field
+ * configuration; use the single-dataset endpoint to retrieve it.
+ */
+export interface DatasetSummary {
+  /**
+   * RFC3339 timestamp recording when the API created this dataset.
+   */
+  created_at: string;
+
+  /**
+   * Dataset type name (e.g. `http_requests`).
+   */
+  dataset: string;
+
+  /**
+   * Unique dataset ID.
+   */
+  dataset_id: string;
+
+  /**
+   * Whether log ingest is currently active for this dataset.
+   */
+  enabled: boolean;
+
+  /**
+   * Public ID of the account or zone that owns this dataset.
+   */
+  object_id: string;
+
+  /**
+   * Whether this dataset belongs to an account or a zone.
+   */
+  object_type: 'account' | 'zone';
+
+  /**
+   * RFC3339 timestamp recording when the API last updated this dataset.
+   */
+  updated_at: string;
+}
+
+export interface UpdateRequest {
+  /**
+   * Whether to enable or disable log ingest for this dataset.
+   */
+  enabled: boolean;
+
+  /**
+   * Controls which fields the API ingests after the update. Defaults to all
+   * available fields when absent.
+   */
+  fields?: Array<UpdateRequest.Field>;
+}
+
+export namespace UpdateRequest {
+  export interface Field {
+    /**
+     * Whether the API includes this field in log ingest.
+     */
+    enabled: boolean;
+
+    /**
+     * Field name in lowercase.
+     */
+    name: string;
+  }
+}
+
+export interface DatasetCreateParams {
+  /**
+   * Body param: Dataset type name to create (e.g. `http_requests`).
+   */
+  dataset: string;
+
+  /**
+   * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
+   * Zone ID.
+   */
+  account_id?: string;
+
+  /**
+   * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
+   * Account ID.
+   */
+  zone_id?: string;
+
+  /**
+   * Body param: Controls which fields the API ingests. Defaults to all available
+   * fields when absent.
+   */
+  fields?: Array<DatasetCreateParams.Field>;
+}
+
+export namespace DatasetCreateParams {
+  export interface Field {
+    /**
+     * Whether the API includes this field in log ingest.
+     */
+    enabled: boolean;
+
+    /**
+     * Field name in lowercase.
+     */
+    name: string;
+  }
+}
+
+export interface DatasetUpdateParams {
+  /**
+   * Body param: Whether to enable or disable log ingest for this dataset.
+   */
+  enabled: boolean;
+
+  /**
+   * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
+   * Zone ID.
+   */
+  account_id?: string;
+
+  /**
+   * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
+   * Account ID.
+   */
+  zone_id?: string;
+
+  /**
+   * Body param: Controls which fields the API ingests after the update. Defaults to
+   * all available fields when absent.
+   */
+  fields?: Array<DatasetUpdateParams.Field>;
+}
+
+export namespace DatasetUpdateParams {
+  export interface Field {
+    /**
+     * Whether the API includes this field in log ingest.
+     */
+    enabled: boolean;
+
+    /**
+     * Field name in lowercase.
+     */
+    name: string;
+  }
+}
+
+export interface DatasetListParams {
+  /**
+   * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
+   * Zone ID.
+   */
+  account_id?: string;
+
+  /**
+   * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
+   * Account ID.
+   */
+  zone_id?: string;
+
+  /**
+   * Query param: Set to true to include zone-scoped datasets belonging to this
+   * account.
+   */
+  include_zones?: boolean;
+}
+
+export interface DatasetGetParams {
+  /**
+   * 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;
+}
+
+Datasets.DatasetSummariesSinglePage = DatasetSummariesSinglePage;
+Datasets.Available = Available;
+Datasets.AvailableDatasetsSinglePage = AvailableDatasetsSinglePage;
+
+export declare namespace Datasets {
+  export {
+    type CreateRequest as CreateRequest,
+    type Dataset as Dataset,
+    type DatasetSummary as DatasetSummary,
+    type UpdateRequest as UpdateRequest,
+    DatasetSummariesSinglePage as DatasetSummariesSinglePage,
+    type DatasetCreateParams as DatasetCreateParams,
+    type DatasetUpdateParams as DatasetUpdateParams,
+    type DatasetListParams as DatasetListParams,
+    type DatasetGetParams as DatasetGetParams,
+  };
+
+  export {
+    Available as Available,
+    type AvailableDataset as AvailableDataset,
+    type AvailableList as AvailableList,
+    AvailableDatasetsSinglePage as AvailableDatasetsSinglePage,
+    type AvailableListParams as AvailableListParams,
+  };
+}

package/src/resources/logs/log-explorer/datasets/index.ts

@@ -0,0 +1,21 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  AvailableDatasetsSinglePage,
+  Available,
+  type AvailableDataset,
+  type AvailableList,
+  type AvailableListParams,
+} from './available';
+export {
+  DatasetSummariesSinglePage,
+  Datasets,
+  type CreateRequest,
+  type Dataset,
+  type DatasetSummary,
+  type UpdateRequest,
+  type DatasetCreateParams,
+  type DatasetUpdateParams,
+  type DatasetListParams,
+  type DatasetGetParams,
+} from './datasets';

package/src/resources/logs/log-explorer/datasets.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './datasets/index';

package/src/resources/logs/log-explorer/index.ts

@@ -0,0 +1,16 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  DatasetSummariesSinglePage,
+  Datasets,
+  type CreateRequest,
+  type Dataset,
+  type DatasetSummary,
+  type UpdateRequest,
+  type DatasetCreateParams,
+  type DatasetUpdateParams,
+  type DatasetListParams,
+  type DatasetGetParams,
+} from './datasets/index';
+export { LogExplorer } from './log-explorer';
+export { QuerySqlResponsesSinglePage, Query, type QuerySqlResponse, type QuerySqlParams } from './query';