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

359 lines (355 loc) • 13.9 kB

text/typescript

/** * Shell Card Management APIsLib * * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). */ import { array, boolean, lazy, nullable, number, object, optional, Schema, string, } from '../schema'; import { SearchCard, searchCardSchema } from './searchCard'; /** Encapsulate the Search details request. */ export interface SearchRequest { /** Account ID of the customer. Optional. This input is a search criterion, if given. */ accountId?: number | null; /** Account Number of the customer. Optional. This input is a search criterion, if given. */ accountNumber?: string | null; /** * Card group id. * Optional. * This input is a search criterion, if given. * When -1 is passed, those cards that does not belong to any card group will be returned. */ cardGroupId?: number | null; /** * Card group name. * Optional. * This input is a search criterion, if given. * If CardGroupId is provided then this search criterion will be ignored, else, those cards that have the card group name completely matching with the entered value will be returned. */ cardGroupName?: string | null; /** * Market segment to which card belongs to. * Optional. * Allowed values * • CRT * • Fleet */ cardSegment?: string | null; /** * Status of the card. * Mandatory. * Multiple statuses are allowed to be included in the search criteria. * CardStatus filter accepts either of the two values for each status as described below. However, the output field “StatusDescription” is aligned with second value highlighted in italics. * Below are the possible allowed statuses: * • ACTIVE or Active – Cards at status Active if the IncludeIntermediateStatus flag is true: Active (Block in progress), Active (Cancel in progress), Active (Marked as damaged)), New (Cancel in progress). * • ON_ORDER or New – Cards at status New * • EXPIRED or Expired – Cards at status Expired * • BLOCKED or Blocked Card – Cards at status Block (The result will include all cards having the following intermediate status, if the IncludeIntermediateStatus flag is true: Blocked card (Unblock in progress)) * • TEMP_BLOCKED_CUSTOMER or Temporary Block(Customer) – Cards at status Temporary Blocked By Customer * • TEMP_BLOCKED_SHELL or Temporary Block (Shell) – Cards at Status Temporary Blocked by Shell * • CANCELLED or Cancelled – Cards at status Cancelled * • PENDING_RENEWAL or Pending Renewal - Cards that are in renewal process * • REPLACED or Replaced – Cards at Status Replaced * • FRAUD or Fraud – Cards at Status FRAUD * • ALL */ cardStatus: string[]; /** * ISO code of the card i.e. first 7 digits of the PAN * Optional. */ cardTypeCode?: string | null; /** * Collecting Company Code (Shell Code) of the selected payer. * Optional If ColCo Id or ColCoCountryCode is passed else Mandatory */ colCoCode?: number | null; /** * The 2 character ISO Code for the customer and card owning country. * Optional If ColCoId or ColCoCode is passed else Mandatory. */ colCoCountryCode?: string | null; /** * Collecting Company Id of the selected payer. * Optional If ColCoCode or ColCoCountryCode is passed else Mandatory */ colCoId?: number | null; /** * Cards allowed to used nationally/internationally. * Optional. * Allowed values * -National * -International */ coverage?: string | null; /** * Card Creation Date * Optional * Format: yyyyMMdd */ creationDate?: string | null; /** * Driver Name embossed on the card * Optional * Up to 10 driver names could be passed in the parameter. * Minimum of 4 characters should be provided for each driver name else not considered. * Those cards will be returned when part of the driver name matches with any of the string passed in the list. * Max Length for each Driver name: 50 */ driverName?: string[]; /** * Effective date for the Card * Optional * Format: yyyyMMdd */ effectiveDate?: string | null; /** * Bundle Id for the Card, which needs to be excluded in the response. * Optional */ excludeBundleId?: string | null; /** * Default value is True. * When true, the API will not return cards that are at Cancelled Status in Cards Platform */ excludeCancelledCards?: boolean; /** * Optional * When passed, the API will not return cards that are currently in the Card Group specified */ excludeCardGroupId?: number | null; /** * Optional * When passed, the API will not return cards that are currently in the Card Group specified */ excludeCardGroupName?: string | null; /** * List of SearchCard entity i.e., Card Id or PAN, which needs to be excluded in the response. * Details of the SerachCard entity are given below. */ excludeCards?: SearchCard[]; /** * Default value is False. * When true, the API will not return cards that are at Fraud Status in Cards Platform */ excludeFraudCards?: boolean; /** * Default value is True. * When true, the API will not return cards that are at Pending Renewal Status in Cards Platform */ excludePendingRenewalCards?: boolean; /** * Default value is False. * When true, the API will not return cards that are at Replaced Status in Cards Platform */ excludeReplacedCards?: boolean; /** * Cards active and expiring in given number of days. * Optional * Note: When a value is passed in this parameter, only active cards will be considered while searching. */ expiringInDays?: number | null; /** * Month in which the card is expiring. * Optional. * Format: MMYYYY */ expiryMonth?: string | null; /** * Default value is False, * When the value is True, API will return bundle Id associated with card in response. */ includeBundleDetails?: boolean; /** * List of SearchCard entity i.e., Card Id or PAN, which needs to be included in the response. * Details of the SerachCard entity are given below. */ includeCards?: SearchCard[]; /** * A flag which indicates if the response can contain intermediate statuses. * Optional * Default: false */ includeIntermediateStatus?: boolean; /** * If provided, only list cards issued after the given date * Optional * Format: yyyyMMdd * Note: Clients to convert this to appropriate DateTime type. */ issuedAfter?: string | null; /** * Cards allowed to be used in site. * Optional. * Allowed values * -ShellSitesOnly * -PartnersSitesIncluded */ network?: string | null; /** * Last digits of the PAN number * Minimum 4 last digits of the card should be sent for this field to be considered as part of the search criteria. * Optional * Max Length: 50 */ pANEndsWith?: string | null; /** * Payer Id (i.e. Customer Id of the Payment Customer) of the selected payer. * Optional if PayerNumber is passed else Mandatory * Example: 123456 */ payerId?: number | null; /** * Payer Number of the selected payer. * Optional if PayerId is passed else Mandatory */ payerNumber?: string | null; /** * Purchase category code of the card. * Optional. */ purchaseCategoryCode?: string | null; /** * Possible options are: * 1.ExpiringDateAscending * 2.ExpiringDateDescending * 3.DriverNameAscending(If Driver Name is null then VRN value will be considered) * 4.DriverNameDescending(If Driver Name is null then VRN value will be considered) * 5.VRNAscending(If VRN is null then Driver Name value will be considered) * 6.VRNDescending(If VRN is null then Driver Name value will be considered) * 7.LastUsedDateAscending * 8.LastUsedDateDescending * 9.IssueDateAscending * 10.IssueDateDescending * 11.PurchaseCategoryCodeAscending * 12.PurchaseCategoryCodeDescending * 13.CardSegmentAscending (CRT will appear first) * 14.CardSegmentDescending (Fleet will appear first) * Optional */ sortOrder?: string | null; /** * A flag which indicates if the response can contain scheduled card blocks details * Optional * Default: false */ includeScheduledCardBlocks?: boolean; /** * Token Type ID for the Card * Optional */ tokenTypeID?: number | null; /** * Token Type name for the Card * Optional */ tokenTypeName?: string | null; /** * Vehicle Registration embossed on the card * Optional * Up to 10 vehicle registration numbers could be passed in the parameter. * Minimum of 4 characters should be provided for each VRN else not considered * Those cards will be returned when part of the VRN matches with any of the string passed in the list. * Max Length for each VRN: 50 */ vehicleRegistrationNumber?: string[]; /** * Default Value: False * When this field is set to True, cards with below status 2 years (configurable) ago and earlier are excluded from the result * -Blocked Card * -Expired * -Cancelled * -Suspended * -Blocked * -Expired and Cancelled * -Replaced * -Replaced By * -Closed * -Fraud */ excludeOldCards?: boolean; /** * Default value is False. * When true, the API will not return cards that are expiring * within 120 (i.e. Configured) days, if the status of the card is 1 or 41 or 42 in Cards platform. */ excludeExpiringCards?: boolean; /** Customer reference number of the card. */ clientReferenceId?: string | null; /** * Default Value: All * Optional * This option is used to filter the list of cards with ‘ReissueSetting’. * If ‘True’, the API will return cards with ReIssueSetting value is true. * If ‘False’, the API will return cards with ReIsssueSetting value is false. * If ‘ALL’, API will return cards with ReIssueSetting value True & False both. * Allowed Values: * 1. All * 2. True * 3. False */ reissueSetting?: string | null; requestId?: string; } export const searchRequestSchema: Schema<SearchRequest> = object({ accountId: ['AccountId', optional(nullable(number()))], accountNumber: ['AccountNumber', optional(nullable(string()))], cardGroupId: ['CardGroupId', optional(nullable(number()))], cardGroupName: ['CardGroupName', optional(nullable(string()))], cardSegment: ['CardSegment', optional(nullable(string()))], cardStatus: ['CardStatus', array(string())], cardTypeCode: ['CardTypeCode', optional(nullable(string()))], colCoCode: ['ColCoCode', optional(nullable(number()))], colCoCountryCode: ['ColCoCountryCode', optional(nullable(string()))], colCoId: ['ColCoId', optional(nullable(number()))], coverage: ['Coverage', optional(nullable(string()))], creationDate: ['CreationDate', optional(nullable(string()))], driverName: ['DriverName', optional(array(string()))], effectiveDate: ['EffectiveDate', optional(nullable(string()))], excludeBundleId: ['ExcludeBundleId', optional(nullable(string()))], excludeCancelledCards: ['ExcludeCancelledCards', optional(boolean())], excludeCardGroupId: ['ExcludeCardGroupId', optional(nullable(number()))], excludeCardGroupName: ['ExcludeCardGroupName', optional(nullable(string()))], excludeCards: ['ExcludeCards', optional(array(lazy(() => searchCardSchema)))], excludeFraudCards: ['ExcludeFraudCards', optional(boolean())], excludePendingRenewalCards: [ 'ExcludePendingRenewalCards', optional(boolean()), ], excludeReplacedCards: ['ExcludeReplacedCards', optional(boolean())], expiringInDays: ['ExpiringInDays', optional(nullable(number()))], expiryMonth: ['ExpiryMonth', optional(nullable(string()))], includeBundleDetails: ['IncludeBundleDetails', optional(boolean())], includeCards: ['IncludeCards', optional(array(lazy(() => searchCardSchema)))], includeIntermediateStatus: ['IncludeIntermediateStatus', optional(boolean())], issuedAfter: ['IssuedAfter', optional(nullable(string()))], network: ['Network', optional(nullable(string()))], pANEndsWith: ['PANEndsWith', optional(nullable(string()))], payerId: ['PayerId', optional(nullable(number()))], payerNumber: ['PayerNumber', optional(nullable(string()))], purchaseCategoryCode: ['PurchaseCategoryCode', optional(nullable(string()))], sortOrder: ['SortOrder', optional(nullable(string()))], includeScheduledCardBlocks: [ 'IncludeScheduledCardBlocks', optional(boolean()), ], tokenTypeID: ['TokenTypeID', optional(nullable(number()))], tokenTypeName: ['TokenTypeName', optional(nullable(string()))], vehicleRegistrationNumber: [ 'VehicleRegistrationNumber', optional(array(string())), ], excludeOldCards: ['ExcludeOldCards', optional(boolean())], excludeExpiringCards: ['ExcludeExpiringCards', optional(boolean())], clientReferenceId: ['ClientReferenceId', optional(nullable(string()))], reissueSetting: ['ReissueSetting', optional(nullable(string()))], requestId: ['RequestId', optional(string())], });