card-management-sdk/src/models/cancelCardResponse.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,
  number,
  object,
  optional,
  Schema,
  string,
} from '../schema.js';
import { ErrorDetails, errorDetailsSchema } from './errorDetails.js';
import { SubmittedCard, submittedCardSchema } from './submittedCard.js';

export interface CancelCardResponse {
  /** Unique request identifier passed from end user. This identifier helps in tracing a transaction */
  requestId?: string;
  /** Cancel card reference number for tracking the execution of the request. */
  mainReference?: number;
  /** Order replacement reference number for tracking the execution of the order replacement cards request. */
  orderReplacementReference?: number;
  /** Indicates overall status of the request. Allowed values: SUCCESS, FAILED, PARTIAL_SUCCESS */
  status?: string;
  data?: SubmittedCard[];
  errors?: ErrorDetails[];
}

export const cancelCardResponseSchema: Schema<CancelCardResponse> = lazy(() =>
  object({
    requestId: ['RequestId', optional(string())],
    mainReference: ['MainReference', optional(number())],
    orderReplacementReference: [
      'OrderReplacementReference',
      optional(number()),
    ],
    status: ['Status', optional(string())],
    data: ['Data', optional(array(submittedCardSchema))],
    errors: ['Errors', optional(array(errorDetailsSchema))],
  })
);