cloudflare 7.0.0 → 7.1.0

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

@@ -0,0 +1,210 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import { APIPromise } from '../../../../core/api-promise';
+import { RequestOptions } from '../../../../internal/request-options';
+import { path } from '../../../../internal/utils/path';
+
+export class BaseCategories extends APIResource {
+  static override readonly _key: readonly ['cloudforceOne', 'threatEvents', 'tags', 'categories'] =
+    Object.freeze(['cloudforceOne', 'threatEvents', 'tags', 'categories'] as const);
+
+  /**
+   * Creates a new Source-of-Truth tag category for an account.
+   *
+   * @example
+   * ```ts
+   * const category =
+   *   await client.cloudforceOne.threatEvents.tags.categories.create(
+   *     { account_id: 'account_id', name: 'Actor' },
+   *   );
+   * ```
+   */
+  create(params: CategoryCreateParams, options?: RequestOptions): APIPromise<CategoryCreateResponse> {
+    const { account_id, ...body } = params;
+    return this._client.post(path`/accounts/${account_id}/cloudforce-one/events/tags/categories/create`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Returns all Source-of-Truth tag categories for an account.
+   *
+   * @example
+   * ```ts
+   * const categories =
+   *   await client.cloudforceOne.threatEvents.tags.categories.list(
+   *     { account_id: 'account_id' },
+   *   );
+   * ```
+   */
+  list(params: CategoryListParams, options?: RequestOptions): APIPromise<CategoryListResponse> {
+    const { account_id, ...query } = params;
+    return this._client.get(path`/accounts/${account_id}/cloudforce-one/events/tags/categories`, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Deletes a Source-of-Truth tag category by UUID.
+   *
+   * @example
+   * ```ts
+   * const category =
+   *   await client.cloudforceOne.threatEvents.tags.categories.delete(
+   *     'category_uuid',
+   *     { account_id: 'account_id' },
+   *   );
+   * ```
+   */
+  delete(
+    categoryUUID: string,
+    params: CategoryDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<CategoryDeleteResponse> {
+    const { account_id } = params;
+    return this._client.delete(
+      path`/accounts/${account_id}/cloudforce-one/events/tags/categories/${categoryUUID}`,
+      options,
+    );
+  }
+
+  /**
+   * Updates a Source-of-Truth tag category by UUID.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.cloudforceOne.threatEvents.tags.categories.edit(
+   *     'category_uuid',
+   *     { account_id: 'account_id' },
+   *   );
+   * ```
+   */
+  edit(
+    categoryUUID: string,
+    params: CategoryEditParams,
+    options?: RequestOptions,
+  ): APIPromise<CategoryEditResponse> {
+    const { account_id, ...body } = params;
+    return this._client.patch(
+      path`/accounts/${account_id}/cloudforce-one/events/tags/categories/${categoryUUID}`,
+      { body, ...options },
+    );
+  }
+}
+export class Categories extends BaseCategories {}
+
+export interface CategoryCreateResponse {
+  name: string;
+
+  uuid: string;
+
+  createdAt?: string;
+
+  description?: string;
+
+  updatedAt?: string;
+}
+
+export interface CategoryListResponse {
+  categories: Array<CategoryListResponse.Category>;
+}
+
+export namespace CategoryListResponse {
+  export interface Category {
+    name: string;
+
+    uuid: string;
+
+    createdAt?: string;
+
+    description?: string;
+
+    updatedAt?: string;
+  }
+}
+
+export interface CategoryDeleteResponse {
+  uuid: string;
+}
+
+export interface CategoryEditResponse {
+  name: string;
+
+  uuid: string;
+
+  createdAt?: string;
+
+  description?: string;
+
+  updatedAt?: string;
+}
+
+export interface CategoryCreateParams {
+  /**
+   * Path param: Account ID.
+   */
+  account_id: string;
+
+  /**
+   * Body param
+   */
+  name: string;
+
+  /**
+   * Body param
+   */
+  description?: string;
+}
+
+export interface CategoryListParams {
+  /**
+   * Path param: Account ID.
+   */
+  account_id: string;
+
+  /**
+   * Query param
+   */
+  search?: string;
+}
+
+export interface CategoryDeleteParams {
+  /**
+   * Account ID.
+   */
+  account_id: string;
+}
+
+export interface CategoryEditParams {
+  /**
+   * Path param: Account ID.
+   */
+  account_id: string;
+
+  /**
+   * Body param
+   */
+  description?: string;
+
+  /**
+   * Body param
+   */
+  name?: string;
+}
+
+export declare namespace Categories {
+  export {
+    type CategoryCreateResponse as CategoryCreateResponse,
+    type CategoryListResponse as CategoryListResponse,
+    type CategoryDeleteResponse as CategoryDeleteResponse,
+    type CategoryEditResponse as CategoryEditResponse,
+    type CategoryCreateParams as CategoryCreateParams,
+    type CategoryListParams as CategoryListParams,
+    type CategoryDeleteParams as CategoryDeleteParams,
+    type CategoryEditParams as CategoryEditParams,
+  };
+}

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

@@ -0,0 +1,32 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Categories,
+  BaseCategories,
+  type CategoryCreateResponse,
+  type CategoryListResponse,
+  type CategoryDeleteResponse,
+  type CategoryEditResponse,
+  type CategoryCreateParams,
+  type CategoryListParams,
+  type CategoryDeleteParams,
+  type CategoryEditParams,
+} from './categories';
+export {
+  Indicators,
+  BaseIndicators,
+  type IndicatorListResponse,
+  type IndicatorListParams,
+} from './indicators/index';
+export {
+  Tags,
+  BaseTags,
+  type TagCreateResponse,
+  type TagListResponse,
+  type TagDeleteResponse,
+  type TagEditResponse,
+  type TagCreateParams,
+  type TagListParams,
+  type TagDeleteParams,
+  type TagEditParams,
+} from './tags';

package/src/resources/cloudforce-one/threat-events/tags/indicators/by-dataset.ts

@@ -0,0 +1,178 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../../core/resource';
+import { APIPromise } from '../../../../../core/api-promise';
+import { RequestOptions } from '../../../../../internal/request-options';
+import { path } from '../../../../../internal/utils/path';
+
+export class BaseByDataset extends APIResource {
+  static override readonly _key: readonly [
+    'cloudforceOne',
+    'threatEvents',
+    'tags',
+    'indicators',
+    'byDataset',
+  ] = Object.freeze(['cloudforceOne', 'threatEvents', 'tags', 'indicators', 'byDataset'] as const);
+
+  /**
+   * This endpoint is deprecated. Use GET
+   * /:account_id/events/tags/:tag_uuid/indicators with the optional datasetIds query
+   * parameter instead. Returns indicators associated with the provided tag UUID
+   * within a single dataset's indicator shards, with pagination.
+   *
+   * @deprecated Use list instead (GET /accounts/{account_id}/cloudforce-one/events/tags/{tag_uuid}/indicators).
+   */
+  list(
+    tagUUID: string,
+    params: ByDatasetListParams,
+    options?: RequestOptions,
+  ): APIPromise<ByDatasetListResponse> {
+    const { account_id, dataset_id, ...query } = params;
+    return this._client.get(
+      path`/accounts/${account_id}/cloudforce-one/events/dataset/${dataset_id}/tags/${tagUUID}/indicators`,
+      { query, ...options },
+    );
+  }
+}
+export class ByDataset extends BaseByDataset {}
+
+export interface ByDatasetListResponse {
+  indicators: Array<ByDatasetListResponse.Indicator>;
+
+  pagination: ByDatasetListResponse.Pagination;
+}
+
+export namespace ByDatasetListResponse {
+  export interface Indicator {
+    createdAt: string;
+
+    indicatorType: string;
+
+    updatedAt: string;
+
+    uuid: string;
+
+    value: string;
+
+    /**
+     * The dataset ID this indicator belongs to. Included in list responses.
+     */
+    datasetId?: string;
+
+    relatedEvents?: Array<Indicator.RelatedEvent>;
+
+    tags?: Array<Indicator.Tag>;
+  }
+
+  export namespace Indicator {
+    export interface RelatedEvent {
+      datasetId: string;
+
+      eventId: string;
+
+      /**
+       * ISO 8601 date of the related event. Null for legacy relationships created before
+       * event-date tracking was added.
+       */
+      eventDate?: string | null;
+    }
+
+    export interface Tag {
+      categoryName?: string;
+
+      uuid?: string;
+
+      value?: string;
+    }
+  }
+
+  export interface Pagination {
+    page: number;
+
+    pageSize: number;
+
+    totalCount: number;
+
+    totalPages: number;
+  }
+}
+
+export interface ByDatasetListParams {
+  /**
+   * Path param: Account ID.
+   */
+  account_id: string;
+
+  /**
+   * Path param: Dataset UUID.
+   */
+  dataset_id: string;
+
+  /**
+   * Query param
+   */
+  indicatorType?: string;
+
+  /**
+   * Query param
+   */
+  page?: number;
+
+  /**
+   * Query param
+   */
+  pageSize?: number;
+
+  /**
+   * Query param: Filter indicators by related event UUID(s). Multiple UUIDs can be
+   * provided by repeating the parameter.
+   */
+  relatedEvent?: Array<string>;
+
+  /**
+   * Query param: Structured search as a JSON array of {field, op, value} objects.
+   * Searchable fields: value, indicatorType. Multiple conditions are AND'd together.
+   * Max 10 conditions per request.
+   */
+  search?: Array<ByDatasetListParams.Search>;
+}
+
+export namespace ByDatasetListParams {
+  export interface Search {
+    /**
+     * The indicator field to search on. Allowed: value, indicatorType, uuid.
+     */
+    field: 'value' | 'indicatorType' | 'uuid';
+
+    /**
+     * Search operator. Use 'in' for bulk lookup of up to 100 values at once, e.g.
+     * {field:'value', op:'in', value:['evil.com','bad.org']}.
+     */
+    op:
+      | 'equals'
+      | 'not'
+      | 'gt'
+      | 'gte'
+      | 'lt'
+      | 'lte'
+      | 'like'
+      | 'contains'
+      | 'startsWith'
+      | 'endsWith'
+      | 'in'
+      | 'find';
+
+    /**
+     * Search value. String for most operators. Array of strings for 'in' operator (max
+     * 100 items).
+     */
+    value: string | Array<string>;
+  }
+}
+
+export declare namespace ByDataset {
+  export {
+    type ByDatasetListResponse as ByDatasetListResponse,
+    type ByDatasetListParams as ByDatasetListParams,
+  };
+}

package/src/resources/cloudforce-one/threat-events/tags/indicators/index.ts

@@ -0,0 +1,9 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { ByDataset, BaseByDataset, type ByDatasetListResponse, type ByDatasetListParams } from './by-dataset';
+export {
+  Indicators,
+  BaseIndicators,
+  type IndicatorListResponse,
+  type IndicatorListParams,
+} from './indicators';

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

@@ -0,0 +1,195 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../../core/resource';
+import * as ByDatasetAPI from './by-dataset';
+import { BaseByDataset, ByDataset, ByDatasetListParams, ByDatasetListResponse } from './by-dataset';
+import { APIPromise } from '../../../../../core/api-promise';
+import { RequestOptions } from '../../../../../internal/request-options';
+import { path } from '../../../../../internal/utils/path';
+
+export class BaseIndicators extends APIResource {
+  static override readonly _key: readonly ['cloudforceOne', 'threatEvents', 'tags', 'indicators'] =
+    Object.freeze(['cloudforceOne', 'threatEvents', 'tags', 'indicators'] as const);
+
+  /**
+   * Returns indicators associated with the provided tag UUID, with pagination. By
+   * default fans out across every indicator dataset the account can read; pass
+   * datasetIds to scope to specific datasets.
+   *
+   * @example
+   * ```ts
+   * const indicators =
+   *   await client.cloudforceOne.threatEvents.tags.indicators.list(
+   *     'tag_uuid',
+   *     { account_id: 'account_id' },
+   *   );
+   * ```
+   */
+  list(
+    tagUUID: string,
+    params: IndicatorListParams,
+    options?: RequestOptions,
+  ): APIPromise<IndicatorListResponse> {
+    const { account_id, ...query } = params;
+    return this._client.get(path`/accounts/${account_id}/cloudforce-one/events/tags/${tagUUID}/indicators`, {
+      query,
+      ...options,
+    });
+  }
+}
+export class Indicators extends BaseIndicators {
+  byDataset: ByDatasetAPI.ByDataset = new ByDatasetAPI.ByDataset(this._client);
+}
+
+export interface IndicatorListResponse {
+  indicators: Array<IndicatorListResponse.Indicator>;
+
+  pagination: IndicatorListResponse.Pagination;
+}
+
+export namespace IndicatorListResponse {
+  export interface Indicator {
+    createdAt: string;
+
+    indicatorType: string;
+
+    updatedAt: string;
+
+    uuid: string;
+
+    value: string;
+
+    /**
+     * The dataset ID this indicator belongs to. Included in list responses.
+     */
+    datasetId?: string;
+
+    relatedEvents?: Array<Indicator.RelatedEvent>;
+
+    tags?: Array<Indicator.Tag>;
+  }
+
+  export namespace Indicator {
+    export interface RelatedEvent {
+      datasetId: string;
+
+      eventId: string;
+
+      /**
+       * ISO 8601 date of the related event. Null for legacy relationships created before
+       * event-date tracking was added.
+       */
+      eventDate?: string | null;
+    }
+
+    export interface Tag {
+      categoryName?: string;
+
+      uuid?: string;
+
+      value?: string;
+    }
+  }
+
+  export interface Pagination {
+    page: number;
+
+    pageSize: number;
+
+    totalCount: number;
+
+    totalPages: number;
+  }
+}
+
+export interface IndicatorListParams {
+  /**
+   * Path param: Account ID.
+   */
+  account_id: string;
+
+  /**
+   * Query param: Dataset UUIDs to scope to (repeat the param for multiple), or 'all'
+   * / '\*' for every readable indicator dataset. Omit to search all readable
+   * datasets.
+   */
+  datasetIds?: Array<string>;
+
+  /**
+   * Query param
+   */
+  indicatorType?: string;
+
+  /**
+   * Query param
+   */
+  page?: number;
+
+  /**
+   * Query param
+   */
+  pageSize?: number;
+
+  /**
+   * Query param: Filter indicators by related event UUID(s). Multiple UUIDs can be
+   * provided by repeating the parameter.
+   */
+  relatedEvent?: Array<string>;
+
+  /**
+   * Query param: Structured search as a JSON array of {field, op, value} objects.
+   * Searchable fields: value, indicatorType. Multiple conditions are AND'd together.
+   * Max 10 conditions per request.
+   */
+  search?: Array<IndicatorListParams.Search>;
+}
+
+export namespace IndicatorListParams {
+  export interface Search {
+    /**
+     * The indicator field to search on. Allowed: value, indicatorType, uuid.
+     */
+    field: 'value' | 'indicatorType' | 'uuid';
+
+    /**
+     * Search operator. Use 'in' for bulk lookup of up to 100 values at once, e.g.
+     * {field:'value', op:'in', value:['evil.com','bad.org']}.
+     */
+    op:
+      | 'equals'
+      | 'not'
+      | 'gt'
+      | 'gte'
+      | 'lt'
+      | 'lte'
+      | 'like'
+      | 'contains'
+      | 'startsWith'
+      | 'endsWith'
+      | 'in'
+      | 'find';
+
+    /**
+     * Search value. String for most operators. Array of strings for 'in' operator (max
+     * 100 items).
+     */
+    value: string | Array<string>;
+  }
+}
+
+Indicators.ByDataset = ByDataset;
+Indicators.BaseByDataset = BaseByDataset;
+
+export declare namespace Indicators {
+  export {
+    type IndicatorListResponse as IndicatorListResponse,
+    type IndicatorListParams as IndicatorListParams,
+  };
+
+  export {
+    ByDataset as ByDataset,
+    BaseByDataset as BaseByDataset,
+    type ByDatasetListResponse as ByDatasetListResponse,
+    type ByDatasetListParams as ByDatasetListParams,
+  };
+}

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

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