cloudflare 4.0.0 → 4.1.0

package/src/resources/rulesets/rulesets.ts

@@ -3,7 +3,6 @@
 import { APIResource } from '../../resource';
 import { isRequestOptions } from '../../core';
 import * as Core from '../../core';
-import { CloudflareError } from "../../error";
 import * as RulesAPI from './rules';
 import {
   BlockRule,
@@ -51,7 +50,8 @@ import {
   PhaseUpdateResponse,
   Phases,
 } from './phases/phases';
-import { SinglePage } from '../../pagination';
+import { CloudflareError } from '../../error';
+import { CursorPagination, type CursorPaginationParams } from '../../pagination';
 
 export class Rulesets extends APIResource {
   phases: PhasesAPI.Phases = new PhasesAPI.Phases(this._client);
@@ -126,16 +126,18 @@ export class Rulesets extends APIResource {
   list(
     params?: RulesetListParams,
     options?: Core.RequestOptions,
-  ): Core.PagePromise<RulesetListResponsesSinglePage, RulesetListResponse>;
-  list(options?: Core.RequestOptions): Core.PagePromise<RulesetListResponsesSinglePage, RulesetListResponse>;
+  ): Core.PagePromise<RulesetListResponsesCursorPagination, RulesetListResponse>;
+  list(
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<RulesetListResponsesCursorPagination, RulesetListResponse>;
   list(
     params: RulesetListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
-  ): Core.PagePromise<RulesetListResponsesSinglePage, RulesetListResponse> {
+  ): Core.PagePromise<RulesetListResponsesCursorPagination, RulesetListResponse> {
     if (isRequestOptions(params)) {
       return this.list({}, params);
     }
-    const { account_id, zone_id } = 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.');
     }
@@ -154,8 +156,8 @@ export class Rulesets extends APIResource {
         };
     return this._client.getAPIList(
       `/${accountOrZone}/${accountOrZoneId}/rulesets`,
-      RulesetListResponsesSinglePage,
-      options,
+      RulesetListResponsesCursorPagination,
+      { query, ...options },
     );
   }
 
@@ -242,7 +244,7 @@ export class Rulesets extends APIResource {
   }
 }
 
-export class RulesetListResponsesSinglePage extends SinglePage<RulesetListResponse> {}
+export class RulesetListResponsesCursorPagination extends CursorPagination<RulesetListResponse> {}
 
 /**
  * The kind of the ruleset.
@@ -1988,14 +1990,16 @@ export namespace RulesetUpdateParams {
   }
 }
 
-export interface RulesetListParams {
+export interface RulesetListParams extends CursorPaginationParams {
   /**
-   * The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
+   * Path param: 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.
+   * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
+   * Account ID.
    */
   zone_id?: string;
 }

package/src/resources/rulesets/versions.ts

@@ -3,9 +3,9 @@
 import { APIResource } from '../../resource';
 import { isRequestOptions } from '../../core';
 import * as Core from '../../core';
-import { CloudflareError } from "../../error";
 import * as RulesAPI from './rules';
 import * as RulesetsAPI from './rulesets';
+import { CloudflareError } from '../../error';
 import { SinglePage } from '../../pagination';
 
 export class Versions extends APIResource {

package/src/resources/security-center/index.ts

@@ -0,0 +1,11 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  InsightListResponsesV4PagePagination,
+  Insights,
+  type InsightListResponse,
+  type InsightDismissResponse,
+  type InsightListParams,
+  type InsightDismissParams,
+} from './insights/index';
+export { SecurityCenter } from './security-center';

package/src/resources/security-center/insights/class.ts

