@ringer-tel/ivy/models/VoicemailBoxAttributes.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';
/**
 * 
 * @export
 * @interface VoicemailBoxAttributes
 */
export interface VoicemailBoxAttributes {
    /**
     * Name of the Voicemail Box.
     * @type {string}
     * @memberof VoicemailBoxAttributes
     */
    name: string;
    /**
     * PIN for accessing the Voicemail Box messages.
     * @type {string}
     * @memberof VoicemailBoxAttributes
     */
    pin: string;
    /**
     * Email addresses for notifications of new voicemails.
     * @type {string}
     * @memberof VoicemailBoxAttributes
     */
    notificationEmails: string;
    /**
     * URL of the current announcement greeting.
     * @type {string}
     * @memberof VoicemailBoxAttributes
     */
    readonly announcementUrl?: string | null;
    /**
     * Status of the Voicemail Box.
     * @type {string}
     * @memberof VoicemailBoxAttributes
     */
    status: VoicemailBoxAttributesStatusEnum;
    /**
     * 
     * @type {number}
     * @memberof VoicemailBoxAttributes
     */
    readonly siteId?: number | null;
    /**
     * 
     * @type {Date}
     * @memberof VoicemailBoxAttributes
     */
    readonly createdAt?: Date;
    /**
     * 
     * @type {Date}
     * @memberof VoicemailBoxAttributes
     */
    readonly updatedAt?: Date;
}


/**
 * @export
 */
export const VoicemailBoxAttributesStatusEnum = {
    Active: 'active',
    Inactive: 'inactive'
} as const;
export type VoicemailBoxAttributesStatusEnum = typeof VoicemailBoxAttributesStatusEnum[keyof typeof VoicemailBoxAttributesStatusEnum];


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

export function VoicemailBoxAttributesFromJSON(json: any): VoicemailBoxAttributes {
    return VoicemailBoxAttributesFromJSONTyped(json, false);
}

export function VoicemailBoxAttributesFromJSONTyped(json: any, ignoreDiscriminator: boolean): VoicemailBoxAttributes {
    if (json == null) {
        return json;
    }
    return {
        
        'name': json['name'],
        'pin': json['pin'],
        'notificationEmails': json['notification_emails'],
        'announcementUrl': json['announcement_url'] == null ? undefined : json['announcement_url'],
        'status': json['status'],
        'siteId': json['site_id'] == null ? undefined : json['site_id'],
        'createdAt': json['created_at'] == null ? undefined : (new Date(json['created_at'])),
        'updatedAt': json['updated_at'] == null ? undefined : (new Date(json['updated_at'])),
    };
}

export function VoicemailBoxAttributesToJSON(json: any): VoicemailBoxAttributes {
    return VoicemailBoxAttributesToJSONTyped(json, false);
}

export function VoicemailBoxAttributesToJSONTyped(value?: Omit<VoicemailBoxAttributes, 'announcement_url'|'site_id'|'created_at'|'updated_at'> | null, ignoreDiscriminator: boolean = false): any {
    if (value == null) {
        return value;
    }

    return {
        
        'name': value['name'],
        'pin': value['pin'],
        'notification_emails': value['notificationEmails'],
        'status': value['status'],
    };
}