cloudflare 4.4.1 → 5.0.0

package/src/resources/load-balancers/monitors/monitors.ts

@@ -213,7 +213,7 @@ export interface Monitor {
    * a Host header by default. The User-Agent header cannot be overridden. This
    * parameter is only valid for HTTP and HTTPS monitors.
    */
-  header?: Record<string, Array<string>>;
+  header?: { [key: string]: Array<string> };
 
   /**
    * The interval between each health check. Shorter intervals may improve failover
@@ -272,7 +272,7 @@ export interface MonitorDeleteResponse {
 
 export interface MonitorCreateParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   account_id: string;
 
@@ -323,7 +323,7 @@ export interface MonitorCreateParams {
    * recommended you set a Host header by default. The User-Agent header cannot be
    * overridden. This parameter is only valid for HTTP and HTTPS monitors.
    */
-  header?: Record<string, Array<string>>;
+  header?: { [key: string]: Array<string> };
 
   /**
    * Body param: The interval between each health check. Shorter intervals may
@@ -378,7 +378,7 @@ export interface MonitorCreateParams {
 
 export interface MonitorUpdateParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   account_id: string;
 
@@ -429,7 +429,7 @@ export interface MonitorUpdateParams {
    * recommended you set a Host header by default. The User-Agent header cannot be
    * overridden. This parameter is only valid for HTTP and HTTPS monitors.
    */
-  header?: Record<string, Array<string>>;
+  header?: { [key: string]: Array<string> };
 
   /**
    * Body param: The interval between each health check. Shorter intervals may
@@ -484,21 +484,21 @@ export interface MonitorUpdateParams {
 
 export interface MonitorListParams {
   /**
-   * Identifier
+   * Identifier.
    */
   account_id: string;
 }
 
 export interface MonitorDeleteParams {
   /**
-   * Identifier
+   * Identifier.
    */
   account_id: string;
 }
 
 export interface MonitorEditParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   account_id: string;
 
@@ -549,7 +549,7 @@ export interface MonitorEditParams {
    * recommended you set a Host header by default. The User-Agent header cannot be
    * overridden. This parameter is only valid for HTTP and HTTPS monitors.
    */
-  header?: Record<string, Array<string>>;
+  header?: { [key: string]: Array<string> };
 
   /**
    * Body param: The interval between each health check. Shorter intervals may
@@ -604,7 +604,7 @@ export interface MonitorEditParams {
 
 export interface MonitorGetParams {
   /**
-   * Identifier
+   * Identifier.
    */
   account_id: string;
 }

package/src/resources/load-balancers/monitors/previews.ts

@@ -36,14 +36,14 @@ export interface PreviewCreateResponse {
   /**
    * Monitored pool IDs mapped to their respective names.
    */
-  pools?: Record<string, string>;
+  pools?: { [key: string]: string };
 
   preview_id?: string;
 }
 
 export interface PreviewCreateParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   account_id: string;
 
@@ -94,7 +94,7 @@ export interface PreviewCreateParams {
    * recommended you set a Host header by default. The User-Agent header cannot be
    * overridden. This parameter is only valid for HTTP and HTTPS monitors.
    */
-  header?: Record<string, Array<string>>;
+  header?: { [key: string]: Array<string> };
 
   /**
    * Body param: The interval between each health check. Shorter intervals may

package/src/resources/load-balancers/monitors/references.ts

@@ -47,7 +47,7 @@ export interface ReferenceGetResponse {
 
 export interface ReferenceGetParams {
   /**
-   * Identifier
+   * Identifier.
    */
   account_id: string;
 }

package/src/resources/load-balancers/pools/health.ts

@@ -61,7 +61,7 @@ export interface HealthCreateResponse {
   /**
    * Monitored pool IDs mapped to their respective names.
    */
-  pools?: Record<string, string>;
+  pools?: { [key: string]: string };
 
   preview_id?: string;
 }
