@ringer-tel/ivy/models/ScheduleAttributes.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 ScheduleAttributes
 */
export interface ScheduleAttributes {
    /**
     * A user-friendly name for the schedule.
     * @type {string}
     * @memberof ScheduleAttributes
     */
    name: string;
    /**
     * IANA Timezone Database name (e.g., America/New_York).
     * @type {string}
     * @memberof ScheduleAttributes
     */
    timeZone: string;
    /**
     * Start hour (00-23) for the schedule active period.
     * @type {string}
     * @memberof ScheduleAttributes
     */
    startHour: string;
    /**
     * Start minute (00-59).
     * @type {string}
     * @memberof ScheduleAttributes
     */
    startMinute: string;
    /**
     * End hour (00-23).
     * @type {string}
     * @memberof ScheduleAttributes
     */
    endHour: string;
    /**
     * End minute (00-59).
     * @type {string}
     * @memberof ScheduleAttributes
     */
    endMinute: string;
    /**
     * Weekday when the schedule active period starts.
     * @type {string}
     * @memberof ScheduleAttributes
     */
    startWeekday: string;
    /**
     * Weekday when the schedule active period ends.
     * @type {string}
     * @memberof ScheduleAttributes
     */
    endWeekday: string;
    /**
     * Space-separated list of dates (MM/DD format) when this schedule is inactive.
     * @type {string}
     * @memberof ScheduleAttributes
     */
    exceptions?: string | null;
    /**
     * System code for the destination if the current time falls within the schedule.
     * @type {string}
     * @memberof ScheduleAttributes
     */
    positiveDestinationCode: string;
    /**
     * System code for the destination if the current time falls outside the schedule.
     * @type {string}
     * @memberof ScheduleAttributes
     */
    negativeDestinationCode: string;
}

/**
 * Check if a given object implements the ScheduleAttributes interface.
 */
export function instanceOfScheduleAttributes(value: object): value is ScheduleAttributes {
    if (!('name' in value) || value['name'] === undefined) return false;
    if (!('timeZone' in value) || value['timeZone'] === undefined) return false;
    if (!('startHour' in value) || value['startHour'] === undefined) return false;
    if (!('startMinute' in value) || value['startMinute'] === undefined) return false;
    if (!('endHour' in value) || value['endHour'] === undefined) return false;
    if (!('endMinute' in value) || value['endMinute'] === undefined) return false;
    if (!('startWeekday' in value) || value['startWeekday'] === undefined) return false;
    if (!('endWeekday' in value) || value['endWeekday'] === undefined) return false;
    if (!('positiveDestinationCode' in value) || value['positiveDestinationCode'] === undefined) return false;
    if (!('negativeDestinationCode' in value) || value['negativeDestinationCode'] === undefined) return false;
    return true;
}

export function ScheduleAttributesFromJSON(json: any): ScheduleAttributes {
    return ScheduleAttributesFromJSONTyped(json, false);
}

export function ScheduleAttributesFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScheduleAttributes {
    if (json == null) {
        return json;
    }
    return {
        
        'name': json['name'],
        'timeZone': json['time_zone'],
        'startHour': json['start_hour'],
        'startMinute': json['start_minute'],
        'endHour': json['end_hour'],
        'endMinute': json['end_minute'],
        'startWeekday': json['start_weekday'],
        'endWeekday': json['end_weekday'],
        'exceptions': json['exceptions'] == null ? undefined : json['exceptions'],
        'positiveDestinationCode': json['positive_destination_code'],
        'negativeDestinationCode': json['negative_destination_code'],
    };
}

export function ScheduleAttributesToJSON(json: any): ScheduleAttributes {
    return ScheduleAttributesToJSONTyped(json, false);
}

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

    return {
        
        'name': value['name'],
        'time_zone': value['timeZone'],
        'start_hour': value['startHour'],
        'start_minute': value['startMinute'],
        'end_hour': value['endHour'],
        'end_minute': value['endMinute'],
        'start_weekday': value['startWeekday'],
        'end_weekday': value['endWeekday'],
        'exceptions': value['exceptions'],
        'positive_destination_code': value['positiveDestinationCode'],
        'negative_destination_code': value['negativeDestinationCode'],
    };
}