cloudflare/src/resources/cloudforce-one/threat-events/relate.ts

The official TypeScript library for the Cloudflare API

// 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 BaseRelate extends APIResource {
  static override readonly _key: readonly ['cloudforceOne', 'threatEvents', 'relate'] = Object.freeze([
    'cloudforceOne',
    'threatEvents',
    'relate',
  ] as const);

  /**
   * Removes a reference link between related threat events in Cloudforce One.
   *
   * @example
   * ```ts
   * const relate =
   *   await client.cloudforceOne.threatEvents.relate.delete(
   *     'event_id',
   *     { account_id: 'account_id' },
   *   );
   * ```
   */
  delete(
    eventID: string,
    params: RelateDeleteParams,
    options?: RequestOptions,
  ): APIPromise<RelateDeleteResponse> {
    const { account_id } = params;
    return (
      this._client.delete(
        path`/accounts/${account_id}/cloudforce-one/events/relate/${eventID}`,
        options,
      ) as APIPromise<{ result: RelateDeleteResponse }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class Relate extends BaseRelate {}

export interface RelateDeleteResponse {
  success: boolean;
}

export interface RelateDeleteParams {
  /**
   * Account ID.
   */
  account_id: string;
}

export declare namespace Relate {
  export { type RelateDeleteResponse as RelateDeleteResponse, type RelateDeleteParams as RelateDeleteParams };
}