@ringer-tel/ivy/src/models/ModelError.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 { ErrorDetailsInner } from './ErrorDetailsInner';
import {
    ErrorDetailsInnerFromJSON,
    ErrorDetailsInnerFromJSONTyped,
    ErrorDetailsInnerToJSON,
    ErrorDetailsInnerToJSONTyped,
} from './ErrorDetailsInner';

/**
 * Standard error response format.
 * @export
 * @interface ModelError
 */
export interface ModelError {
    /**
     * A general status indicator for the error.
     * @type {string}
     * @memberof ModelError
     */
    status: string;
    /**
     * A human-readable description of the error.
     * @type {string}
     * @memberof ModelError
     */
    error: string;
    /**
     * A machine-parsable error code specific to this error condition.
     * @type {string}
     * @memberof ModelError
     */
    errorCode: string;
    /**
     * Optional. An array containing more specific error details.
     * @type {Array<ErrorDetailsInner>}
     * @memberof ModelError
     */
    details?: Array<ErrorDetailsInner> | null;
}

/**
 * Check if a given object implements the ModelError interface.
 */
export function instanceOfModelError(value: object): value is ModelError {
    if (!('status' in value) || value['status'] === undefined) return false;
    if (!('error' in value) || value['error'] === undefined) return false;
    if (!('errorCode' in value) || value['errorCode'] === undefined) return false;
    return true;
}

export function ModelErrorFromJSON(json: any): ModelError {
    return ModelErrorFromJSONTyped(json, false);
}

export function ModelErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelError {
    if (json == null) {
        return json;
    }
    return {
        
        'status': json['status'],
        'error': json['error'],
        'errorCode': json['error_code'],
        'details': json['details'] == null ? undefined : ((json['details'] as Array<any>).map(ErrorDetailsInnerFromJSON)),
    };
}

export function ModelErrorToJSON(json: any): ModelError {
    return ModelErrorToJSONTyped(json, false);
}

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

    return {
        
        'status': value['status'],
        'error': value['error'],
        'error_code': value['errorCode'],
        'details': value['details'] == null ? undefined : ((value['details'] as Array<any>).map(ErrorDetailsInnerToJSON)),
    };
}