@ringer-tel/ivy/models/PhoneNumberResponse.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';
import type { PhoneNumberResponseAllOfDestination } from './PhoneNumberResponseAllOfDestination';
import {
    PhoneNumberResponseAllOfDestinationFromJSON,
    PhoneNumberResponseAllOfDestinationFromJSONTyped,
    PhoneNumberResponseAllOfDestinationToJSON,
    PhoneNumberResponseAllOfDestinationToJSONTyped,
} from './PhoneNumberResponseAllOfDestination';
import type { Link } from './Link';
import {
    LinkFromJSON,
    LinkFromJSONTyped,
    LinkToJSON,
    LinkToJSONTyped,
} from './Link';
import type { PhoneNumberResponseAllOfFailOverDestination } from './PhoneNumberResponseAllOfFailOverDestination';
import {
    PhoneNumberResponseAllOfFailOverDestinationFromJSON,
    PhoneNumberResponseAllOfFailOverDestinationFromJSONTyped,
    PhoneNumberResponseAllOfFailOverDestinationToJSON,
    PhoneNumberResponseAllOfFailOverDestinationToJSONTyped,
} from './PhoneNumberResponseAllOfFailOverDestination';

/**
 * 
 * @export
 * @interface PhoneNumberResponse
 */
export interface PhoneNumberResponse {
    /**
     * Unique identifier for the phone number record/assignment.
     * @type {number}
     * @memberof PhoneNumberResponse
     */
    id: number;
    /**
     * A user-friendly name or label for the phone number (e.g., "Main Line", "Sales Dept").
     * @type {string}
     * @memberof PhoneNumberResponse
     */
    name: string;
    /**
     * The actual phone number in E.164 format (e.g., +13035551212).
     * @type {string}
     * @memberof PhoneNumberResponse
     */
    number: string;
    /**
     * Identifier of the site this phone number is assigned to.
     * @type {number}
     * @memberof PhoneNumberResponse
     */
    siteId: number;
    /**
     * System code for the destination where calls to this number are routed (e.g., "device:dev_xyz", "menu:ivr_main").
     * @type {string}
     * @memberof PhoneNumberResponse
     */
    destinationCode: string | null;
    /**
     * 
     * @type {PhoneNumberResponseAllOfDestination}
     * @memberof PhoneNumberResponse
     */
    destination?: PhoneNumberResponseAllOfDestination;
    /**
     * 
     * @type {PhoneNumberResponseAllOfFailOverDestination}
     * @memberof PhoneNumberResponse
     */
    failOverDestination?: PhoneNumberResponseAllOfFailOverDestination;
    /**
     * An object containing various HATEOAS links, where each key is the link relation type.
     * @type {{ [key: string]: Link; }}
     * @memberof PhoneNumberResponse
     */
    links?: { [key: string]: Link; };
}

/**
 * Check if a given object implements the PhoneNumberResponse interface.
 */
export function instanceOfPhoneNumberResponse(value: object): value is PhoneNumberResponse {
    if (!('id' in value) || value['id'] === undefined) return false;
    if (!('name' in value) || value['name'] === undefined) return false;
    if (!('number' in value) || value['number'] === undefined) return false;
    if (!('siteId' in value) || value['siteId'] === undefined) return false;
    if (!('destinationCode' in value) || value['destinationCode'] === undefined) return false;
    return true;
}

export function PhoneNumberResponseFromJSON(json: any): PhoneNumberResponse {
    return PhoneNumberResponseFromJSONTyped(json, false);
}

export function PhoneNumberResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PhoneNumberResponse {
    if (json == null) {
        return json;
    }
    return {
        
        'id': json['id'],
        'name': json['name'],
        'number': json['number'],
        'siteId': json['site_id'],
        'destinationCode': json['destination_code'],
        'destination': json['destination'] == null ? undefined : PhoneNumberResponseAllOfDestinationFromJSON(json['destination']),
        'failOverDestination': json['fail_over_destination'] == null ? undefined : PhoneNumberResponseAllOfFailOverDestinationFromJSON(json['fail_over_destination']),
        'links': json['links'] == null ? undefined : (mapValues(json['links'], LinkFromJSON)),
    };
}

export function PhoneNumberResponseToJSON(json: any): PhoneNumberResponse {
    return PhoneNumberResponseToJSONTyped(json, false);
}

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

    return {
        
        'id': value['id'],
        'name': value['name'],
        'number': value['number'],
        'site_id': value['siteId'],
        'destination_code': value['destinationCode'],
        'destination': PhoneNumberResponseAllOfDestinationToJSON(value['destination']),
        'fail_over_destination': PhoneNumberResponseAllOfFailOverDestinationToJSON(value['failOverDestination']),
        'links': value['links'] == null ? undefined : (mapValues(value['links'], LinkToJSON)),
    };
}