@ringer-tel/ivy/models/PaginatedForwardListResponse.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 { ForwardResponse } from './ForwardResponse';
import {
    ForwardResponseFromJSON,
    ForwardResponseFromJSONTyped,
    ForwardResponseToJSON,
    ForwardResponseToJSONTyped,
} from './ForwardResponse';
import type { Link } from './Link';
import {
    LinkFromJSON,
    LinkFromJSONTyped,
    LinkToJSON,
    LinkToJSONTyped,
} from './Link';

/**
 * A paginated list of call forwards.
 * @export
 * @interface PaginatedForwardListResponse
 */
export interface PaginatedForwardListResponse {
    /**
     * 
     * @type {Array<ForwardResponse>}
     * @memberof PaginatedForwardListResponse
     */
    forwards: Array<ForwardResponse>;
    /**
     * 
     * @type {number}
     * @memberof PaginatedForwardListResponse
     */
    totalItems: number;
    /**
     * 
     * @type {number}
     * @memberof PaginatedForwardListResponse
     */
    totalPages: number;
    /**
     * 
     * @type {number}
     * @memberof PaginatedForwardListResponse
     */
    currentPage: number;
    /**
     * 
     * @type {number}
     * @memberof PaginatedForwardListResponse
     */
    perPage: number;
    /**
     * 
     * @type {Array<Link>}
     * @memberof PaginatedForwardListResponse
     */
    links?: Array<Link> | null;
}

/**
 * Check if a given object implements the PaginatedForwardListResponse interface.
 */
export function instanceOfPaginatedForwardListResponse(value: object): value is PaginatedForwardListResponse {
    if (!('forwards' in value) || value['forwards'] === undefined) return false;
    if (!('totalItems' in value) || value['totalItems'] === undefined) return false;
    if (!('totalPages' in value) || value['totalPages'] === undefined) return false;
    if (!('currentPage' in value) || value['currentPage'] === undefined) return false;
    if (!('perPage' in value) || value['perPage'] === undefined) return false;
    return true;
}

export function PaginatedForwardListResponseFromJSON(json: any): PaginatedForwardListResponse {
    return PaginatedForwardListResponseFromJSONTyped(json, false);
}

export function PaginatedForwardListResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedForwardListResponse {
    if (json == null) {
        return json;
    }
    return {
        
        'forwards': ((json['forwards'] as Array<any>).map(ForwardResponseFromJSON)),
        'totalItems': json['total_items'],
        'totalPages': json['total_pages'],
        'currentPage': json['current_page'],
        'perPage': json['per_page'],
        'links': json['links'] == null ? undefined : ((json['links'] as Array<any>).map(LinkFromJSON)),
    };
}

export function PaginatedForwardListResponseToJSON(json: any): PaginatedForwardListResponse {
    return PaginatedForwardListResponseToJSONTyped(json, false);
}

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

    return {
        
        'forwards': ((value['forwards'] as Array<any>).map(ForwardResponseToJSON)),
        'total_items': value['totalItems'],
        'total_pages': value['totalPages'],
        'current_page': value['currentPage'],
        'per_page': value['perPage'],
        'links': value['links'] == null ? undefined : ((value['links'] as Array<any>).map(LinkToJSON)),
    };
}