cwmsjs/src/models/RatingSpecs.ts

CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps

/* tslint:disable */
/* eslint-disable */
/**
 * CWMS Data API
 * CWMS REST API for Data Retrieval
 *
 * The version of the OpenAPI document: 2.3.2-2025.03.19
 * 
 *
 * 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 { RatingSpec } from './RatingSpec';
import {
    RatingSpecFromJSON,
    RatingSpecFromJSONTyped,
    RatingSpecToJSON,
} from './RatingSpec';

/**
 * 
 * @export
 * @interface RatingSpecs
 */
export interface RatingSpecs {
    /**
     * The cursor to the next page of data; null if there is no more data
     * @type {string}
     * @memberof RatingSpecs
     */
    readonly nextPage?: string;
    /**
     * The cursor to the current page of data
     * @type {string}
     * @memberof RatingSpecs
     */
    readonly page?: string;
    /**
     * The number of records fetched per-page; this may be larger than the number of records actually retrieved
     * @type {number}
     * @memberof RatingSpecs
     */
    readonly pageSize?: number;
    /**
     * 
     * @type {Array<RatingSpec>}
     * @memberof RatingSpecs
     */
    specs?: Array<RatingSpec>;
    /**
     * The total number of records retrieved; null or not present if not supported or unknown
     * @type {number}
     * @memberof RatingSpecs
     */
    readonly total?: number;
}

/**
 * Check if a given object implements the RatingSpecs interface.
 */
export function instanceOfRatingSpecs(value: object): boolean {
    return true;
}

export function RatingSpecsFromJSON(json: any): RatingSpecs {
    return RatingSpecsFromJSONTyped(json, false);
}

export function RatingSpecsFromJSONTyped(json: any, ignoreDiscriminator: boolean): RatingSpecs {
    if (json == null) {
        return json;
    }
    return {
        
        'nextPage': json['next-page'] == null ? undefined : json['next-page'],
        'page': json['page'] == null ? undefined : json['page'],
        'pageSize': json['page-size'] == null ? undefined : json['page-size'],
        'specs': json['specs'] == null ? undefined : ((json['specs'] as Array<any>).map(RatingSpecFromJSON)),
        'total': json['total'] == null ? undefined : json['total'],
    };
}

export function RatingSpecsToJSON(value?: RatingSpecs | null): any {
    if (value == null) {
        return value;
    }
    return {
        
        'specs': value['specs'] == null ? undefined : ((value['specs'] as Array<any>).map(RatingSpecToJSON)),
    };
}