card-management-sdk/src/models/cardGroupRequest.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,
  nullable,
  number,
  object,
  optional,
  Schema,
  string,
} from '../schema.js';
import { Accounts, accountsSchema } from './accounts.js';

export interface CardGroupRequest {
  /**
   * Collecting Company Id of the selected payer.
   * Optional if ColCoCode is passed else Mandatory.
   * Example:
   * 1 for Philippines
   * 5 for UK
   */
  colCoId?: number | null;
  /**
   * Collecting Company Code (Shell Code) of the selected payer.
   * Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia, Ukraine etc. It is optional for other countries if ColCoID is provided.
   * Example:
   * 86 for Philippines
   * 5 for UK
   */
  colCoCode?: number | null;
  /**
   * Payer id of the customer.
   * Optional if PayerNumber is passed, else Mandatory.
   * This input is a search criterion.
   * Example: 123456
   */
  payerId?: number | null;
  /**
   * PayerNumber of the customer.
   * Optional if PayerId is passed, else Mandatory.
   * This input is a search criterion.
   * Example: GB00123456
   */
  payerNumber?: string | null;
  account?: Accounts[];
  /**
   * Card Group Name
   * Optional.
   * Minimum of 2 characters should be provided else not considered.
   * CardGroups those have the entered value at any part
   */
  cardGroupName?: string | null;
  /**
   * Card Group Status
   * Mandatory
   * Allowed values:
   * •    ALL
   * •    TERMINATED
   * •    ACTIVE
   */
  status?: string | null;
}

export const cardGroupRequestSchema: Schema<CardGroupRequest> = lazy(() =>
  object({
    colCoId: ['ColCoId', optional(nullable(number()))],
    colCoCode: ['ColCoCode', optional(nullable(number()))],
    payerId: ['PayerId', optional(nullable(number()))],
    payerNumber: ['PayerNumber', optional(nullable(string()))],
    account: ['Account', optional(array(accountsSchema))],
    cardGroupName: ['CardGroupName', optional(nullable(string()))],
    status: ['Status', optional(nullable(string()))],
  })
);