@@ -72,7 +72,7 @@ export interface HealthCreateResponse {
  */
 export interface HealthGetResponse {
   /**
-   * Pool ID
+   * Pool ID.
    */
   pool_id?: string;
 
@@ -128,7 +128,7 @@ export namespace HealthGetResponse {
 
 export interface HealthCreateParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   account_id: string;
 
@@ -179,7 +179,7 @@ export interface HealthCreateParams {
    * recommended you set a Host header by default. The User-Agent header cannot be
    * overridden. This parameter is only valid for HTTP and HTTPS monitors.
    */
-  header?: Record<string, Array<string>>;
+  header?: { [key: string]: Array<string> };
 
   /**
    * Body param: The interval between each health check. Shorter intervals may
@@ -234,7 +234,7 @@ export interface HealthCreateParams {
 
 export interface HealthGetParams {
   /**
-   * Identifier
+   * Identifier.
    */
   account_id: string;
 }

package/src/resources/load-balancers/pools/pools.ts

@@ -295,7 +295,7 @@ export interface PoolDeleteResponse {
 
 export interface PoolCreateParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   account_id: string;
 
@@ -378,7 +378,7 @@ export interface PoolCreateParams {
 
 export interface PoolUpdateParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   account_id: string;
 
@@ -467,7 +467,7 @@ export interface PoolUpdateParams {
 
 export interface PoolListParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   account_id: string;
 
@@ -480,14 +480,14 @@ export interface PoolListParams {
 
 export interface PoolDeleteParams {
   /**
-   * Identifier
+   * Identifier.
    */
   account_id: string;
 }
 
 export interface PoolBulkEditParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   account_id: string;
 
@@ -501,7 +501,7 @@ export interface PoolBulkEditParams {
 
 export interface PoolEditParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   account_id: string;
 
@@ -590,7 +590,7 @@ export interface PoolEditParams {
 
 export interface PoolGetParams {
   /**
-   * Identifier
+   * Identifier.
    */
   account_id: string;
 }

package/src/resources/load-balancers/pools/references.ts

@@ -47,7 +47,7 @@ export interface ReferenceGetResponse {
 
 export interface ReferenceGetParams {
   /**
-   * Identifier
+   * Identifier.
    */
   account_id: string;
 }

package/src/resources/load-balancers/previews.ts

@@ -33,18 +33,18 @@ export class Previews extends APIResource {
 /**
  * Resulting health data from a preview operation.
  */
-export type PreviewGetResponse = Record<string, PreviewGetResponse.item>;
+export type PreviewGetResponse = { [key: string]: PreviewGetResponse.item };
 
 export namespace PreviewGetResponse {
   export interface item {
     healthy?: boolean;
 
-    origins?: Array<Record<string, item.load_balancing_origin_health_data>>;
+    origins?: Array<{ [key: string]: item.load_balancing_origin_health_data }>;
   }
 
   export namespace item {
     /**
-     * The origin ipv4/ipv6 address or domain name mapped to it's health data.
+     * The origin ipv4/ipv6 address or domain name mapped to its health data.
      */
     export interface load_balancing_origin_health_data {
       failure_reason?: string;
@@ -60,7 +60,7 @@ export namespace PreviewGetResponse {
 
 export interface PreviewGetParams {
   /**
-   * Identifier
+   * Identifier.
    */
   account_id: string;
 }

package/src/resources/load-balancers/regions.ts

@@ -72,7 +72,7 @@ export type RegionGetResponse = unknown | string | null;
 
 export interface RegionListParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   account_id: string;
 
@@ -94,7 +94,7 @@ export interface RegionListParams {
 
 export interface RegionGetParams {
   /**
-   * Identifier
+   * Identifier.
    */
   account_id: string;
 }

package/src/resources/load-balancers/searches.ts

@@ -71,7 +71,7 @@ export namespace SearchListResponse {
 
 export interface SearchListParams extends V4PagePaginationParams {
   /**
-   * Path param: Identifier
+   * Path param: Identifier.
    */
   account_id: string;
 

package/src/resources/logpush/datasets/fields.ts

@@ -7,7 +7,7 @@ import { CloudflareError } from '../../../error';
 
 export class Fields extends APIResource {
   /**
-   * Lists all fields available for a dataset. The response result is an object with
+   * Lists all fields available for a dataset. The response result is. an object with
    * key-value pairs, where keys are field names, and values are descriptions.
    *
    * @example
@@ -22,6 +22,7 @@ export class Fields extends APIResource {
     datasetId:
       | 'access_requests'
       | 'audit_logs'
+      | 'audit_logs_v2'
       | 'biso_user_actions'
       | 'casb_findings'
       | 'device_posture_results'
@@ -52,6 +53,7 @@ export class Fields extends APIResource {
     datasetId:
       | 'access_requests'
       | 'audit_logs'
+      | 'audit_logs_v2'
       | 'biso_user_actions'
       | 'casb_findings'
       | 'device_posture_results'
@@ -81,6 +83,7 @@ export class Fields extends APIResource {
     datasetId:
       | 'access_requests'
       | 'audit_logs'
+      | 'audit_logs_v2'
       | 'biso_user_actions'
       | 'casb_findings'
       | 'device_posture_results'

package/src/resources/logpush/datasets/jobs.ts

@@ -26,6 +26,7 @@ export class Jobs extends APIResource {
     datasetId:
       | 'access_requests'
       | 'audit_logs'
+      | 'audit_logs_v2'
       | 'biso_user_actions'
       | 'casb_findings'
       | 'device_posture_results'
@@ -56,6 +57,7 @@ export class Jobs extends APIResource {
     datasetId:
       | 'access_requests'
       | 'audit_logs'
+      | 'audit_logs_v2'
       | 'biso_user_actions'
       | 'casb_findings'
       | 'device_posture_results'
@@ -85,6 +87,7 @@ export class Jobs extends APIResource {
     datasetId:
       | 'access_requests'
       | 'audit_logs'
+      | 'audit_logs_v2'
       | 'biso_user_actions'
       | 'casb_findings'
       | 'device_posture_results'

package/src/resources/logpush/edge.ts

@@ -18,7 +18,7 @@ export class Edge extends APIResource {
   create(params: EdgeCreateParams, options?: Core.RequestOptions): Core.APIPromise<InstantLogpushJob | null> {
     const { zone_id, ...body } = params;
     return (
-      this._client.post(`/zones/${zone_id}/logpush/edge`, { body, ...options }) as Core.APIPromise<{
+      this._client.post(`/zones/${zone_id}/logpush/edge/jobs`, { body, ...options }) as Core.APIPromise<{
         result: InstantLogpushJob | null;
       }>
     )._thenUnwrap((obj) => obj.result);
@@ -42,7 +42,11 @@ export class Edge extends APIResource {
     options?: Core.RequestOptions,
   ): Core.PagePromise<InstantLogpushJobsSinglePage, InstantLogpushJob | null> {
     const { zone_id } = params;
-    return this._client.getAPIList(`/zones/${zone_id}/logpush/edge`, InstantLogpushJobsSinglePage, options);
+    return this._client.getAPIList(
+      `/zones/${zone_id}/logpush/edge/jobs`,
+      InstantLogpushJobsSinglePage,
+      options,
+    );
   }
 }
 

package/src/resources/logpush/jobs.ts

@@ -15,6 +15,27 @@ export class Jobs extends APIResource {
    * const logpushJob = await client.logpush.jobs.create({
    *   destination_conf: 's3://mybucket/logs?region=us-west-2',
    *   account_id: 'account_id',
+   *   dataset: 'gateway_dns',
+   *   filter:
+   *     '{"where":{"and":[{"key":"ClientRequestPath","operator":"contains","value":"/static"},{"key":"ClientRequestHost","operator":"eq","value":"example.com"}]}}',
+   *   max_upload_bytes: 5000000,
+   *   max_upload_interval_seconds: 30,
+   *   max_upload_records: 1000,
+   *   name: 'example.com',
+   *   output_options: {
+   *     'CVE-2021-44228': false,
+   *     batch_prefix: '',
+   *     batch_suffix: '',
+   *     field_delimiter: ',',
+   *     field_names: ['Datetime', 'DstIP', 'SrcIP'],
+   *     output_type: 'ndjson',
+   *     record_delimiter: '',
+   *     record_prefix: '{',
+   *     record_suffix: '}\n',
+   *     sample_rate: 1,
+   *     timestamp_format: 'unixnano',
+   *   },
+   *   ownership_challenge: '00000000000000000000',
    * });
    * ```
    */
@@ -51,6 +72,26 @@ export class Jobs extends APIResource {
    * ```ts
    * const logpushJob = await client.logpush.jobs.update(1, {
    *   account_id: 'account_id',
+   *   destination_conf: 's3://mybucket/logs?region=us-west-2',
+   *   filter:
+   *     '{"where":{"and":[{"key":"ClientRequestPath","operator":"contains","value":"/static"},{"key":"ClientRequestHost","operator":"eq","value":"example.com"}]}}',
+   *   max_upload_bytes: 5000000,
+   *   max_upload_interval_seconds: 30,
+   *   max_upload_records: 1000,
+   *   output_options: {
+   *     'CVE-2021-44228': false,
+   *     batch_prefix: '',
+   *     batch_suffix: '',
+   *     field_delimiter: ',',
+   *     field_names: ['Datetime', 'DstIP', 'SrcIP'],
+   *     output_type: 'ndjson',
+   *     record_delimiter: '',
+   *     record_prefix: '{',
+   *     record_suffix: '}\n',
+   *     sample_rate: 1,
+   *     timestamp_format: 'unixnano',
+   *   },
+   *   ownership_challenge: '00000000000000000000',
    * });
    * ```
    */
@@ -247,6 +288,7 @@ export interface LogpushJob {
   dataset?:
     | 'access_requests'
     | 'audit_logs'
+    | 'audit_logs_v2'
     | 'biso_user_actions'
     | 'casb_findings'
     | 'device_posture_results'
@@ -272,8 +314,8 @@ export interface LogpushJob {
     | null;
 
   /**
-   * Uniquely identifies a resource (such as an s3 bucket) where data will be pushed.
-   * Additional configuration parameters supported by the destination may be
+   * Uniquely identifies a resource (such as an s3 bucket) where data. will be
+   * pushed. Additional configuration parameters supported by the destination may be
    * included.
    */
   destination_conf?: string;
@@ -284,7 +326,7 @@ export interface LogpushJob {
   enabled?: boolean;
 
   /**
-   * If not null, the job is currently failing. Failures are usually repetitive
+   * If not null, the job is currently failing. Failures are usually. repetitive
    * (example: no permissions to write to destination bucket). Only the last failure
    * is recorded. On successful execution of a job the error_message and last_error
    * are set to null.
@@ -293,7 +335,7 @@ export interface LogpushJob {
 
   /**
    * @deprecated This field is deprecated. Please use `max_upload_*` parameters
-   * instead. The frequency at which Cloudflare sends batches of logs to your
+   * instead. . The frequency at which Cloudflare sends batches of logs to your
    * destination. Setting frequency to high sends your logs in larger quantities of
    * smaller files. Setting frequency to low sends logs in smaller quantities of
    * larger files.
@@ -302,10 +344,9 @@ export interface LogpushJob {
 
   /**
    * The kind parameter (optional) is used to differentiate between Logpush and Edge
-   * Log Delivery jobs. Currently, Edge Log Delivery is only supported for the
-   * `http_requests` dataset.
+   * Log Delivery jobs (when supported by the dataset).
    */
-  kind?: 'edge';
+  kind?: '' | 'edge';
 
   /**
    * Records the last time for which logs have been successfully pushed. If the last
@@ -316,9 +357,9 @@ export interface LogpushJob {
   last_complete?: string | null;
 
   /**
-   * Records the last time the job failed. If not null, the job is currently failing.
-   * If null, the job has either never failed or has run successfully at least once
-   * since last failure. See also the error_message field.
+   * Records the last time the job failed. If not null, the job is currently.
+   * failing. If null, the job has either never failed or has run successfully at
+   * least once since last failure. See also the error_message field.
    */
   last_error?: string | null;
 
@@ -335,30 +376,28 @@ export interface LogpushJob {
    * The maximum uncompressed file size of a batch of logs. This setting value must
    * be between `5 MB` and `1 GB`, or `0` to disable it. Note that you cannot set a
    * minimum file size; this means that log files may be much smaller than this batch
-   * size. This parameter is not available for jobs with `edge` as its kind.
+   * size.
    */
-  max_upload_bytes?: number | null;
+  max_upload_bytes?: 0 | number | null;
 
   /**
    * The maximum interval in seconds for log batches. This setting must be between 30
    * and 300 seconds (5 minutes), or `0` to disable it. Note that you cannot specify
    * a minimum interval for log batches; this means that log files may be sent in
-   * shorter intervals than this. This parameter is only used for jobs with `edge` as
-   * its kind.
+   * shorter intervals than this.
    */
-  max_upload_interval_seconds?: number | null;
+  max_upload_interval_seconds?: 0 | number | null;
 
   /**
    * The maximum number of log lines per batch. This setting must be between 1000 and
    * 1,000,000 lines, or `0` to disable it. Note that you cannot specify a minimum
    * number of log lines per batch; this means that log files may contain many fewer
-   * lines than this. This parameter is not available for jobs with `edge` as its
-   * kind.
+   * lines than this.
    */
-  max_upload_records?: number | null;
+  max_upload_records?: 0 | number | null;
 
   /**
-   * Optional human readable job name. Not unique. Cloudflare suggests that you set
+   * Optional human readable job name. Not unique. Cloudflare suggests. that you set
    * this to a meaningful string, like the domain name, to make it easier to identify
    * your job.
    */
@@ -532,7 +571,7 @@ export interface JobDeleteResponse {
 
 export interface JobCreateParams {
   /**
-   * Body param: Uniquely identifies a resource (such as an s3 bucket) where data
+   * Body param: Uniquely identifies a resource (such as an s3 bucket) where data.
    * will be pushed. Additional configuration parameters supported by the destination
    * may be included.
    */
@@ -558,6 +597,7 @@ export interface JobCreateParams {
   dataset?:
     | 'access_requests'
     | 'audit_logs'
+    | 'audit_logs_v2'
     | 'biso_user_actions'
     | 'casb_findings'
     | 'device_posture_results'
@@ -596,7 +636,7 @@ export interface JobCreateParams {
 
   /**
    * @deprecated Body param: This field is deprecated. Please use `max_upload_*`
-   * parameters instead. The frequency at which Cloudflare sends batches of logs to
+   * parameters instead. . The frequency at which Cloudflare sends batches of logs to
    * your destination. Setting frequency to high sends your logs in larger quantities
    * of smaller files. Setting frequency to low sends logs in smaller quantities of
    * larger files.
@@ -605,10 +645,9 @@ export interface JobCreateParams {
 
   /**
    * Body param: The kind parameter (optional) is used to differentiate between
-   * Logpush and Edge Log Delivery jobs. Currently, Edge Log Delivery is only
-   * supported for the `http_requests` dataset.
+   * Logpush and Edge Log Delivery jobs (when supported by the dataset).
    */
-  kind?: 'edge';
+  kind?: '' | 'edge';
 
   /**
    * @deprecated Body param: This field is deprecated. Use `output_options` instead.
@@ -623,31 +662,28 @@ export interface JobCreateParams {
    * Body param: The maximum uncompressed file size of a batch of logs. This setting
    * value must be between `5 MB` and `1 GB`, or `0` to disable it. Note that you
    * cannot set a minimum file size; this means that log files may be much smaller
-   * than this batch size. This parameter is not available for jobs with `edge` as
-   * its kind.
+   * than this batch size.
    */
-  max_upload_bytes?: number | null;
+  max_upload_bytes?: 0 | number | null;
 
   /**
    * Body param: The maximum interval in seconds for log batches. This setting must
    * be between 30 and 300 seconds (5 minutes), or `0` to disable it. Note that you
    * cannot specify a minimum interval for log batches; this means that log files may
-   * be sent in shorter intervals than this. This parameter is only used for jobs
-   * with `edge` as its kind.
+   * be sent in shorter intervals than this.
    */
-  max_upload_interval_seconds?: number | null;
+  max_upload_interval_seconds?: 0 | number | null;
 
   /**
    * Body param: The maximum number of log lines per batch. This setting must be
    * between 1000 and 1,000,000 lines, or `0` to disable it. Note that you cannot
    * specify a minimum number of log lines per batch; this means that log files may
-   * contain many fewer lines than this. This parameter is not available for jobs
-   * with `edge` as its kind.
+   * contain many fewer lines than this.
    */
-  max_upload_records?: number | null;
+  max_upload_records?: 0 | number | null;
 
   /**
-   * Body param: Optional human readable job name. Not unique. Cloudflare suggests
+   * Body param: Optional human readable job name. Not unique. Cloudflare suggests.
    * that you set this to a meaningful string, like the domain name, to make it
    * easier to identify your job.
    */
@@ -679,7 +715,7 @@ export interface JobUpdateParams {
   zone_id?: string;
 
   /**
-   * Body param: Uniquely identifies a resource (such as an s3 bucket) where data
+   * Body param: Uniquely identifies a resource (such as an s3 bucket) where data.
    * will be pushed. Additional configuration parameters supported by the destination
    * may be included.
    */
@@ -699,7 +735,7 @@ export interface JobUpdateParams {
 
   /**
    * @deprecated Body param: This field is deprecated. Please use `max_upload_*`
-   * parameters instead. The frequency at which Cloudflare sends batches of logs to
+   * parameters instead. . The frequency at which Cloudflare sends batches of logs to
    * your destination. Setting frequency to high sends your logs in larger quantities
    * of smaller files. Setting frequency to low sends logs in smaller quantities of
    * larger files.
@@ -708,10 +744,9 @@ export interface JobUpdateParams {
 
   /**
    * Body param: The kind parameter (optional) is used to differentiate between
-   * Logpush and Edge Log Delivery jobs. Currently, Edge Log Delivery is only
-   * supported for the `http_requests` dataset.
+   * Logpush and Edge Log Delivery jobs (when supported by the dataset).
    */
-  kind?: 'edge';
+  kind?: '' | 'edge';
 
   /**
    * @deprecated Body param: This field is deprecated. Use `output_options` instead.
@@ -726,31 +761,28 @@ export interface JobUpdateParams {
    * Body param: The maximum uncompressed file size of a batch of logs. This setting
    * value must be between `5 MB` and `1 GB`, or `0` to disable it. Note that you
    * cannot set a minimum file size; this means that log files may be much smaller
-   * than this batch size. This parameter is not available for jobs with `edge` as
-   * its kind.
+   * than this batch size.
    */
-  max_upload_bytes?: number | null;
+  max_upload_bytes?: 0 | number | null;
 
   /**
    * Body param: The maximum interval in seconds for log batches. This setting must
    * be between 30 and 300 seconds (5 minutes), or `0` to disable it. Note that you
    * cannot specify a minimum interval for log batches; this means that log files may
-   * be sent in shorter intervals than this. This parameter is only used for jobs
-   * with `edge` as its kind.
+   * be sent in shorter intervals than this.
    */
-  max_upload_interval_seconds?: number | null;
+  max_upload_interval_seconds?: 0 | number | null;
 
   /**
    * Body param: The maximum number of log lines per batch. This setting must be
    * between 1000 and 1,000,000 lines, or `0` to disable it. Note that you cannot
    * specify a minimum number of log lines per batch; this means that log files may
-   * contain many fewer lines than this. This parameter is not available for jobs
-   * with `edge` as its kind.
+   * contain many fewer lines than this.
    */
-  max_upload_records?: number | null;
+  max_upload_records?: 0 | number | null;
 
   /**
-   * Body param: Optional human readable job name. Not unique. Cloudflare suggests
+   * Body param: Optional human readable job name. Not unique. Cloudflare suggests.
    * that you set this to a meaningful string, like the domain name, to make it
    * easier to identify your job.
    */