@@ -0,0 +1,129 @@
+// 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 IssuesAPI from '../../intel/attack-surface-report/issues';
+import { CloudflareError } from '../../../error';
+
+export class Class extends APIResource {
+  /**
+   * Get Security Center Insight Counts by Class
+   */
+  get(params?: ClassGetParams, options?: Core.RequestOptions): Core.APIPromise<ClassGetResponse>;
+  get(options?: Core.RequestOptions): Core.APIPromise<ClassGetResponse>;
+  get(
+    params: ClassGetParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ClassGetResponse> {
+    if (isRequestOptions(params)) {
+      return this.get({}, 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.get(`/${accountOrZone}/${accountOrZoneId}/security-center/insights/class`, {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: ClassGetResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export type ClassGetResponse = Array<ClassGetResponse.ClassGetResponseItem>;
+
+export namespace ClassGetResponse {
+  export interface ClassGetResponseItem {
+    count?: number;
+
+    value?: string;
+  }
+}
+
+export interface ClassGetParams {
+  /**
+   * 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:
+   */
+  dismissed?: boolean;
+
+  /**
+   * Query param:
+   */
+  issue_class?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  'issue_class~neq'?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  issue_type?: Array<IssuesAPI.IssueTypeParam>;
+
+  /**
+   * Query param:
+   */
+  'issue_type~neq'?: Array<IssuesAPI.IssueTypeParam>;
+
+  /**
+   * Query param:
+   */
+  product?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  'product~neq'?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  severity?: Array<IssuesAPI.SeverityQueryParamParam>;
+
+  /**
+   * Query param:
+   */
+  'severity~neq'?: Array<IssuesAPI.SeverityQueryParamParam>;
+
+  /**
+   * Query param:
+   */
+  subject?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  'subject~neq'?: Array<string>;
+}
+
+export declare namespace Class {
+  export { type ClassGetResponse as ClassGetResponse, type ClassGetParams as ClassGetParams };
+}

package/src/resources/security-center/insights/index.ts

@@ -0,0 +1,13 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Class, type ClassGetResponse, type ClassGetParams } from './class';
+export {
+  InsightListResponsesV4PagePagination,
+  Insights,
+  type InsightListResponse,
+  type InsightDismissResponse,
+  type InsightListParams,
+  type InsightDismissParams,
+} from './insights';
+export { Severity, type SeverityGetResponse, type SeverityGetParams } from './severity';
+export { Type, type TypeGetResponse, type TypeGetParams } from './type';

package/src/resources/security-center/insights/insights.ts

@@ -0,0 +1,264 @@
+// 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 * as IssuesAPI from '../../intel/attack-surface-report/issues';
+import * as ClassAPI from './class';
+import { Class, ClassGetParams, ClassGetResponse } from './class';
+import * as SeverityAPI from './severity';
+import { Severity, SeverityGetParams, SeverityGetResponse } from './severity';
+import * as TypeAPI from './type';
+import { Type, TypeGetParams, TypeGetResponse } from './type';
+import { CloudflareError } from '../../../error';
+import { V4PagePagination, type V4PagePaginationParams } from '../../../pagination';
+
+export class Insights extends APIResource {
+  class: ClassAPI.Class = new ClassAPI.Class(this._client);
+  severity: SeverityAPI.Severity = new SeverityAPI.Severity(this._client);
+  type: TypeAPI.Type = new TypeAPI.Type(this._client);
+
+  /**
+   * Get Security Center Insights
+   */
+  list(
+    params?: InsightListParams,
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<InsightListResponsesV4PagePagination, InsightListResponse>;
+  list(
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<InsightListResponsesV4PagePagination, InsightListResponse>;
+  list(
+    params: InsightListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.PagePromise<InsightListResponsesV4PagePagination, InsightListResponse> {
+    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}/security-center/insights`,
+      InsightListResponsesV4PagePagination,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Archive Security Center Insight
+   */
+  dismiss(
+    issueId: string,
+    params: InsightDismissParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<InsightDismissResponse> {
+    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}/security-center/insights/${issueId}/dismiss`,
+      { body, ...options },
+    );
+  }
+}
+
+export class InsightListResponsesV4PagePagination extends V4PagePagination<InsightListResponse> {}
+
+export interface InsightListResponse {
+  /**
+   * Total number of results
+   */
+  count?: number;
+
+  issues?: Array<InsightListResponse.Issue>;
+
+  /**
+   * Current page within paginated list of results
+   */
+  page?: number;
+
+  /**
+   * Number of results per page of results
+   */
+  per_page?: number;
+}
+
+export namespace InsightListResponse {
+  export interface Issue {
+    id?: string;
+
+    dismissed?: boolean;
+
+    issue_class?: string;
+
+    issue_type?: IssuesAPI.IssueType;
+
+    payload?: unknown;
+
+    resolve_link?: string;
+
+    resolve_text?: string;
+
+    severity?: 'Low' | 'Moderate' | 'Critical';
+
+    since?: string;
+
+    subject?: string;
+
+    timestamp?: string;
+  }
+}
+
+export interface InsightDismissResponse {
+  errors: Array<Shared.ResponseInfo>;
+
+  messages: Array<Shared.ResponseInfo>;
+
+  /**
+   * Whether the API call was successful
+   */
+  success: true;
+}
+
+export interface InsightListParams extends V4PagePaginationParams {
+  /**
+   * 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:
+   */
+  dismissed?: boolean;
+
+  /**
+   * Query param:
+   */
+  issue_class?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  'issue_class~neq'?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  issue_type?: Array<IssuesAPI.IssueTypeParam>;
+
+  /**
+   * Query param:
+   */
+  'issue_type~neq'?: Array<IssuesAPI.IssueTypeParam>;
+
+  /**
+   * Query param:
+   */
+  product?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  'product~neq'?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  severity?: Array<IssuesAPI.SeverityQueryParamParam>;
+
+  /**
+   * Query param:
+   */
+  'severity~neq'?: Array<IssuesAPI.SeverityQueryParamParam>;
+
+  /**
+   * Query param:
+   */
+  subject?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  'subject~neq'?: Array<string>;
+}
+
+export interface InsightDismissParams {
+  /**
+   * 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:
+   */
+  dismiss?: boolean;
+}
+
+Insights.InsightListResponsesV4PagePagination = InsightListResponsesV4PagePagination;
+Insights.Class = Class;
+Insights.Severity = Severity;
+Insights.Type = Type;
+
+export declare namespace Insights {
+  export {
+    type InsightListResponse as InsightListResponse,
+    type InsightDismissResponse as InsightDismissResponse,
+    InsightListResponsesV4PagePagination as InsightListResponsesV4PagePagination,
+    type InsightListParams as InsightListParams,
+    type InsightDismissParams as InsightDismissParams,
+  };
+
+  export { Class as Class, type ClassGetResponse as ClassGetResponse, type ClassGetParams as ClassGetParams };
+
+  export {
+    Severity as Severity,
+    type SeverityGetResponse as SeverityGetResponse,
+    type SeverityGetParams as SeverityGetParams,
+  };
+
+  export { Type as Type, type TypeGetResponse as TypeGetResponse, type TypeGetParams as TypeGetParams };
+}

package/src/resources/security-center/insights/severity.ts

@@ -0,0 +1,129 @@
+// 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 IssuesAPI from '../../intel/attack-surface-report/issues';
+import { CloudflareError } from '../../../error';
+
+export class Severity extends APIResource {
+  /**
+   * Get Security Center Insight Counts by Severity
+   */
+  get(params?: SeverityGetParams, options?: Core.RequestOptions): Core.APIPromise<SeverityGetResponse>;
+  get(options?: Core.RequestOptions): Core.APIPromise<SeverityGetResponse>;
+  get(
+    params: SeverityGetParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<SeverityGetResponse> {
+    if (isRequestOptions(params)) {
+      return this.get({}, 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.get(`/${accountOrZone}/${accountOrZoneId}/security-center/insights/severity`, {
+        query,
+        ...options,
+      }) as Core.APIPromise<{ result: SeverityGetResponse }>
+    )._thenUnwrap((obj) => obj.result);
+  }
+}
+
+export type SeverityGetResponse = Array<SeverityGetResponse.SeverityGetResponseItem>;
+
+export namespace SeverityGetResponse {
+  export interface SeverityGetResponseItem {
+    count?: number;
+
+    value?: string;
+  }
+}
+
+export interface SeverityGetParams {
+  /**
+   * 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:
+   */
+  dismissed?: boolean;
+
+  /**
+   * Query param:
+   */
+  issue_class?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  'issue_class~neq'?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  issue_type?: Array<IssuesAPI.IssueTypeParam>;
+
+  /**
+   * Query param:
+   */
+  'issue_type~neq'?: Array<IssuesAPI.IssueTypeParam>;
+
+  /**
+   * Query param:
+   */
+  product?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  'product~neq'?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  severity?: Array<IssuesAPI.SeverityQueryParamParam>;
+
+  /**
+   * Query param:
+   */
+  'severity~neq'?: Array<IssuesAPI.SeverityQueryParamParam>;
+
+  /**
+   * Query param:
+   */
+  subject?: Array<string>;
+
+  /**
+   * Query param:
+   */
+  'subject~neq'?: Array<string>;
+}
+
+export declare namespace Severity {
+  export { type SeverityGetResponse as SeverityGetResponse, type SeverityGetParams as SeverityGetParams };
+}