cloudflare/src/resources/email-security/investigate/reclassify.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 BaseReclassify extends APIResource {
  static override readonly _key: readonly ['emailSecurity', 'investigate', 'reclassify'] = Object.freeze([
    'emailSecurity',
    'investigate',
    'reclassify',
  ] as const);

  /**
   * Submits a request to reclassify an email's disposition. Use for reporting false
   * positives or false negatives. Optionally provide the raw EML content for
   * reanalysis. The reclassification is processed asynchronously. Deprecated; use
   * the create submissions endpoint instead.
   *
   * @deprecated
   */
  create(
    investigateID: string,
    params: ReclassifyCreateParams,
    options?: RequestOptions,
  ): APIPromise<ReclassifyCreateResponse> {
    const { account_id, ...body } = params;
    return (
      this._client.post(
        path`/accounts/${account_id}/email-security/investigate/${investigateID}/reclassify`,
        { body, ...options },
      ) as APIPromise<{ result: ReclassifyCreateResponse }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class Reclassify extends BaseReclassify {}

export type ReclassifyCreateResponse = unknown;

export interface ReclassifyCreateParams {
  /**
   * Path param: Account identifier tag.
   */
  account_id: string;

  /**
   * Body param: The disposition the message should have.
   */
  expected_disposition: 'NONE' | 'BULK' | 'MALICIOUS' | 'SPAM' | 'SPOOF' | 'SUSPICIOUS';

  /**
   * Body param: Base64 encoded content of the EML file.
   */
  eml_content?: string;

  /**
   * Body param: Submission ID of the original user submission, when reclassifying an
   * escalated user report.
   */
  escalated_submission_id?: string;
}

export declare namespace Reclassify {
  export {
    type ReclassifyCreateResponse as ReclassifyCreateResponse,
    type ReclassifyCreateParams as ReclassifyCreateParams,
  };
}