card-management-sdk/src/models/updateCard.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 {
  boolean,
  lazy,
  nullable,
  number,
  object,
  optional,
  Schema,
  string,
} from '../schema';
import { CardSettings, cardSettingsSchema } from './cardSettings';

/** Request entity object for UpdateCardRequest  list */
export interface UpdateCard {
  /**
   * The caller to be notified with the status of the update card status request. <br />
   * The caller will also be notified with the status of the replacement card order request, if any.<br />
   * Mandatory, if NotifyCaller is true. <br />
   * Maximum field length: 20<br />
   * Allowed values:<br />
   * - NextGenUI: This value to be used by next gen UI application.<br />
   * - Motix: This value to be used by MOTiX application.<br />
   * - FleetHubUILifeTime: This value to be used by Fleet Hub UI application for life time restriction cards.<br />
   * Note: The values passed in this field are case insensitive.
   */
  caller?: string | null;
  /**
   * True/False<br />
   * Optional<br />
   * When not provided will considered as default value as True.<br />
   * If passed True, the replacement card will be chargeable, else replacement card will not be charged.
   */
  isReplacementChargeable?: boolean;
  /**
   * True/False.<br />
   * Optional.<br />
   * Default: False<br />
   * If true, the caller would be notified back with the status as success or failure after the update card status request is processed.
   * Notification API subscription required to use this feature , please refer API documetation for more details
   */
  notifyCaller?: boolean;
  /**
   * True/False.<br />
   * Optional.<br />
   * Default: False<br />
   * If true, the caller would be notified back with the status as success or failed after the replacement card is synced with Gateway, if a replacement card was requested.
   */
  notifyCallerOnSync?: boolean;
  /**
   * True/False.<br />
   * Pass True if a replacement order card request is to be placed, else False.<br />
   * Optional.Default value False.<br />
   * Replacement of a card is only applicable when the target status requested is either permanently Block or Damaged for the existing card.<br />
   * Request for Replacement card will be placed only when the Block card or Block damaged card request is successfully placed.<br />
   * The Replacement card request will be processed only when the permanent Block card request is successfully processed. <br />
   * In case of damaged card request, the replacement card request will be processed immediately.
   */
  orderCardReplacement?: boolean;
  cardSettings?: CardSettings;
  /**
   * Account Id of the customer.<br />
   * Optional if AccountNumber is passed, else Mandatory.
   */
  accountId?: number | null;
  /**
   * Account Number of the customer.<br />
   * Optional if AccountId is passed, else Mandatory.
   */
  accountNumber?: string | null;
  /**
   * Expiry date of the card.<br />
   * Mandatory if PAN is passed, else optional.<br />
   * Format: yyyyMMdd
   */
  cardExpiryDate?: string | null;
  /**
   * Card Id of the card.<br />
   * Optional if PAN is passed, else Mandatory.
   */
  cardId?: number | null;
  /**
   * Collecting company code of the customer. <br />
   * Optional if ColCoId is passed, else Mandatory.<br />
   */
  colCoCode?: number | null;
  /**
   * Collecting company id of the customer. <br />
   * Optional if ColCoCode is passed, else Mandatory.<br />
   */
  colCoId?: number | null;
  /**
   * PAN of the card.<br />
   * Optional if CardId is passed, else Mandatory.<br />
   */
  pAN?: string | null;
  /** PANID of the card */
  pANID?: number | null;
  /**
   * Payer id of the customer.<br />
   * Optional if PayerNumber is passed, else Mandatory.
   */
  payerId?: number | null;
  /**
   * PayerNumber of the customer.<br />
   * Optional if PayerId is passed, else Mandatory.
   */
  payerNumber?: string | null;
}

export const updateCardSchema: Schema<UpdateCard> = object({
  caller: ['Caller', optional(nullable(string()))],
  isReplacementChargeable: ['IsReplacementChargeable', optional(boolean())],
  notifyCaller: ['NotifyCaller', optional(boolean())],
  notifyCallerOnSync: ['NotifyCallerOnSync', optional(boolean())],
  orderCardReplacement: ['OrderCardReplacement', optional(boolean())],
  cardSettings: ['CardSettings', optional(lazy(() => cardSettingsSchema))],
  accountId: ['AccountId', optional(nullable(number()))],
  accountNumber: ['AccountNumber', optional(nullable(string()))],
  cardExpiryDate: ['CardExpiryDate', optional(nullable(string()))],
  cardId: ['CardId', optional(nullable(number()))],
  colCoCode: ['ColCoCode', optional(nullable(number()))],
  colCoId: ['ColCoId', optional(nullable(number()))],
  pAN: ['PAN', optional(nullable(string()))],
  pANID: ['PANID', optional(nullable(number()))],
  payerId: ['PayerId', optional(nullable(number()))],
  payerNumber: ['PayerNumber', optional(nullable(string()))],
});