@ringer-tel/ivy/src/models/FaxMachineResponse.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.6
 * 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';
import type { Link } from './Link';
import {
    LinkFromJSON,
    LinkFromJSONTyped,
    LinkToJSON,
    LinkToJSONTyped,
} from './Link';

/**
 * Detailed information about a fax machine (Fax to Email) configuration.
 * @export
 * @interface FaxMachineResponse
 */
export interface FaxMachineResponse {
    /**
     * A user-friendly name for the fax machine configuration.
     * @type {string}
     * @memberof FaxMachineResponse
     */
    name: string;
    /**
     * Comma-separated list of email addresses to which received faxes (as PDF) will be sent.
     * @type {string}
     * @memberof FaxMachineResponse
     */
    notificationEmails: string;
    /**
     * Unique identifier for the fax machine configuration.
     * @type {number}
     * @memberof FaxMachineResponse
     */
    readonly id?: number;
    /**
     * Identifier of the site this fax machine belongs to.
     * @type {string}
     * @memberof FaxMachineResponse
     */
    site?: string | null;
    /**
     * System-level code for this fax machine, often used in routing configurations.
     * @type {string}
     * @memberof FaxMachineResponse
     */
    readonly code?: string;
    /**
     * Identifier of the user primarily associated with this fax machine, if any.
     * @type {number}
     * @memberof FaxMachineResponse
     */
    userId?: number | null;
    /**
     * HATEOAS links related to this fax machine.
     * @type {Array<Link>}
     * @memberof FaxMachineResponse
     */
    links?: Array<Link> | null;
}

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

export function FaxMachineResponseFromJSON(json: any): FaxMachineResponse {
    return FaxMachineResponseFromJSONTyped(json, false);
}

export function FaxMachineResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FaxMachineResponse {
    if (json == null) {
        return json;
    }
    return {
        
        'name': json['name'],
        'notificationEmails': json['notification_emails'],
        'id': json['id'] == null ? undefined : json['id'],
        'site': json['site'] == null ? undefined : json['site'],
        'code': json['code'] == null ? undefined : json['code'],
        'userId': json['user_id'] == null ? undefined : json['user_id'],
        'links': json['links'] == null ? undefined : ((json['links'] as Array<any>).map(LinkFromJSON)),
    };
}

export function FaxMachineResponseToJSON(json: any): FaxMachineResponse {
    return FaxMachineResponseToJSONTyped(json, false);
}

export function FaxMachineResponseToJSONTyped(value?: Omit<FaxMachineResponse, 'id'|'code'> | null, ignoreDiscriminator: boolean = false): any {
    if (value == null) {
        return value;
    }

    return {
        
        'name': value['name'],
        'notification_emails': value['notificationEmails'],
        'site': value['site'],
        'user_id': value['userId'],
        'links': value['links'] == null ? undefined : ((value['links'] as Array<any>).map(LinkToJSON)),
    };
}