data-and-reporting-sdk/src/models/invoiceSearchResponse.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,
  lazy,
  nullable,
  number,
  object,
  optional,
  Schema,
  string,
} from '../schema';
import {
  InvoiceSearchDetails,
  invoiceSearchDetailsSchema,
} from './invoiceSearchDetails';

export interface InvoiceSearchResponse {
  /** API Request Id */
  requestId?: string | null;
  /** Indicates overall status of the request. Allowed values: SUCCES, FAILED */
  status?: string | null;
  data?: InvoiceSearchDetails[];
  /** Specifies the returned page of the results */
  page?: number | null;
  /** Specifies the number of records to be returned which could be less than the PageSize in the request */
  pageSize?: number | null;
  /** Specifies the total records available in the result */
  totalRecords?: number | null;
  /** Specifies the total pages available in the result */
  totalPages?: number | null;
}

export const invoiceSearchResponseSchema: Schema<InvoiceSearchResponse> = object(
  {
    requestId: ['RequestId', optional(nullable(string()))],
    status: ['Status', optional(nullable(string()))],
    data: ['Data', optional(array(lazy(() => invoiceSearchDetailsSchema)))],
    page: ['Page', optional(nullable(number()))],
    pageSize: ['PageSize', optional(nullable(number()))],
    totalRecords: ['TotalRecords', optional(nullable(number()))],
    totalPages: ['TotalPages', optional(nullable(number()))],
  }
);