mailslurp-client/src/generated/models/DomainDto.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 from dynamically allocated email addresses. 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';
import {
  DomainNameRecord,
  DomainNameRecordFromJSON,
  DomainNameRecordFromJSONTyped,
  DomainNameRecordToJSON,
} from './';

/**
 * Domain plus verification records and status
 * @export
 * @interface DomainDto
 */
export interface DomainDto {
  /**
   *
   * @type {string}
   * @memberof DomainDto
   */
  id: string;
  /**
   *
   * @type {string}
   * @memberof DomainDto
   */
  userId: string;
  /**
   * Custom domain name
   * @type {string}
   * @memberof DomainDto
   */
  domain: string;
  /**
   * Verification tokens
   * @type {string}
   * @memberof DomainDto
   */
  verificationToken: string;
  /**
   * Unique token DKIM tokens
   * @type {Array<string>}
   * @memberof DomainDto
   */
  dkimTokens: Array<string>;
  /**
   * If the domain is missing records then show which pairs are missing.
   * @type {string}
   * @memberof DomainDto
   */
  missingRecordsMessage?: string | null;
  /**
   * Whether the domain has missing required records. If true then see the domain in the dashboard app.
   * @type {boolean}
   * @memberof DomainDto
   */
  hasMissingRecords: boolean;
  /**
   * Whether domain has been verified or not. If the domain is not verified after 72 hours there is most likely an issue with the domains DNS records.
   * @type {boolean}
   * @memberof DomainDto
   */
  isVerified: boolean;
  /**
   * List of DNS domain name records (C, MX, TXT) etc that you must add to the DNS server associated with your domain provider.
   * @type {Array<DomainNameRecord>}
   * @memberof DomainDto
   */
  domainNameRecords: Array<DomainNameRecord>;
  /**
   * The optional catch all inbox that will receive emails sent to the domain that cannot be matched.
   * @type {string}
   * @memberof DomainDto
   */
  catchAllInboxId?: string | null;
  /**
   *
   * @type {Date}
   * @memberof DomainDto
   */
  createdAt: Date;
  /**
   *
   * @type {Date}
   * @memberof DomainDto
   */
  updatedAt: Date;
  /**
   * Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.
   * @type {string}
   * @memberof DomainDto
   */
  domainType: DomainDtoDomainTypeEnum;
}

/**
 * @export
 * @enum {string}
 */
export enum DomainDtoDomainTypeEnum {
  HTTP_INBOX = 'HTTP_INBOX',
  SMTP_DOMAIN = 'SMTP_DOMAIN',
}

export function DomainDtoFromJSON(json: any): DomainDto {
  return DomainDtoFromJSONTyped(json, false);
}

export function DomainDtoFromJSONTyped(
  json: any,
  ignoreDiscriminator: boolean
): DomainDto {
  if (json === undefined || json === null) {
    return json;
  }
  return {
    id: json['id'],
    userId: json['userId'],
    domain: json['domain'],
    verificationToken: json['verificationToken'],
    dkimTokens: json['dkimTokens'],
    missingRecordsMessage: !exists(json, 'missingRecordsMessage')
      ? undefined
      : json['missingRecordsMessage'],
    hasMissingRecords: json['hasMissingRecords'],
    isVerified: json['isVerified'],
    domainNameRecords: (json['domainNameRecords'] as Array<any>).map(
      DomainNameRecordFromJSON
    ),
    catchAllInboxId: !exists(json, 'catchAllInboxId')
      ? undefined
      : json['catchAllInboxId'],
    createdAt: new Date(json['createdAt']),
    updatedAt: new Date(json['updatedAt']),
    domainType: json['domainType'],
  };
}

export function DomainDtoToJSON(value?: DomainDto | null): any {
  if (value === undefined) {
    return undefined;
  }
  if (value === null) {
    return null;
  }
  return {
    id: value.id,
    userId: value.userId,
    domain: value.domain,
    verificationToken: value.verificationToken,
    dkimTokens: value.dkimTokens,
    missingRecordsMessage: value.missingRecordsMessage,
    hasMissingRecords: value.hasMissingRecords,
    isVerified: value.isVerified,
    domainNameRecords: (value.domainNameRecords as Array<any>).map(
      DomainNameRecordToJSON
    ),
    catchAllInboxId: value.catchAllInboxId,
    createdAt: value.createdAt.toISOString(),
    updatedAt: value.updatedAt.toISOString(),
    domainType: value.domainType,
  };
}