@ringer-tel/ivy/models/ScheduleResponseDataAttributes.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 { SiteDestination } from './SiteDestination';
import {
    SiteDestinationFromJSON,
    SiteDestinationFromJSONTyped,
    SiteDestinationToJSON,
    SiteDestinationToJSONTyped,
} from './SiteDestination';

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

/**
 * Check if a given object implements the ScheduleResponseDataAttributes interface.
 */
export function instanceOfScheduleResponseDataAttributes(value: object): value is ScheduleResponseDataAttributes {
    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 ScheduleResponseDataAttributesFromJSON(json: any): ScheduleResponseDataAttributes {
    return ScheduleResponseDataAttributesFromJSONTyped(json, false);
}

export function ScheduleResponseDataAttributesFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScheduleResponseDataAttributes {
    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'],
        'siteId': json['site_id'] == null ? undefined : json['site_id'],
        'positiveDestination': json['positive_destination'] == null ? undefined : SiteDestinationFromJSON(json['positive_destination']),
        'negativeDestination': json['negative_destination'] == null ? undefined : SiteDestinationFromJSON(json['negative_destination']),
    };
}

export function ScheduleResponseDataAttributesToJSON(json: any): ScheduleResponseDataAttributes {
    return ScheduleResponseDataAttributesToJSONTyped(json, false);
}

export function ScheduleResponseDataAttributesToJSONTyped(value?: ScheduleResponseDataAttributes | 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'],
        'site_id': value['siteId'],
        'positive_destination': SiteDestinationToJSON(value['positiveDestination']),
        'negative_destination': SiteDestinationToJSON(value['negativeDestination']),
    };
}