@ringer-tel/ivy/models/DeviceCore.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';
/**
 * Core properties of a device, used for creation and as part of responses.
 * @export
 * @interface DeviceCore
 */
export interface DeviceCore {
    /**
     * A user-friendly name for the device.
     * @type {string}
     * @memberof DeviceCore
     */
    name: string;
    /**
     * SIP username for the device.
     * @type {string}
     * @memberof DeviceCore
     */
    login: string;
    /**
     * Whether the device is active.
     * @type {boolean}
     * @memberof DeviceCore
     */
    active?: boolean;
    /**
     * Maximum concurrent calls for this device.
     * @type {number}
     * @memberof DeviceCore
     */
    channelLimit?: number;
    /**
     * Ring timeout in seconds.
     * @type {number}
     * @memberof DeviceCore
     */
    timeout?: number;
    /**
     * Caller ID name to present for outbound calls from this device.
     * @type {string}
     * @memberof DeviceCore
     */
    callerIdName?: string | null;
    /**
     * Caller ID number (E.164) to present for outbound calls.
     * @type {string}
     * @memberof DeviceCore
     */
    callerIdNumber?: string | null;
    /**
     * Access Control List (IP/CIDR) for device registration.
     * @type {string}
     * @memberof DeviceCore
     */
    acl?: string | null;
    /**
     * System code for the destination if the device is unreachable or times out.
     * @type {string}
     * @memberof DeviceCore
     */
    failOverDestinationCode?: string | null;
}

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

export function DeviceCoreFromJSON(json: any): DeviceCore {
    return DeviceCoreFromJSONTyped(json, false);
}

export function DeviceCoreFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeviceCore {
    if (json == null) {
        return json;
    }
    return {
        
        'name': json['name'],
        'login': json['login'],
        'active': json['active'] == null ? undefined : json['active'],
        'channelLimit': json['channel_limit'] == null ? undefined : json['channel_limit'],
        'timeout': json['timeout'] == null ? undefined : json['timeout'],
        'callerIdName': json['caller_id_name'] == null ? undefined : json['caller_id_name'],
        'callerIdNumber': json['caller_id_number'] == null ? undefined : json['caller_id_number'],
        'acl': json['acl'] == null ? undefined : json['acl'],
        'failOverDestinationCode': json['fail_over_destination_code'] == null ? undefined : json['fail_over_destination_code'],
    };
}

export function DeviceCoreToJSON(json: any): DeviceCore {
    return DeviceCoreToJSONTyped(json, false);
}

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

    return {
        
        'name': value['name'],
        'login': value['login'],
        'active': value['active'],
        'channel_limit': value['channelLimit'],
        'timeout': value['timeout'],
        'caller_id_name': value['callerIdName'],
        'caller_id_number': value['callerIdNumber'],
        'acl': value['acl'],
        'fail_over_destination_code': value['failOverDestinationCode'],
    };
}