cwmsjs/src/models/Catalog.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 { CatalogEntry } from './CatalogEntry';
import {
    CatalogEntryFromJSON,
    CatalogEntryFromJSONTyped,
    CatalogEntryToJSON,
} from './CatalogEntry';

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

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

export function CatalogFromJSON(json: any): Catalog {
    return CatalogFromJSONTyped(json, false);
}

export function CatalogFromJSONTyped(json: any, ignoreDiscriminator: boolean): Catalog {
    if (json == null) {
        return json;
    }
    return {
        
        'entries': json['entries'] == null ? undefined : ((json['entries'] as Array<any>).map(CatalogEntryFromJSON)),
        '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'],
        'total': json['total'] == null ? undefined : json['total'],
    };
}

export function CatalogToJSON(value?: Catalog | null): any {
    if (value == null) {
        return value;
    }
    return {
        
        'entries': value['entries'] == null ? undefined : ((value['entries'] as Array<any>).map(CatalogEntryToJSON)),
    };
}