@ringer-tel/ivy/models/FaxMachineCreateRequest.ts

TypeScript SDK for Ringer APIs

/* tslint:disable */
/* eslint-disable */
/**
 * Ringer Business API
 * This API provides comprehensive endpoints for the Ringer Business system. It includes functionality for managing customer accounts, addresses, sites,  phone numbers, payments, users, and other business resources.  Operations typically require authentication and appropriate permissions. 
 *
 * The version of the OpenAPI document: 1.0.5
 * Contact: support@ringer.tel
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

import { mapValues } from '../runtime';
/**
 * Data required to create a new fax machine (Fax to Email) configuration.
 * @export
 * @interface FaxMachineCreateRequest
 */
export interface FaxMachineCreateRequest {
    /**
     * A user-friendly name for the fax machine configuration.
     * @type {string}
     * @memberof FaxMachineCreateRequest
     */
    name: string;
    /**
     * Comma-separated list of email addresses to which received faxes (as PDF) will be sent.
     * @type {string}
     * @memberof FaxMachineCreateRequest
     */
    notificationEmails: string;
    /**
     * Identifier of the user primarily associated with this fax machine, if any.
     * @type {number}
     * @memberof FaxMachineCreateRequest
     */
    userId?: number | null;
}

/**
 * Check if a given object implements the FaxMachineCreateRequest interface.
 */
export function instanceOfFaxMachineCreateRequest(value: object): value is FaxMachineCreateRequest {
    if (!('name' in value) || value['name'] === undefined) return false;
    if (!('notificationEmails' in value) || value['notificationEmails'] === undefined) return false;
    return true;
}

export function FaxMachineCreateRequestFromJSON(json: any): FaxMachineCreateRequest {
    return FaxMachineCreateRequestFromJSONTyped(json, false);
}

export function FaxMachineCreateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): FaxMachineCreateRequest {
    if (json == null) {
        return json;
    }
    return {
        
        'name': json['name'],
        'notificationEmails': json['notification_emails'],
        'userId': json['user_id'] == null ? undefined : json['user_id'],
    };
}

export function FaxMachineCreateRequestToJSON(json: any): FaxMachineCreateRequest {
    return FaxMachineCreateRequestToJSONTyped(json, false);
}

export function FaxMachineCreateRequestToJSONTyped(value?: FaxMachineCreateRequest | null, ignoreDiscriminator: boolean = false): any {
    if (value == null) {
        return value;
    }

    return {
        
        'name': value['name'],
        'notification_emails': value['notificationEmails'],
        'user_id': value['userId'],
    };
}