mailslurp-client/src/generated/models/CheckDomainMonitorResults.ts

Official client for MailSlurp Email and SMS API. Create email addresses and phone numbers in Javascript without a mail server. Send and receive real emails in applications or tests.

/* tslint:disable */
/* eslint-disable */
/**
 * MailSlurp API
 * MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It\'s designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more.  ## Resources  - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
 *
 * The version of the OpenAPI document: 6.5.2
 * Contact: contact@mailslurp.dev
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

import { exists, mapValues } from '../runtime';
/**
 * One-shot public domain monitor check results
 * @export
 * @interface CheckDomainMonitorResults
 */
export interface CheckDomainMonitorResults {
  /**
   *
   * @type {string}
   * @memberof CheckDomainMonitorResults
   */
  domain: string;
  /**
   *
   * @type {string}
   * @memberof CheckDomainMonitorResults
   */
  status: CheckDomainMonitorResultsStatusEnum;
  /**
   *
   * @type {number}
   * @memberof CheckDomainMonitorResults
   */
  healthScore: number;
  /**
   *
   * @type {number}
   * @memberof CheckDomainMonitorResults
   */
  totalChecks: number;
  /**
   *
   * @type {number}
   * @memberof CheckDomainMonitorResults
   */
  passingChecks: number;
  /**
   *
   * @type {number}
   * @memberof CheckDomainMonitorResults
   */
  failingChecks: number;
  /**
   *
   * @type {boolean}
   * @memberof CheckDomainMonitorResults
   */
  spfOk: boolean;
  /**
   *
   * @type {boolean}
   * @memberof CheckDomainMonitorResults
   */
  dmarcOk: boolean;
  /**
   *
   * @type {boolean}
   * @memberof CheckDomainMonitorResults
   */
  dmarcEnforced: boolean;
  /**
   *
   * @type {boolean}
   * @memberof CheckDomainMonitorResults
   */
  mxOk: boolean;
  /**
   *
   * @type {Array<string>}
   * @memberof CheckDomainMonitorResults
   */
  insights: Array<string>;
  /**
   *
   * @type {string}
   * @memberof CheckDomainMonitorResults
   */
  errorMessage?: string | null;
}

/**
 * @export
 * @enum {string}
 */
export enum CheckDomainMonitorResultsStatusEnum {
  HEALTHY = 'HEALTHY',
  DEGRADED = 'DEGRADED',
  CRITICAL = 'CRITICAL',
  FAILED = 'FAILED',
}

export function CheckDomainMonitorResultsFromJSON(
  json: any
): CheckDomainMonitorResults {
  return CheckDomainMonitorResultsFromJSONTyped(json, false);
}

export function CheckDomainMonitorResultsFromJSONTyped(
  json: any,
  ignoreDiscriminator: boolean
): CheckDomainMonitorResults {
  if (json === undefined || json === null) {
    return json;
  }
  return {
    domain: json['domain'],
    status: json['status'],
    healthScore: json['healthScore'],
    totalChecks: json['totalChecks'],
    passingChecks: json['passingChecks'],
    failingChecks: json['failingChecks'],
    spfOk: json['spfOk'],
    dmarcOk: json['dmarcOk'],
    dmarcEnforced: json['dmarcEnforced'],
    mxOk: json['mxOk'],
    insights: json['insights'],
    errorMessage: !exists(json, 'errorMessage')
      ? undefined
      : json['errorMessage'],
  };
}

export function CheckDomainMonitorResultsToJSON(
  value?: CheckDomainMonitorResults | null
): any {
  if (value === undefined) {
    return undefined;
  }
  if (value === null) {
    return null;
  }
  return {
    domain: value.domain,
    status: value.status,
    healthScore: value.healthScore,
    totalChecks: value.totalChecks,
    passingChecks: value.passingChecks,
    failingChecks: value.failingChecks,
    spfOk: value.spfOk,
    dmarcOk: value.dmarcOk,
    dmarcEnforced: value.dmarcEnforced,
    mxOk: value.mxOk,
    insights: value.insights,
    errorMessage: value.errorMessage,
  };
}