@ringer-tel/ivy/src/models/E911Response.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 specific E911 record.
 * @export
 * @interface E911Response
 */
export interface E911Response {
    /**
     * A descriptive name for this E911 record.
     * @type {string}
     * @memberof E911Response
     */
    name: string;
    /**
     * The name to be displayed to the PSAP for 911 calls from this address.
     * @type {string}
     * @memberof E911Response
     */
    callerIdName: string;
    /**
     * Street number.
     * @type {string}
     * @memberof E911Response
     */
    houseNumber: string;
    /**
     * Street number suffix (e.g., "A", "Unit 100").
     * @type {string}
     * @memberof E911Response
     */
    houseNumberSuffix?: string | null;
    /**
     * Street name.
     * @type {string}
     * @memberof E911Response
     */
    street: string;
    /**
     * City name.
     * @type {string}
     * @memberof E911Response
     */
    city: string;
    /**
     * State or province code.
     * @type {string}
     * @memberof E911Response
     */
    stateProvince: string;
    /**
     * Postal or ZIP code.
     * @type {string}
     * @memberof E911Response
     */
    postalCode: string;
    /**
     * Two-letter ISO 3166-1 alpha-2 country code.
     * @type {string}
     * @memberof E911Response
     */
    countryCode: string;
    /**
     * Unique identifier for the E911 record.
     * @type {number}
     * @memberof E911Response
     */
    id: number;
    /**
     * Identifier of the site this E911 record is associated with.
     * @type {number}
     * @memberof E911Response
     */
    siteId: number;
    /**
     * Indicates if the address has been successfully validated for E911 services.
     * @type {boolean}
     * @memberof E911Response
     */
    readonly validated: boolean;
    /**
     * The DID number automatically assigned to this E911 location for callback purposes.
     * @type {string}
     * @memberof E911Response
     */
    readonly didNumber?: string | null;
    /**
     * HATEOAS links related to this E911 record.
     * @type {Array<Link>}
     * @memberof E911Response
     */
    links?: Array<Link> | null;
}

/**
 * Check if a given object implements the E911Response interface.
 */
export function instanceOfE911Response(value: object): value is E911Response {
    if (!('name' in value) || value['name'] === undefined) return false;
    if (!('callerIdName' in value) || value['callerIdName'] === undefined) return false;
    if (!('houseNumber' in value) || value['houseNumber'] === undefined) return false;
    if (!('street' in value) || value['street'] === undefined) return false;
    if (!('city' in value) || value['city'] === undefined) return false;
    if (!('stateProvince' in value) || value['stateProvince'] === undefined) return false;
    if (!('postalCode' in value) || value['postalCode'] === undefined) return false;
    if (!('countryCode' in value) || value['countryCode'] === undefined) return false;
    if (!('id' in value) || value['id'] === undefined) return false;
    if (!('siteId' in value) || value['siteId'] === undefined) return false;
    if (!('validated' in value) || value['validated'] === undefined) return false;
    return true;
}

export function E911ResponseFromJSON(json: any): E911Response {
    return E911ResponseFromJSONTyped(json, false);
}

export function E911ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): E911Response {
    if (json == null) {
        return json;
    }
    return {
        
        'name': json['name'],
        'callerIdName': json['caller_id_name'],
        'houseNumber': json['house_number'],
        'houseNumberSuffix': json['house_number_suffix'] == null ? undefined : json['house_number_suffix'],
        'street': json['street'],
        'city': json['city'],
        'stateProvince': json['state_province'],
        'postalCode': json['postal_code'],
        'countryCode': json['country_code'],
        'id': json['id'],
        'siteId': json['site_id'],
        'validated': json['validated'],
        'didNumber': json['did_number'] == null ? undefined : json['did_number'],
        'links': json['links'] == null ? undefined : ((json['links'] as Array<any>).map(LinkFromJSON)),
    };
}

export function E911ResponseToJSON(json: any): E911Response {
    return E911ResponseToJSONTyped(json, false);
}

export function E911ResponseToJSONTyped(value?: Omit<E911Response, 'validated'|'did_number'> | null, ignoreDiscriminator: boolean = false): any {
    if (value == null) {
        return value;
    }

    return {
        
        'name': value['name'],
        'caller_id_name': value['callerIdName'],
        'house_number': value['houseNumber'],
        'house_number_suffix': value['houseNumberSuffix'],
        'street': value['street'],
        'city': value['city'],
        'state_province': value['stateProvince'],
        'postal_code': value['postalCode'],
        'country_code': value['countryCode'],
        'id': value['id'],
        'site_id': value['siteId'],
        'links': value['links'] == null ? undefined : ((value['links'] as Array<any>).map(LinkToJSON)),
    };
}