card-management-sdk
Version:
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
49 lines (48 loc) • 2.27 kB
TypeScript
/**
* Shell Card Management APIsLib
*
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { Schema } from '../schema';
import { UpdateCard } from './updateCard';
export interface CardManagementV1UpdatestatusRequest {
/** List of UpdateCardRequest entity. Each card in the list will be updated to the given target status. The details of the entity are given below. */
cards: UpdateCard[];
/**
* Reason id for updating the card status.<br />
* Optional<br />
* Either Reason ID or Text is madatory when TargetStatus is ‘Block’ or ‘Damaged’. Else ignored.<br />
* Possible values:<br />
* -Lost <br />
* -Stolen <br />
* -Card no longer required<br />
* When passed, the reason Id will be validated with the allowed reason ids configured for the card type of the card.<br />
* . If the given reason Id is not allowed for certain card types, then the request will be rejected as invalid ResonId.
*/
reasonId?: number | null;
/**
* Reason text for updating the card status.<br />
* Optional Either Reason ID or Text is madatory when TargetStatus is ‘Block’ or ‘Damaged’. Else ignored.<br />
* Possible values:<br />
* -Lost <br />
* -Stolen <br />
* -Card no longer required <br />
* Optional – However, either Reason ID or Text is madatory when TargetStatus is ‘Block’ or ‘Damaged’.<br />
* When Reason Text is passed and the Target Status is either Block or Damaged, the text will be validated with the allowed list of values configured for the card type of the card.<br />
* If the text is not allowed, request will be rejected as invaid ResonText.<br />
* Note:<br />
* Customer blocked’ will be used as the reason for ‘Temporary Block’.
*/
reasonText?: string | null;
/**
* The list of cards passed in Cards parameter will be updated to this status.<br />
* Mandatory<br />
* Allowed values:<br />
* -TemporaryBlock<br />
* -Unblock<br />
* -Block<br />
* -Damaged<br />
*/
targetStatus: string;
}
export declare const cardManagementV1UpdatestatusRequestSchema: Schema<CardManagementV1UpdatestatusRequest>;