cloudflare 4.4.1 → 5.0.0

package/src/resources/cloudforce-one/threat-events/threat-events.ts

@@ -33,17 +33,7 @@ import {
 import * as IndicatorTypesAPI from './indicator-types';
 import { IndicatorTypeListParams, IndicatorTypeListResponse, IndicatorTypes } from './indicator-types';
 import * as InsightsAPI from './insights';
-import {
-  InsightCreateParams,
-  InsightCreateResponse,
-  InsightDeleteParams,
-  InsightDeleteResponse,
-  InsightEditParams,
-  InsightEditResponse,
-  InsightGetParams,
-  InsightGetResponse,
-  Insights,
-} from './insights';
+import { Insights } from './insights';
 import * as RawAPI from './raw';
 import { Raw as RawAPIRaw, RawEditParams, RawEditResponse, RawGetParams, RawGetResponse } from './raw';
 import * as RelateAPI from './relate';
@@ -84,22 +74,19 @@ export class ThreatEvents extends APIResource {
   insights: InsightsAPI.Insights = new InsightsAPI.Insights(this._client);
 
   /**
-   * Events must be created in a client-specific dataset, which means the `datasetId`
-   * parameter must be defined. To create a dataset, see the
+   * To create a dataset, see the
    * [`Create Dataset`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/create/)
-   * endpoint.
+   * endpoint. When `datasetId` parameter is unspecified, it will be created in a
+   * default dataset named `Cloudforce One Threat Events`.
    *
    * @example
    * ```ts
    * const threatEvent =
    *   await client.cloudforceOne.threatEvents.create({
    *     account_id: 'account_id',
-   *     attacker: 'Flying Yeti',
-   *     attackerCountry: 'CN',
    *     category: 'Domain Resolution',
    *     date: '2022-04-01T00:00:00Z',
    *     event: 'An attacker registered the domain domain.com',
-   *     indicatorType: 'domain',
    *     raw: { data: { foo: 'bar' } },
    *     tlp: 'amber',
    *   });
@@ -114,8 +101,9 @@ export class ThreatEvents extends APIResource {
   }
 
   /**
-   * The `datasetId` must be defined (to list existing datasets (and their IDs), use
-   * the
+   * When `datasetId` is unspecified, events will be listed from the
+   * `Cloudforce One Threat Events` dataset. To list existing datasets (and their
+   * IDs), use the
    * [`List Datasets`](https://developers.cloudflare.com/api/resources/cloudforce_one/subresources/threat_events/subresources/datasets/methods/list/)
    * endpoint). Also, must provide query parameters.
    *
@@ -172,13 +160,10 @@ export class ThreatEvents extends APIResource {
    *     account_id: 'account_id',
    *     data: [
    *       {
-   *         attacker: 'Flying Yeti',
-   *         attackerCountry: 'CN',
    *         category: 'Domain Resolution',
    *         date: '2022-04-01T00:00:00Z',
    *         event:
    *           'An attacker registered the domain domain.com',
-   *         indicatorType: 'domain',
    *         raw: { data: { foo: 'bar' } },
    *         tlp: 'amber',
    *       },
@@ -243,28 +228,18 @@ export class ThreatEvents extends APIResource {
 }
 
 export interface ThreatEventCreateResponse {
-  id: number;
-
-  accountId: number;
-
   attacker: string;
 
   attackerCountry: string;
 
   category: string;
 
-  categoryId: number;
-
   date: string;
 
   event: string;
 
-  indicator: string;
-
   indicatorType: string;
 
-  indicatorTypeId: number;
-
   killChain: number;
 
   mitreAttack: Array<string>;
@@ -273,8 +248,6 @@ export interface ThreatEventCreateResponse {
 
   numReferences: number;
 
-  rawId: string;
-
   referenced: Array<string>;
 
   referencedIds: Array<number>;
@@ -294,36 +267,24 @@ export interface ThreatEventCreateResponse {
   uuid: string;
 
   insight?: string;
-
-  releasabilityId?: string;
 }
 
 export type ThreatEventListResponse = Array<ThreatEventListResponse.ThreatEventListResponseItem>;
 
 export namespace ThreatEventListResponse {
   export interface ThreatEventListResponseItem {
-    id: number;
-
-    accountId: number;
-
     attacker: string;
 
     attackerCountry: string;
 
     category: string;
 
-    categoryId: number;
-
     date: string;
 
     event: string;
 
-    indicator: string;
-
     indicatorType: string;
 
-    indicatorTypeId: number;
-
     killChain: number;
 
     mitreAttack: Array<string>;
@@ -332,8 +293,6 @@ export namespace ThreatEventListResponse {
 
     numReferences: number;
 
-    rawId: string;
-
     referenced: Array<string>;
 
     referencedIds: Array<number>;
@@ -353,8 +312,6 @@ export namespace ThreatEventListResponse {
     uuid: string;
 
     insight?: string;
-
-    releasabilityId?: string;
   }
 }
 
@@ -362,90 +319,24 @@ export interface ThreatEventDeleteResponse {
   uuid: string;
 }
 
-export type ThreatEventBulkCreateResponse =
-  Array<ThreatEventBulkCreateResponse.ThreatEventBulkCreateResponseItem>;
-
-export namespace ThreatEventBulkCreateResponse {
-  export interface ThreatEventBulkCreateResponseItem {
-    id: number;
-
-    accountId: number;
-
-    attacker: string;
-
-    attackerCountry: string;
-
-    category: string;
-
-    categoryId: number;
-
-    date: string;
-
-    event: string;
-
-    indicator: string;
-
-    indicatorType: string;
-
-    indicatorTypeId: number;
-
-    killChain: number;
-
-    mitreAttack: Array<string>;
-
-    numReferenced: number;
-
-    numReferences: number;
-
-    rawId: string;
-
-    referenced: Array<string>;
-
-    referencedIds: Array<number>;
-
-    references: Array<string>;
-
-    referencesIds: Array<number>;
-
-    tags: Array<string>;
-
-    targetCountry: string;
-
-    targetIndustry: string;
-
-    tlp: string;
-
-    uuid: string;
-
-    insight?: string;
-
-    releasabilityId?: string;
-  }
-}
+/**
+ * Number of created bulk events
+ */
+export type ThreatEventBulkCreateResponse = number;
 
 export interface ThreatEventEditResponse {
-  id: number;
-
-  accountId: number;
-
   attacker: string;
 
   attackerCountry: string;
 
   category: string;
 
-  categoryId: number;
-
   date: string;
 
   event: string;
 
-  indicator: string;
-
   indicatorType: string;
 
-  indicatorTypeId: number;
-
   killChain: number;
 
   mitreAttack: Array<string>;
@@ -454,8 +345,6 @@ export interface ThreatEventEditResponse {
 
   numReferences: number;
 
-  rawId: string;
-
   referenced: Array<string>;
 
   referencedIds: Array<number>;
@@ -475,33 +364,21 @@ export interface ThreatEventEditResponse {
   uuid: string;
 
   insight?: string;
-
-  releasabilityId?: string;
 }
 
 export interface ThreatEventGetResponse {
-  id: number;
-
-  accountId: number;
-
   attacker: string;
 
   attackerCountry: string;
 
   category: string;
 
-  categoryId: number;
-
   date: string;
 
   event: string;
 
-  indicator: string;
-
   indicatorType: string;
 
-  indicatorTypeId: number;
-
   killChain: number;
 
   mitreAttack: Array<string>;
@@ -510,8 +387,6 @@ export interface ThreatEventGetResponse {
 
   numReferences: number;
 
-  rawId: string;
-
   referenced: Array<string>;
 
   referencedIds: Array<number>;
@@ -531,8 +406,6 @@ export interface ThreatEventGetResponse {
   uuid: string;
 
   insight?: string;
-
-  releasabilityId?: string;
 }
 
 export interface ThreatEventCreateParams {
@@ -544,57 +417,57 @@ export interface ThreatEventCreateParams {
   /**
    * Body param:
    */
-  attacker: string;
+  category: string;
 
   /**
    * Body param:
    */
-  attackerCountry: string;
+  date: string;
 
   /**
    * Body param:
    */
-  category: string;
+  event: string;
 
   /**
    * Body param:
    */
-  date: string;
+  raw: ThreatEventCreateParams.Raw;
 
   /**
    * Body param:
    */
-  event: string;
+  tlp: string;
 
   /**
    * Body param:
    */
-  indicatorType: string;
+  accountId?: number;
 
   /**
    * Body param:
    */
-  raw: ThreatEventCreateParams.Raw;
+  attacker?: string | null;
 
   /**
    * Body param:
    */
-  tlp: string;
+  attackerCountry?: string;
 
   /**
    * Body param:
    */
-  accountId?: number;
+  datasetId?: string;
 
   /**
    * Body param:
    */
-  datasetId?: string;
+  indicator?: string;
 
   /**
    * Body param:
    */
-  indicator?: string;
+  indicatorType?: string;
 
   /**
    * Body param:
@@ -614,7 +487,7 @@ export interface ThreatEventCreateParams {
 
 export namespace ThreatEventCreateParams {
   export interface Raw {
-    data: Record<string, unknown> | null;
+    data: { [key: string]: unknown } | null;
 
     source?: string;
 
@@ -712,28 +585,28 @@ export interface ThreatEventBulkCreateParams {
 
 export namespace ThreatEventBulkCreateParams {
   export interface Data {
-    attacker: string;
-
-    attackerCountry: string;
-
     category: string;
 
     date: string;
 
     event: string;
 
-    indicatorType: string;
-
     raw: Data.Raw;
 
     tlp: string;
 
     accountId?: number;
 
+    attacker?: string | null;
+
+    attackerCountry?: string;
+
     datasetId?: string;
 
     indicator?: string;
 
+    indicatorType?: string;
+
     tags?: Array<string>;
 
     targetCountry?: string;
@@ -743,7 +616,7 @@ export namespace ThreatEventBulkCreateParams {
 
   export namespace Data {
     export interface Raw {
-      data: Record<string, unknown> | null;
+      data: { [key: string]: unknown } | null;
 
       source?: string;
 
@@ -761,7 +634,7 @@ export interface ThreatEventEditParams {
   /**
    * Body param:
    */
-  attacker?: string;
+  attacker?: string | null;
 
   /**
    * Body param:
@@ -793,6 +666,16 @@ export interface ThreatEventEditParams {
    */
   indicatorType?: string;
 
+  /**
+   * Body param:
+   */
+  insight?: string;
+
+  /**
+   * Body param:
+   */
+  raw?: ThreatEventEditParams.Raw;
+
   /**
    * Body param:
    */
@@ -809,6 +692,16 @@ export interface ThreatEventEditParams {
   tlp?: string;
 }
 
+export namespace ThreatEventEditParams {
+  export interface Raw {
+    data?: { [key: string]: unknown } | null;
+
+    source?: string;
+
+    tlp?: string;
+  }
+}
+
 export interface ThreatEventGetParams {
   /**
    * Account ID.
@@ -933,15 +826,5 @@ export declare namespace ThreatEvents {
     type TargetIndustryListParams as TargetIndustryListParams,
   };
 
-  export {
-    Insights as Insights,
-    type InsightCreateResponse as InsightCreateResponse,
-    type InsightDeleteResponse as InsightDeleteResponse,
-    type InsightEditResponse as InsightEditResponse,
-    type InsightGetResponse as InsightGetResponse,
-    type InsightCreateParams as InsightCreateParams,
-    type InsightDeleteParams as InsightDeleteParams,
-    type InsightEditParams as InsightEditParams,
-    type InsightGetParams as InsightGetParams,
-  };
+  export { Insights as Insights };
 }

package/src/resources/custom-hostnames/certificate-pack/certificates.ts

@@ -99,7 +99,7 @@ export interface CertificateUpdateResponse {
    * Unique key/value metadata for this hostname. These are per-hostname (customer)
    * settings.
    */
-  custom_metadata?: Record<string, string>;
+  custom_metadata?: { [key: string]: string };
 
   /**
    * a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME

package/src/resources/custom-hostnames/custom-hostnames.ts

@@ -196,7 +196,7 @@ export interface CustomHostname {
    * Unique key/value metadata for this hostname. These are per-hostname (customer)
    * settings.
    */
-  custom_metadata?: Record<string, string>;
+  custom_metadata?: { [key: string]: string };
 
   /**
    * a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME
@@ -519,7 +519,7 @@ export interface CustomHostnameCreateResponse {
    * Unique key/value metadata for this hostname. These are per-hostname (customer)
    * settings.
    */
-  custom_metadata?: Record<string, string>;
+  custom_metadata?: { [key: string]: string };
 
   /**
    * a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME
@@ -820,7 +820,7 @@ export interface CustomHostnameListResponse {
    * Unique key/value metadata for this hostname. These are per-hostname (customer)
    * settings.
    */
-  custom_metadata?: Record<string, string>;
+  custom_metadata?: { [key: string]: string };
 
   /**
    * a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME
@@ -1128,7 +1128,7 @@ export interface CustomHostnameEditResponse {
    * Unique key/value metadata for this hostname. These are per-hostname (customer)
    * settings.
    */
-  custom_metadata?: Record<string, string>;
+  custom_metadata?: { [key: string]: string };
 
   /**
    * a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME
@@ -1429,7 +1429,7 @@ export interface CustomHostnameGetResponse {
    * Unique key/value metadata for this hostname. These are per-hostname (customer)
    * settings.
    */
-  custom_metadata?: Record<string, string>;
+  custom_metadata?: { [key: string]: string };
 
   /**
    * a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME
@@ -1728,7 +1728,7 @@ export interface CustomHostnameCreateParams {
    * Body param: Unique key/value metadata for this hostname. These are per-hostname
    * (customer) settings.
    */
-  custom_metadata?: Record<string, string>;
+  custom_metadata?: { [key: string]: string };
 }
 
 export namespace CustomHostnameCreateParams {
@@ -1890,7 +1890,7 @@ export interface CustomHostnameEditParams {
    * Body param: Unique key/value metadata for this hostname. These are per-hostname
    * (customer) settings.
    */
-  custom_metadata?: Record<string, string>;
+  custom_metadata?: { [key: string]: string };
 
   /**
    * Body param: a valid hostname that’s been added to your DNS zone as an A, AAAA,

package/src/resources/custom-nameservers.ts

@@ -102,7 +102,7 @@ export interface CustomNameserver {
   status: 'moved' | 'pending' | 'verified';
 
   /**
-   * Identifier
+   * Identifier.
    */
   zone_tag: string;