cloudflare/src/resources/security-center/insights/classification.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 { CloudflareError } from '../../../core/error';
import { RequestOptions } from '../../../internal/request-options';
import { path } from '../../../internal/utils/path';

export class BaseClassification extends APIResource {
  static override readonly _key: readonly ['securityCenter', 'insights', 'classification'] = Object.freeze([
    'securityCenter',
    'insights',
    'classification',
  ] as const);

  /**
   * Updates the user classification for a Security Center insight. Valid values are
   * 'false_positive' or 'accept_risk'. To reset, set classification to null. Cannot
   * change directly between classification values - must reset to null first.
   *
   * @example
   * ```ts
   * const classification =
   *   await client.securityCenter.insights.classification.update(
   *     'issue_id',
   *     { account_id: 'account_id' },
   *   );
   * ```
   */
  update(
    issueID: string,
    params: ClassificationUpdateParams,
    options?: RequestOptions,
  ): APIPromise<ClassificationUpdateResponse> {
    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.patch(
      path`/${accountOrZone}/${accountOrZoneId}/security-center/insights/${issueID}/classification`,
      { body, ...options },
    );
  }
}
export class Classification extends BaseClassification {}

export interface ClassificationUpdateResponse {
  errors: Array<ClassificationUpdateResponse.Error>;

  messages: Array<ClassificationUpdateResponse.Message>;

  /**
   * Whether the API call was successful.
   */
  success: true;
}

export namespace ClassificationUpdateResponse {
  export interface Error {
    code: number;

    message: string;

    documentation_url?: string;

    source?: Error.Source;
  }

  export namespace Error {
    export interface Source {
      pointer?: string;
    }
  }

  export interface Message {
    code: number;

    message: string;

    documentation_url?: string;

    source?: Message.Source;
  }

  export namespace Message {
    export interface Source {
      pointer?: string;
    }
  }
}

export interface ClassificationUpdateParams {
  /**
   * 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: User-defined classification for the insight. Can be
   * 'false_positive', 'accept_risk', 'other', or null.
   */
  classification?: 'false_positive' | 'accept_risk' | 'other' | null;

  /**
   * Body param: Rationale for the classification change. Required when
   * classification is 'accept_risk' or 'other'.
   */
  rationale?: string;
}

export declare namespace Classification {
  export {
    type ClassificationUpdateResponse as ClassificationUpdateResponse,
    type ClassificationUpdateParams as ClassificationUpdateParams,
  };
}