wp-apimatic 1.0.2

package/src/models/creditTransactionDetails.ts

@@ -0,0 +1,159 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  lazy,
+  number,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+import { Aci, aciSchema } from './aci.js';
+import {
+  AuthorizationCurrency,
+  authorizationCurrencySchema,
+} from './authorizationCurrency.js';
+import {
+  AuthorizationSource,
+  authorizationSourceSchema,
+} from './authorizationSource.js';
+import { AvsResponseCode, avsResponseCodeSchema } from './avsResponseCode.js';
+import { CardholderId, cardholderIdSchema } from './cardholderId.js';
+import { EntryMode, entryModeSchema } from './entryMode.js';
+import {
+  MailPhoneIndicator,
+  mailPhoneIndicatorSchema,
+} from './mailPhoneIndicator.js';
+import { OriginType, originTypeSchema } from './originType.js';
+import {
+  TerminalCapability,
+  terminalCapabilitySchema,
+} from './terminalCapability.js';
+import {
+  TransactionStatus,
+  transactionStatusSchema,
+} from './transactionStatus.js';
+import { TransactionType, transactionTypeSchema } from './transactionType.js';
+
+/** Provides transaction amount related information. */
+export interface CreditTransactionDetails {
+  /** The unique 12-19 digit identifier that is generated with every card transaction and from the electronic transfer of funds. */
+  transactionId?: string;
+  /** Refers to the date when the transaction has been processed for settlement between the two parties. */
+  processDate?: string;
+  /** Refers to the date and time when the bank has settled the transaction (deposits or withdraws funds). */
+  transactionDateTime?: string;
+  /** The approved amount of money to be charged. */
+  authorizationAmount?: number;
+  /** The agreed upon sum for a transaction after authorization and processing steps. */
+  approvedAmount?: number;
+  /** The six number code from the issuing bank to the vendor that authorizes the sale. */
+  authorizationCode?: string;
+  authorizationCurrency?: AuthorizationCurrency;
+  authorizationSource?: AuthorizationSource;
+  transactionType?: TransactionType;
+  transactionStatus?: TransactionStatus;
+  entryMode?: EntryMode;
+  avsResponseCode?: AvsResponseCode;
+  cardholderId?: CardholderId;
+  /** Te unique order identifier indicating the transaction or event sequence. */
+  sequenceNumber?: string;
+  /** The ecommerce authorization identifier. */
+  authorizationIdentifier?: string;
+  /** The unique identifier of the purchaser associated with the transaction. */
+  customerIdentifier?: string;
+  /** The merchant-designated identifier for this transaction. */
+  merchantOrderIdentifier?: string;
+  /** The merchant-specified identifier used to track transactions associated with specific marketing campaigns. */
+  campaign?: string;
+  /** The merchant-specified identifier used to track transactions associated with your affiliate organizations. */
+  affiliate?: string;
+  /** The merchant-specified identifier for grouping transactions by an additional transaction level id outside of affiliate or campaign. */
+  merchantGroupingIdentifier?: string;
+  /** The reporting group category to which the transaction belongs. */
+  reportGroup?: string;
+  aci?: Aci;
+  mailPhoneIndicator?: MailPhoneIndicator;
+  originType?: OriginType;
+  /** The validation code for Visa card network transactions. */
+  validationCode?: string;
+  /** The unique identifier assigned to a point-of-sale terminal for tracking transactions and managing sales data. */
+  posRegisterNumber?: string;
+  /** The eight-digit sequence of characters used by financial institutions to monitor which terminal is used to process a transaction. */
+  terminalNumber?: string;
+  /** The key to uniquely identify a card transaction based on the ISO 8583 standard. */
+  referenceNumber?: string;
+  /** The merchant reference or draft locator number. */
+  draftLocator?: string;
+  terminalCapability?: TerminalCapability;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const creditTransactionDetailsSchema: Schema<CreditTransactionDetails> = lazy(
+  () =>
+    typedExpandoObject(
+      {
+        transactionId: ['transactionId', optional(string())],
+        processDate: ['processDate', optional(string())],
+        transactionDateTime: ['transactionDateTime', optional(string())],
+        authorizationAmount: ['authorizationAmount', optional(number())],
+        approvedAmount: ['approvedAmount', optional(number())],
+        authorizationCode: ['authorizationCode', optional(string())],
+        authorizationCurrency: [
+          'authorizationCurrency',
+          optional(authorizationCurrencySchema),
+        ],
+        authorizationSource: [
+          'authorizationSource',
+          optional(authorizationSourceSchema),
+        ],
+        transactionType: ['transactionType', optional(transactionTypeSchema)],
+        transactionStatus: [
+          'transactionStatus',
+          optional(transactionStatusSchema),
+        ],
+        entryMode: ['entryMode', optional(entryModeSchema)],
+        avsResponseCode: ['avsResponseCode', optional(avsResponseCodeSchema)],
+        cardholderId: ['cardholderId', optional(cardholderIdSchema)],
+        sequenceNumber: ['sequenceNumber', optional(string())],
+        authorizationIdentifier: [
+          'authorizationIdentifier',
+          optional(string()),
+        ],
+        customerIdentifier: ['customerIdentifier', optional(string())],
+        merchantOrderIdentifier: [
+          'merchantOrderIdentifier',
+          optional(string()),
+        ],
+        campaign: ['campaign', optional(string())],
+        affiliate: ['affiliate', optional(string())],
+        merchantGroupingIdentifier: [
+          'merchantGroupingIdentifier',
+          optional(string()),
+        ],
+        reportGroup: ['reportGroup', optional(string())],
+        aci: ['aci', optional(aciSchema)],
+        mailPhoneIndicator: [
+          'mailPhoneIndicator',
+          optional(mailPhoneIndicatorSchema),
+        ],
+        originType: ['originType', optional(originTypeSchema)],
+        validationCode: ['validationCode', optional(string())],
+        posRegisterNumber: ['posRegisterNumber', optional(string())],
+        terminalNumber: ['terminalNumber', optional(string())],
+        referenceNumber: ['referenceNumber', optional(string())],
+        draftLocator: ['draftLocator', optional(string())],
+        terminalCapability: [
+          'terminalCapability',
+          optional(terminalCapabilitySchema),
+        ],
+      },
+      'additionalProperties',
+      optional(unknown())
+    )
+);

package/src/models/customerFields.ts

@@ -0,0 +1,34 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+/** The customer details. */
+export interface CustomerFields {
+  /** Field one for the customer details. */
+  field1?: string;
+  /** Field two for the customer details. */
+  field2?: string;
+  /** Field three for the customer details. */
+  field3?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const customerFieldsSchema: Schema<CustomerFields> = typedExpandoObject(
+  {
+    field1: ['field1', optional(string())],
+    field2: ['field2', optional(string())],
+    field3: ['field3', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/customerFields2.ts

@@ -0,0 +1,33 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+export interface CustomerFields2 {
+  /** Field one for the customer details. */
+  field1?: string;
+  /** Field two for the customer details. */
+  field2?: string;
+  /** Field three for the customer details. */
+  field3?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const customerFields2Schema: Schema<CustomerFields2> = typedExpandoObject(
+  {
+    field1: ['field1', optional(string())],
+    field2: ['field2', optional(string())],
+    field3: ['field3', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/cvv2PresenceIndicator.ts

@@ -0,0 +1,33 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+export interface Cvv2PresenceIndicator {
+  /** The identifier code. */
+  code?: string;
+  /** The short description of the code. */
+  shortDescription?: string;
+  /** The long description of the code. */
+  longDescription?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const cvv2PresenceIndicatorSchema: Schema<Cvv2PresenceIndicator> = typedExpandoObject(
+  {
+    code: ['code', optional(string())],
+    shortDescription: ['shortDescription', optional(string())],
+    longDescription: ['longDescription', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/cvv2ResponseCode.ts

@@ -0,0 +1,33 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+export interface Cvv2ResponseCode {
+  /** The identifier code. */
+  code?: string;
+  /** The short description of the code. */
+  shortDescription?: string;
+  /** The long description of the code. */
+  longDescription?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const cvv2ResponseCodeSchema: Schema<Cvv2ResponseCode> = typedExpandoObject(
+  {
+    code: ['code', optional(string())],
+    shortDescription: ['shortDescription', optional(string())],
+    longDescription: ['longDescription', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/dateRange1.ts

@@ -0,0 +1,30 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+export interface DateRange1 {
+  /** The starting date of the particular time period. */
+  fromDate?: string;
+  /** The end date of the particular time period. */
+  toDate?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const dateRange1Schema: Schema<DateRange1> = typedExpandoObject(
+  {
+    fromDate: ['fromDate', optional(string())],
+    toDate: ['toDate', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/dateType.ts

@@ -0,0 +1,20 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for DateType
+ */
+export enum DateType {
+  ProcessDate = 'PROCESS_DATE',
+  TransactionDate = 'TRANSACTION_DATE',
+}
+
+/**
+ * Schema for DateType
+ */
+export const dateTypeSchema: Schema<DateType> = stringEnum(DateType, true);

package/src/models/daterange.ts

@@ -0,0 +1,31 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+/** All dates, including and between, a specified start and end date. */
+export interface Daterange {
+  /** The starting date of the particular time period. */
+  fromDate?: string;
+  /** The end date of the particular time period. */
+  toDate?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const daterangeSchema: Schema<Daterange> = typedExpandoObject(
+  {
+    fromDate: ['fromDate', optional(string())],
+    toDate: ['toDate', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/emvDetails.ts

@@ -0,0 +1,37 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  boolean,
+  optional,
+  Schema,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+/** Provides information on the EMV details. */
+export interface EmvDetails {
+  /** True means the transaction is EMV. <br> False means the transaction is EMV fallback. */
+  transaction?: boolean;
+  /** True means the transaction didn't go out to the network for authorization. <br> False means the transaction did go out to the network for authorization. */
+  offlineTransaction?: boolean;
+  /** True means the card is an EMV capable card. <br> False means the card is not an EMV capable card. */
+  cardCapable?: boolean;
+  /** True means the terminal is EMV capable. <br> False means the terminal is not EMV capable. */
+  termCapable?: boolean;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const emvDetailsSchema: Schema<EmvDetails> = typedExpandoObject(
+  {
+    transaction: ['transaction', optional(boolean())],
+    offlineTransaction: ['offlineTransaction', optional(boolean())],
+    cardCapable: ['cardCapable', optional(boolean())],
+    termCapable: ['termCapable', optional(boolean())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/emvDetails2.ts

@@ -0,0 +1,36 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  boolean,
+  optional,
+  Schema,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+export interface EmvDetails2 {
+  /** True means the transaction is EMV. <br> False means the transaction is EMV fallback. */
+  transaction?: boolean;
+  /** True means the transaction didn't go out to the network for authorization. <br> False means the transaction did go out to the network for authorization. */
+  offlineTransaction?: boolean;
+  /** True means the card is an EMV capable card. <br> False means the card is not an EMV capable card. */
+  cardCapable?: boolean;
+  /** True means the terminal is EMV capable. <br> False means the terminal is not EMV capable. */
+  termCapable?: boolean;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const emvDetails2Schema: Schema<EmvDetails2> = typedExpandoObject(
+  {
+    transaction: ['transaction', optional(boolean())],
+    offlineTransaction: ['offlineTransaction', optional(boolean())],
+    cardCapable: ['cardCapable', optional(boolean())],
+    termCapable: ['termCapable', optional(boolean())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/entity.ts

@@ -0,0 +1,35 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  array,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+import { Level3, level3Schema } from './level3.js';
+
+/** Entity details. */
+export interface Entity {
+  level?: Level3;
+  /** The values of the hierarchy levels. */
+  values?: string[];
+  /** The level of the merchant hierarchy that groups merchant identifiers (MIDs) and any related roll-up values under a common identifier for settlement, billing, and reporting. Chain Code is the primary identifier for merchants boarded in MDB (Merchant Database) system.<br> Chain Code is mandatory when the level is store or division. */
+  chainCode?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const entitySchema: Schema<Entity> = typedExpandoObject(
+  {
+    level: ['level', optional(level3Schema)],
+    values: ['values', optional(array(string()))],
+    chainCode: ['chainCode', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/entryMode.ts

@@ -0,0 +1,33 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+export interface EntryMode {
+  /** The identifier code. */
+  code?: string;
+  /** The short description of the code. */
+  shortDescription?: string;
+  /** The long description of the code. */
+  longDescription?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const entryModeSchema: Schema<EntryMode> = typedExpandoObject(
+  {
+    code: ['code', optional(string())],
+    shortDescription: ['shortDescription', optional(string())],
+    longDescription: ['longDescription', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/error.ts

@@ -0,0 +1,34 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+/** Error Message */
+export interface Error {
+  /** Code of error */
+  errorCode?: string;
+  /** Error Message */
+  errorMessage?: string;
+  /** Error Target */
+  target?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const errorSchema: Schema<Error> = typedExpandoObject(
+  {
+    errorCode: ['errorCode', optional(string())],
+    errorMessage: ['errorMessage', optional(string())],
+    target: ['target', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/fieldName.ts

@@ -0,0 +1,34 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for FieldName
+ */
+export enum FieldName {
+  TransactionId = 'TRANSACTION_ID',
+  TransactionDateTime = 'TRANSACTION_DATE_TIME',
+  ProcessDate = 'PROCESS_DATE',
+  TransactionStatus = 'TRANSACTION_STATUS',
+  TransactionType = 'TRANSACTION_TYPE',
+  AuthorizationCode = 'AUTHORIZATION_CODE',
+  AuthorizationAmount = 'AUTHORIZATION_AMOUNT',
+  ReferenceNumber = 'REFERENCE_NUMBER',
+  CardType = 'CARD_TYPE',
+  CardNetwork = 'CARD_NETWORK',
+  ChainCode = 'CHAIN_CODE',
+  MerchantName = 'MERCHANT_NAME',
+  MerchantId = 'MERCHANT_ID',
+  Field1 = 'FIELD_1',
+  Field2 = 'FIELD_2',
+  Field3 = 'FIELD_3',
+}
+
+/**
+ * Schema for FieldName
+ */
+export const fieldNameSchema: Schema<FieldName> = stringEnum(FieldName, true);

package/src/models/fieldName1.ts

@@ -0,0 +1,31 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for FieldName1
+ */
+export enum FieldName1 {
+  BatchNumber = 'BATCH_NUMBER',
+  TransactionDate = 'TRANSACTION_DATE',
+  ProcessDate = 'PROCESS_DATE',
+  CardType = 'CARD_TYPE',
+  ChainCode = 'CHAIN_CODE',
+  MerchantName = 'MERCHANT_NAME',
+  MerchantId = 'MERCHANT_ID',
+  AuthorizationAmount = 'AUTHORIZATION_AMOUNT',
+  SalesCount = 'SALES_COUNT',
+  ReturnsCount = 'RETURNS_COUNT',
+}
+
+/**
+ * Schema for FieldName1
+ */
+export const fieldName1Schema: Schema<FieldName1> = stringEnum(
+  FieldName1,
+  true
+);

package/src/models/fieldName2.ts

@@ -0,0 +1,28 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for FieldName2
+ */
+export enum FieldName2 {
+  ProcessDate = 'PROCESS_DATE',
+  NumberOfBatches = 'NUMBER_OF_BATCHES',
+  BatchCardType = 'BATCH_CARD_TYPE',
+  MerchantId = 'MERCHANT_ID',
+  SaleAmount = 'SALE_AMOUNT',
+  ReturnAmount = 'RETURN_AMOUNT',
+  NetAmount = 'NET_AMOUNT',
+}
+
+/**
+ * Schema for FieldName2
+ */
+export const fieldName2Schema: Schema<FieldName2> = stringEnum(
+  FieldName2,
+  true
+);

package/src/models/fieldName3.ts

@@ -0,0 +1,28 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for FieldName3
+ */
+export enum FieldName3 {
+  ProcessDate = 'PROCESS_DATE',
+  BatchNumber = 'BATCH_NUMBER',
+  BatchCardType = 'BATCH_CARD_TYPE',
+  MerchantId = 'MERCHANT_ID',
+  SaleAmount = 'SALE_AMOUNT',
+  ReturnAmount = 'RETURN_AMOUNT',
+  NetAmount = 'NET_AMOUNT',
+}
+
+/**
+ * Schema for FieldName3
+ */
+export const fieldName3Schema: Schema<FieldName3> = stringEnum(
+  FieldName3,
+  true
+);