data-and-reporting-sdk/src/models/eIDDocument.ts

Data And Reporting product consists of API's which provides details of transaction and invoice informations about shell cards. The Shell Card Transaction and Invoice API is REST-based and employs Basic authentication in Version 1 and Oauth authentication

/**
 * Shell Data & Reporting APIsLib
 *
 * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
 */

import { nullable, number, object, optional, Schema, string } from '../schema';

export interface EIDDocument {
  /** Technical identifier for the EID file. Should not be stored in database as it is not guaranteed to stay unchanged over time. */
  documentId?: number | null;
  /** Account Group Id */
  accountGroupId?: string | null;
  /** Account group name */
  accountGroupName?: string | null;
  /**
   * Document type.
   * Possible values:
   * •    NAT (National)
   * •    INT (International)
   */
  documentType?: string | null;
  /** Document format (CHORUS, DIFI etc.) */
  documentFormat?: string | null;
  /**
   * Document date.
   * Example: 20170101
   */
  documentDate?: string | null;
  /** Number of invoices */
  numberOfInvoices?: number | null;
  /** Document size */
  fileSize?: number | null;
  /**
   * Document status.
   * Possible values:
   * •    NEW
   * •    VIEWED
   * •    DOWNLOADED
   * •    RESTORED
   */
  documentStatus?: string | null;
  /** Document file name. */
  documentName?: string | null;
}

export const eIDDocumentSchema: Schema<EIDDocument> = object({
  documentId: ['DocumentId', optional(nullable(number()))],
  accountGroupId: ['AccountGroupId', optional(nullable(string()))],
  accountGroupName: ['AccountGroupName', optional(nullable(string()))],
  documentType: ['DocumentType', optional(nullable(string()))],
  documentFormat: ['DocumentFormat', optional(nullable(string()))],
  documentDate: ['DocumentDate', optional(nullable(string()))],
  numberOfInvoices: ['NumberOfInvoices', optional(nullable(number()))],
  fileSize: ['FileSize', optional(nullable(number()))],
  documentStatus: ['DocumentStatus', optional(nullable(string()))],
  documentName: ['DocumentName', optional(nullable(string()))],
});