/*!
 * @license
 * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
 */

import { PaginationLinks } from './PaginationLinks';

/**
 * The response data list with associated pagination links.
 * @export
 * @interface PaginationResponse
 */
export interface PaginationResponse<T> {
  /**
   * The pagination links.
   * @type {PaginationLinks}
   * @memberof PaginationResponse
   */
  links: PaginationLinks;

  /**
   * The list of settings.
   * @type {Array<T>}
   * @memberof PaginationResponse
   */
  data: Array<T>;
}

/**
 * The formatted response for a list of paginated items.
 * @export
 * @interface PaginationFormattedResponse
 */
export interface PaginationFormattedResponse<T> {
  /**
   * The list of items that matched the query.
   * @type {Array<T>}
   * @memberof PaginationFormattedResponse
   */
  data: Array<T>;

  /**
   * The pagination links for the response.
   * @type {PaginationLinks}
   * @memberof PaginationFormattedResponse
   */
  links?: PaginationLinks;
}