data-and-reporting-sdk/src/models/searchDocumentsResponse.ts

Data And Reporting product consists of API's which provides details of transaction and invoice informations about shell cards. The Shell Card Transaction and Invoice API is REST-based and employs Basic authentication in Version 1 and Oauth authentication

/**
 * Shell Data & Reporting APIsLib
 *
 * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
 */

import {
  array,
  boolean,
  lazy,
  number,
  object,
  optional,
  Schema,
  string,
} from '../schema';
import {
  SearchDocumentsInvoice,
  searchDocumentsInvoiceSchema,
} from './searchDocumentsInvoice';

export interface SearchDocumentsResponse {
  /** UUID (according to RFC 4122 standards) for requests and responses. This will be played back in the response from the request. */
  requestId?: string;
  /** Indicates overall status of the request. Allowed values: SUCCES, FAILED */
  status?: string;
  data?: SearchDocumentsInvoice[];
  /** Total number of elements corresponding to the request */
  totalRecords?: number;
  /** Number of elements in the page content. Will be lesser or equal to the size param. */
  totalRecordsOnPage?: number;
  /** True if it is the first page, false otherwise */
  isFirstPage?: boolean;
  /** True if it is the last page, false, otherwise. */
  isLastPage?: boolean;
}

export const searchDocumentsResponseSchema: Schema<SearchDocumentsResponse> = object(
  {
    requestId: ['RequestId', optional(string())],
    status: ['Status', optional(string())],
    data: ['Data', optional(array(lazy(() => searchDocumentsInvoiceSchema)))],
    totalRecords: ['TotalRecords', optional(number())],
    totalRecordsOnPage: ['TotalRecordsOnPage', optional(number())],
    isFirstPage: ['IsFirstPage', optional(boolean())],
    isLastPage: ['IsLastPage', optional(boolean())],
  }
);