cloudflare/src/resources/zero-trust/dlp/email/account-mapping.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 BaseAccountMapping extends APIResource {
  static override readonly _key: readonly ['zeroTrust', 'dlp', 'email', 'accountMapping'] = Object.freeze([
    'zeroTrust',
    'dlp',
    'email',
    'accountMapping',
  ] as const);

  /**
   * Creates a mapping between a Cloudflare account and an email provider for DLP
   * email scanning integration.
   *
   * @example
   * ```ts
   * const accountMapping =
   *   await client.zeroTrust.dlp.email.accountMapping.create({
   *     account_id: 'account_id',
   *     auth_requirements: {
   *       allowed_microsoft_organizations: ['string'],
   *       type: 'Org',
   *     },
   *   });
   * ```
   */
  create(
    params: AccountMappingCreateParams,
    options?: RequestOptions,
  ): APIPromise<AccountMappingCreateResponse> {
    const { account_id, ...body } = params;
    return (
      this._client.post(path`/accounts/${account_id}/dlp/email/account_mapping`, {
        body,
        ...options,
      }) as APIPromise<{ result: AccountMappingCreateResponse }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Retrieves the email provider mapping configuration for DLP email scanning.
   *
   * @example
   * ```ts
   * const accountMapping =
   *   await client.zeroTrust.dlp.email.accountMapping.get({
   *     account_id: 'account_id',
   *   });
   * ```
   */
  get(params: AccountMappingGetParams, options?: RequestOptions): APIPromise<AccountMappingGetResponse> {
    const { account_id } = params;
    return (
      this._client.get(path`/accounts/${account_id}/dlp/email/account_mapping`, options) as APIPromise<{
        result: AccountMappingGetResponse;
      }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class AccountMapping extends BaseAccountMapping {}

export interface AccountMappingCreateResponse {
  addin_identifier_token: string;

  auth_requirements: AccountMappingCreateResponse.UnionMember0 | AccountMappingCreateResponse.Type;
}

export namespace AccountMappingCreateResponse {
  export interface UnionMember0 {
    allowed_microsoft_organizations: Array<string>;

    type: 'Org';
  }

  export interface Type {
    type: 'NoAuth';
  }
}

export interface AccountMappingGetResponse {
  addin_identifier_token: string;

  auth_requirements: AccountMappingGetResponse.UnionMember0 | AccountMappingGetResponse.Type;
}

export namespace AccountMappingGetResponse {
  export interface UnionMember0 {
    allowed_microsoft_organizations: Array<string>;

    type: 'Org';
  }

  export interface Type {
    type: 'NoAuth';
  }
}

export interface AccountMappingCreateParams {
  /**
   * Path param
   */
  account_id: string;

  /**
   * Body param
   */
  auth_requirements: AccountMappingCreateParams.UnionMember0 | AccountMappingCreateParams.Type;
}

export namespace AccountMappingCreateParams {
  export interface UnionMember0 {
    allowed_microsoft_organizations: Array<string>;

    type: 'Org';
  }

  export interface Type {
    type: 'NoAuth';
  }
}

export interface AccountMappingGetParams {
  account_id: string;
}

export declare namespace AccountMapping {
  export {
    type AccountMappingCreateResponse as AccountMappingCreateResponse,
    type AccountMappingGetResponse as AccountMappingGetResponse,
    type AccountMappingCreateParams as AccountMappingCreateParams,
    type AccountMappingGetParams as AccountMappingGetParams,
  };
}