@ringer-tel/ivy/models/RingGroupUpdateRequest.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';
/**
 * Attributes for updating a ring group. Only provide fields to be changed.
 * @export
 * @interface RingGroupUpdateRequest
 */
export interface RingGroupUpdateRequest {
    /**
     * 
     * @type {string}
     * @memberof RingGroupUpdateRequest
     */
    name?: string | null;
    /**
     * 
     * @type {Array<string>}
     * @memberof RingGroupUpdateRequest
     */
    destinationCodes?: Array<string> | null;
    /**
     * 
     * @type {string}
     * @memberof RingGroupUpdateRequest
     */
    ringStrategy?: RingGroupUpdateRequestRingStrategyEnum | null;
    /**
     * 
     * @type {number}
     * @memberof RingGroupUpdateRequest
     */
    timeout?: number | null;
    /**
     * 
     * @type {string}
     * @memberof RingGroupUpdateRequest
     */
    failOverDestinationCode?: string | null;
    /**
     * Optional. Identifier of a user primarily associated with this ring group.
     * @type {number}
     * @memberof RingGroupUpdateRequest
     */
    userId?: number | null;
}


/**
 * @export
 */
export const RingGroupUpdateRequestRingStrategyEnum = {
    Simultaneous: 'simultaneous',
    Sequential: 'sequential',
    Random: 'random'
} as const;
export type RingGroupUpdateRequestRingStrategyEnum = typeof RingGroupUpdateRequestRingStrategyEnum[keyof typeof RingGroupUpdateRequestRingStrategyEnum];


/**
 * Check if a given object implements the RingGroupUpdateRequest interface.
 */
export function instanceOfRingGroupUpdateRequest(value: object): value is RingGroupUpdateRequest {
    return true;
}

export function RingGroupUpdateRequestFromJSON(json: any): RingGroupUpdateRequest {
    return RingGroupUpdateRequestFromJSONTyped(json, false);
}

export function RingGroupUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RingGroupUpdateRequest {
    if (json == null) {
        return json;
    }
    return {
        
        'name': json['name'] == null ? undefined : json['name'],
        'destinationCodes': json['destination_codes'] == null ? undefined : json['destination_codes'],
        'ringStrategy': json['ring_strategy'] == null ? undefined : json['ring_strategy'],
        'timeout': json['timeout'] == null ? undefined : json['timeout'],
        'failOverDestinationCode': json['fail_over_destination_code'] == null ? undefined : json['fail_over_destination_code'],
        'userId': json['user_id'] == null ? undefined : json['user_id'],
    };
}

export function RingGroupUpdateRequestToJSON(json: any): RingGroupUpdateRequest {
    return RingGroupUpdateRequestToJSONTyped(json, false);
}

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

    return {
        
        'name': value['name'],
        'destination_codes': value['destinationCodes'],
        'ring_strategy': value['ringStrategy'],
        'timeout': value['timeout'],
        'fail_over_destination_code': value['failOverDestinationCode'],
        'user_id': value['userId'],
    };
}