mailslurp-client/src/generated/models/MatchOptions.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 {
  ConditionOption,
  ConditionOptionFromJSON,
  ConditionOptionFromJSONTyped,
  ConditionOptionToJSON,
  MatchOption,
  MatchOptionFromJSON,
  MatchOptionFromJSONTyped,
  MatchOptionToJSON,
} from './';

/**
 * Optional filter for matching emails based on fields. For instance filter results to only include emails whose `SUBJECT` value does `CONTAIN` given match value. An example payload would be `{ matches: [{ field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }] }`. You can also pass conditions such as `HAS_ATTACHMENT`. If you wish to extract regex matches inside the email content see the `getEmailContentMatch` method in the EmailController.
 * @export
 * @interface MatchOptions
 */
export interface MatchOptions {
  /**
   * Zero or more match options such as `{ field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }`. Options are additive so if one does not match the email is excluded from results
   * @type {Array<MatchOption>}
   * @memberof MatchOptions
   */
  matches?: Array<MatchOption> | null;
  /**
   * Zero or more conditions such as `{ condition: 'HAS_ATTACHMENTS', value: 'TRUE' }`. Note the values are the strings `TRUE|FALSE` not booleans.
   * @type {Array<ConditionOption>}
   * @memberof MatchOptions
   */
  conditions?: Array<ConditionOption> | null;
}

export function MatchOptionsFromJSON(json: any): MatchOptions {
  return MatchOptionsFromJSONTyped(json, false);
}

export function MatchOptionsFromJSONTyped(
  json: any,
  ignoreDiscriminator: boolean
): MatchOptions {
  if (json === undefined || json === null) {
    return json;
  }
  return {
    matches: !exists(json, 'matches')
      ? undefined
      : json['matches'] === null
      ? null
      : (json['matches'] as Array<any>).map(MatchOptionFromJSON),
    conditions: !exists(json, 'conditions')
      ? undefined
      : json['conditions'] === null
      ? null
      : (json['conditions'] as Array<any>).map(ConditionOptionFromJSON),
  };
}

export function MatchOptionsToJSON(value?: MatchOptions | null): any {
  if (value === undefined) {
    return undefined;
  }
  if (value === null) {
    return null;
  }
  return {
    matches:
      value.matches === undefined
        ? undefined
        : value.matches === null
        ? null
        : (value.matches as Array<any>).map(MatchOptionToJSON),
    conditions:
      value.conditions === undefined
        ? undefined
        : value.conditions === null
        ? null
        : (value.conditions as Array<any>).map(ConditionOptionToJSON),
  };
}