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

www.shell.com

sdks-io/card-management-js-sdk

198 lines (197 loc) • 8.78 kB

TypeScript

/** * Shell Card Management APIsLib * * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). */ import { Schema } from '../schema'; import { CardBlockSchedule } from './cardBlockSchedule'; export interface Card { /** Account ID */ accountId?: number | null; /** Account Name */ accountName?: string | null; /** Account Number */ accountNumber?: string | null; /** Account Short Name */ accountShortName?: string | null; /** * Bundle Id associated with card in the Gateway. * This field will have null value if the card is not associated with any bundle in Gateway or the value of IncludeBundleDetails in request is false. */ bundleId?: string | null; /** * List of Scheduled Card Blocks details * Entity: CardBlockSchedule */ cardBlockSchedules?: CardBlockSchedule[]; /** Card group ID */ cardGroupId?: number | null; /** Card group name */ cardGroupName?: string | null; /** Unique Card Id */ cardId?: number | null; /** ISO code of the card i.e. first 7 digits of the PAN */ cardTypeCode?: string | null; /** * Card Type ID Example Id and Description: 1 -Philippines CRT 7077861 2-Philippines * Fleet 7002861 5-SHELL FLEET-HONG KONG 7002821 6-SHELL NHF- HONG KONG 7002821 7-SHELL CRT- HONG KONG 7077821 */ cardTypeId?: number | null; /** * Card Type Name Example Id and Description: 1-Philippines CRT 7077861 2-Philippines * Fleet 7002861 5-SHELL FLEET- HONG KONG 7002821 6-SHELL NHF- HONG KONG 7002821 7-SHELL CRT- HONG KONG 7077821 */ cardTypeName?: string | null; /** * The 2 character ISO Code for the customer and card owning country. * If default card type is not set then the first two alphabets of the account ID is returned. */ colCoCountryCode?: string | null; /** * Card Creation datetime. * Format: yyyyMMdd HH:mm:ss * Note: Clients to convert this to appropriate DateTime type. */ creationDate?: string | null; /** Driver name */ driverName?: string | null; /** * Effective date for the Card * Format: yyyyMMdd * Note: Clients to convert this to appropriate DateTime type. */ effectiveDate?: string | null; /** * Expiry date of the card. * Format: yyyyMMdd * Note: Clients to convert this to appropriate DateTime type. */ expiryDate?: string | null; /** True/False True if fleet id input is enabled, else false */ fleetIdInput?: boolean; /** True/False True if it is a CRT type card, else false */ isCRT?: boolean; /** True/False True if it is a Fleet type card, else false */ isFleet?: boolean; /** True/False True if it is an international card, else false */ isInternational?: boolean; /** True/False True if it is a national card, else false */ isNational?: boolean; /** True/False True if it is allowed at all partner sites, else false */ isPartnerSitesIncluded?: boolean; /** True/False True if it is only allowed at Shell sites, else false */ isShellSitesOnly?: boolean; /** * Issue date * Format: yyyyMMdd * Note: Clients to convert this to appropriate DateTime type. */ issueDate?: string | null; /** True/False True if a new card is issued with the same PAN, else false. */ isSuperseded?: boolean; /** True/False True if it is a virtual card, else false */ isVirtualCard?: boolean; /** * Card last modified date and time * Format: yyyyMMdd HH:mm:ss * Note: Clients to convert this to appropriate DateTime type. */ lastModifiedDate?: string | null; /** * Card last used date . * Note: last used date of a card will be calculated based on billed/unbilled sales items * of a given card.The query that extracts the last used dates will be applied on the * subset of the cards being returned to the client.Unbilled sales items is checked * first and for those not found in the unbilled table, sales items will be checked * (only when the last used date is not found in unbilled table for at least a single * card from the result). The transactions in last 48 hours are not expected to be * Therefore this field gives the correct information up to 48 hours early. * Format: yyyyMMdd HH:mm:ss * Note: Clients to convert this to appropriate DateTime type */ lastUsedDate?: string | null; /** ISO code of the local currency. */ localCurrencyCode?: string | null; /** Local currency symbol. */ localCurrencySymbol?: string | null; /** True/False True if odometer input is enabled on the card, else false */ odometerInput?: boolean; /** Card PAN */ pAN?: string | null; /** Card PAN Mask PAN (Mask all digits except the Last 6 digits of the PAN) */ maskedPAN?: string; /** Card PAN ID. */ pANID?: number; /** Purchase category code */ purchaseCategoryCode?: string | null; /** * Purchase category Id * Note: Not Purchase code. */ purchaseCategoryId?: number | null; /** Purchase category name */ purchaseCategoryName?: string | null; /** Card Status reason Example: Lost Stolen Card no longer required */ reason?: string | null; /** * Reissue setting of the card. If the card is superseded (i.e. a replacement/new card is issued) then reissue setting of the latest card issued. * Values * •True –Card will be Reissued when nearing its expiry date * •False –Card will not be Reissued */ reissueSetting?: string | null; /** * Status Description (Active, Temporarily Blocked, etc.,) * Possible Ids and description: 1 Active 7 Blocked Card 8 Expired 9 Cancelled 10 New 23 Pending Renewal 31 Replaced 41 * Temporary Block(Customer) 42 Temporary Block(Shell) 43 Fraud 101 Active(Block in progress) * * 102 Blocked Card(Unblock in progress) * * 103 Active(Cancel in progress) * * 104 Active(Marked as damaged) * * 105 New(Cancel in progress) * * 106 { Status}(Scheduled for block) * * 107 { Status}(Scheduled for unblock) * *# Note: Items marked with* are intermediate statuses to indicate that there are pending requests in progress. * The response can contain these intermediate statuses only if the * IncludeIntermediateStatus flag is true. The placeholder { Status} in the items * marked with # will be replaced with the status description. E.g., Active (Scheduled for block) */ statusDescription?: string | null; /** * Card Status id Possible Ids and description: 1 Active 7 Blocked Card 8 Expired 9 Cancelled 10 New 23 Pending Renewal 31 Replaced 41 Temporary Block(Customer) 42 * Temporary Block(Shell) 43 Fraud 101 Active(Block in progress) * * 102 Blocked Card(Unblock in progress) * * 103 Active(Cancel in progress) * * 104 Active(Marked as damaged) * * 105 New(Cancel in progress) * * 106 { Status}(Scheduled for block) * # 107 {Status}(Scheduled for unblock) * *# Note: Items marked with* are intermediate statuses to indicate that there are pending requests in progress. * The response can contain these intermediate statuses only if the IncludeIntermediateStatus flag is true. * The placeholder { Status} in the items marked with # will be replaced with * the status description. E.g., Active (Scheduled for block) */ statusId?: number | null; /** Token Type ID configured for the Card E.g. 107 */ tokenTypeID?: number | null; /** Token Type Name configured for the Card */ tokenTypeName?: string; /** Vehicle registration number */ vRN?: string | null; /** Customer reference number of the card. */ clientReferenceId?: string | null; /** Is Europay, MasterCard, and Visa Contact enabled or not. */ isEMVContact?: boolean; /** Is Europay, MasterCard, and Visa Contactless enabled or not. */ isEMVContactless?: boolean; /** Whether the card type is enabled for RFID (Radio Frequency Identification) */ isRFID?: boolean; /** RFIDUID */ rFIDUID?: string | null; /** EMAID */ eMAID?: string | null; /** EV Printed Number */ eVPrintedNumber?: string | null; /** Card Media Code. */ cardMediaCode?: string | null; } export declare const cardSchema: Schema<Card>;