card-management-sdk/src/models/cardSearchResponse.ts

The Shell Card Management API is REST-based and employs OAUTH 2.0,Basic and ApiKey authentication. The API endpoints accept JSON-encoded request bodies, return JSON-encoded responses and use standard HTTP response codes. All resources are located in the S

/**
 * Shell Card Management 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.js';
import { Card, cardSchema } from './card.js';

export interface CardSearchResponse {
  /** Unique request identifier passed from end user. This identifier helps in tracing a transaction */
  requestId?: string | null;
  /** Indicates overall status of the request. Allowed values: SUCCES, FAILED, PARTIAL_SUCCES */
  status?: string | null;
  data?: Card[];
  /** Specifies the returned page of the results */
  page?: number;
  /** Specifies the number of records to be returned which could be less than the PageSize in the request */
  pageSize?: number;
  /** Specifies the total pages available in the result */
  totalPages?: number;
  /** Specifies the total pages available in the result */
  totalRecords?: number;
}

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