wp-apimatic 1.0.2

package/src/models/cardProductResults.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 CardProductResults {
+  /** 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 cardProductResultsSchema: Schema<CardProductResults> = typedExpandoObject(
+  {
+    code: ['code', optional(string())],
+    shortDescription: ['shortDescription', optional(string())],
+    longDescription: ['longDescription', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/cardProductType.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 CardProductType {
+  /** 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 cardProductTypeSchema: Schema<CardProductType> = typedExpandoObject(
+  {
+    code: ['code', optional(string())],
+    shortDescription: ['shortDescription', optional(string())],
+    longDescription: ['longDescription', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/cardTypes.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 CardTypes
+ */
+export enum CardTypes {
+  Credit = 'CREDIT',
+  Debit = 'DEBIT',
+  Gift = 'GIFT',
+  Ebt = 'EBT',
+  Wic = 'WIC',
+}
+
+/**
+ * Schema for CardTypes
+ */
+export const cardTypesSchema: Schema<CardTypes> = stringEnum(CardTypes, true);

package/src/models/cardTypes1.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 CardTypes1
+ */
+export enum CardTypes1 {
+  Credit = 'CREDIT',
+  Debit = 'DEBIT',
+  Gift = 'GIFT',
+  Ebt = 'EBT',
+}
+
+/**
+ * Schema for CardTypes1
+ */
+export const cardTypes1Schema: Schema<CardTypes1> = stringEnum(
+  CardTypes1,
+  true
+);

package/src/models/cardholderId.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 CardholderId {
+  /** 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 cardholderIdSchema: Schema<CardholderId> = typedExpandoObject(
+  {
+    code: ['code', optional(string())],
+    shortDescription: ['shortDescription', optional(string())],
+    longDescription: ['longDescription', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/codeAndDescription.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 unique identifier and the brief description. */
+export interface CodeAndDescription {
+  /** 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 codeAndDescriptionSchema: Schema<CodeAndDescription> = typedExpandoObject(
+  {
+    code: ['code', optional(string())],
+    shortDescription: ['shortDescription', optional(string())],
+    longDescription: ['longDescription', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/codeAndDescription1.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';
+
+/** The unique identifier and the brief description. */
+export interface CodeAndDescription1 {
+  /** The identifier code. */
+  code?: string;
+  /** The description of the code. */
+  description?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const codeAndDescription1Schema: Schema<CodeAndDescription1> = typedExpandoObject(
+  {
+    code: ['code', optional(string())],
+    description: ['description', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/countryOfOrigin.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 CountryOfOrigin {
+  /** 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 countryOfOriginSchema: Schema<CountryOfOrigin> = typedExpandoObject(
+  {
+    code: ['code', optional(string())],
+    shortDescription: ['shortDescription', optional(string())],
+    longDescription: ['longDescription', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/creditAdditionalDetails.ts

@@ -0,0 +1,44 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  boolean,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+/** Provides additional details on the credit transaction. */
+export interface CreditAdditionalDetails {
+  /** Refers to any adjustment made in the records. */
+  hasAdjustmentRecords?: string;
+  /** Possible values are True or False. */
+  forcePost?: boolean;
+  /** Unique identifier for the airline invoice billing transactions. */
+  airlineInvoiceNumber?: string;
+  /** Unique identifier for the airline ticket billing transactions. */
+  airlineTicketNumber?: string;
+  /** The scheduled day a flight leaves. */
+  airlineDepartureDate?: string;
+  /** Indicates funds without corresponding transaction records in the accounts. Possible values are true or false. */
+  unmatchedCredit?: boolean;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const creditAdditionalDetailsSchema: Schema<CreditAdditionalDetails> = typedExpandoObject(
+  {
+    hasAdjustmentRecords: ['hasAdjustmentRecords', optional(string())],
+    forcePost: ['forcePost', optional(boolean())],
+    airlineInvoiceNumber: ['airlineInvoiceNumber', optional(string())],
+    airlineTicketNumber: ['airlineTicketNumber', optional(string())],
+    airlineDepartureDate: ['airlineDepartureDate', optional(string())],
+    unmatchedCredit: ['unmatchedCredit', optional(boolean())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/creditCardDetails.ts

@@ -0,0 +1,86 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  boolean,
+  lazy,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+import { CardNetwork, cardNetworkSchema } from './cardNetwork.js';
+import {
+  Cvv2PresenceIndicator,
+  cvv2PresenceIndicatorSchema,
+} from './cvv2PresenceIndicator.js';
+import {
+  Cvv2ResponseCode,
+  cvv2ResponseCodeSchema,
+} from './cvv2ResponseCode.js';
+import {
+  InternationalIndicator,
+  internationalIndicatorSchema,
+} from './internationalIndicator.js';
+
+/** Provides card related information. */
+export interface CreditCardDetails {
+  /** The number found on the card used to make a purchase, also referred to as the bank or credit card number. <br>Searches can be done on the full card number, on the first six and last four digits, or on the last four digits." */
+  cardNumber?: string;
+  /** The category or classification of a payment card based on the issuing network. <br> Possible values are CREDIT, DEBIT, and GIFT. */
+  cardType?: string;
+  /** The set time when a card will need to be replaced. */
+  expirationDate?: string;
+  cardNetwork?: CardNetwork;
+  cvv2ResponseCode?: Cvv2ResponseCode;
+  cvv2PresenceIndicator?: Cvv2PresenceIndicator;
+  /** The numeric value that is the same length as the card number and is used as a substitution with proxy data. Max length of the token is 19 characters. */
+  token?: string;
+  /** The host-generated numeric value created during the tokenization process using a token key assigned to a merchant. This value is returned to the point-of-sale when tokenization is requested along with the token for utilization. */
+  tokenId?: string;
+  /** A request and response field. The score or confidence level that determines the expected level of assurance associated with the approved token requestor and the identification and verification method performed at the time of token request. */
+  tokenAssuranceLevel?: string;
+  /** The expiration date of the token in the YYYY-MM format with a fixed length of 6. */
+  tokenExpirationDate?: string;
+  internationalIndicator?: InternationalIndicator;
+  /** Possible values are true and false. */
+  networkRejectIndicator?: boolean;
+  /** Indentifier for digital payment transactions. */
+  networkPaymentTokenNumber?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const creditCardDetailsSchema: Schema<CreditCardDetails> = lazy(() =>
+  typedExpandoObject(
+    {
+      cardNumber: ['cardNumber', optional(string())],
+      cardType: ['cardType', optional(string())],
+      expirationDate: ['expirationDate', optional(string())],
+      cardNetwork: ['cardNetwork', optional(cardNetworkSchema)],
+      cvv2ResponseCode: ['cvv2ResponseCode', optional(cvv2ResponseCodeSchema)],
+      cvv2PresenceIndicator: [
+        'cvv2PresenceIndicator',
+        optional(cvv2PresenceIndicatorSchema),
+      ],
+      token: ['token', optional(string())],
+      tokenId: ['tokenId', optional(string())],
+      tokenAssuranceLevel: ['tokenAssuranceLevel', optional(string())],
+      tokenExpirationDate: ['tokenExpirationDate', optional(string())],
+      internationalIndicator: [
+        'internationalIndicator',
+        optional(internationalIndicatorSchema),
+      ],
+      networkRejectIndicator: ['networkRejectIndicator', optional(boolean())],
+      networkPaymentTokenNumber: [
+        'networkPaymentTokenNumber',
+        optional(string()),
+      ],
+    },
+    'additionalProperties',
+    optional(unknown())
+  )
+);

package/src/models/creditInterchangeDetails.ts

@@ -0,0 +1,83 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  lazy,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+import {
+  BillingIndicator,
+  billingIndicatorSchema,
+} from './billingIndicator.js';
+import {
+  CardProductResults,
+  cardProductResultsSchema,
+} from './cardProductResults.js';
+import { CardProductType, cardProductTypeSchema } from './cardProductType.js';
+import { InterchangeCode, interchangeCodeSchema } from './interchangeCode.js';
+import { SurchargeReason, surchargeReasonSchema } from './surchargeReason.js';
+
+/** Provides information on interchange related details. */
+export interface CreditInterchangeDetails {
+  cardProductResults?: CardProductResults;
+  cardProductType?: CardProductType;
+  /** The number of days late. */
+  daysLate?: string;
+  /** The amount of the discount applied. */
+  discountAmount?: string;
+  interchangeCode?: InterchangeCode;
+  /** Fees between banks for processing credit and debit transactions interchangeably. */
+  interchangeFee?: string;
+  /** Indicator of organization interchange. */
+  originalInterchangeIndicator?: string;
+  /** The additional fee added to the original cost or payment. */
+  surchargeAmount?: string;
+  surchargeReason?: SurchargeReason;
+  /** The additional fee imposed by a merchant for using a particular payment method or service. */
+  merchantSurchargeAmount?: string;
+  /** The charge for the convenience of using a service or making a transaction, typically online. */
+  convenienceFee?: string;
+  billingIndicator?: BillingIndicator;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const creditInterchangeDetailsSchema: Schema<CreditInterchangeDetails> = lazy(
+  () =>
+    typedExpandoObject(
+      {
+        cardProductResults: [
+          'cardProductResults',
+          optional(cardProductResultsSchema),
+        ],
+        cardProductType: ['cardProductType', optional(cardProductTypeSchema)],
+        daysLate: ['daysLate', optional(string())],
+        discountAmount: ['discountAmount', optional(string())],
+        interchangeCode: ['interchangeCode', optional(interchangeCodeSchema)],
+        interchangeFee: ['interchangeFee', optional(string())],
+        originalInterchangeIndicator: [
+          'originalInterchangeIndicator',
+          optional(string()),
+        ],
+        surchargeAmount: ['surchargeAmount', optional(string())],
+        surchargeReason: ['surchargeReason', optional(surchargeReasonSchema)],
+        merchantSurchargeAmount: [
+          'merchantSurchargeAmount',
+          optional(string()),
+        ],
+        convenienceFee: ['convenienceFee', optional(string())],
+        billingIndicator: [
+          'billingIndicator',
+          optional(billingIndicatorSchema),
+        ],
+      },
+      'additionalProperties',
+      optional(unknown())
+    )
+);

package/src/models/creditMerchantHierarchyDetails.ts

@@ -0,0 +1,41 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  lazy,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+import { Hierarchy10, hierarchy10Schema } from './hierarchy10.js';
+
+/** Provides the merchant related details. */
+export interface CreditMerchantHierarchyDetails {
+  hierarchy?: Hierarchy10;
+  /** An alternate 12-16 digit unique identifier assigned to each merchant. */
+  alternateMerchantId?: string;
+  /** Alternate store number is a secondary ID used to uniquely identify a store within a merchant's hierarchy. */
+  alternateStoreNumber?: string;
+  /** The name of a business or registered name of the company or entity operating the business. */
+  merchantName?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const creditMerchantHierarchyDetailsSchema: Schema<CreditMerchantHierarchyDetails> = lazy(
+  () =>
+    typedExpandoObject(
+      {
+        hierarchy: ['hierarchy', optional(hierarchy10Schema)],
+        alternateMerchantId: ['alternateMerchantId', optional(string())],
+        alternateStoreNumber: ['alternateStoreNumber', optional(string())],
+        merchantName: ['merchantName', optional(string())],
+      },
+      'additionalProperties',
+      optional(unknown())
+    )
+);

package/src/models/creditOtherServicesDetails.ts

@@ -0,0 +1,65 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  lazy,
+  optional,
+  Schema,
+  string,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+import { LevelIndicator, levelIndicatorSchema } from './levelIndicator.js';
+import {
+  SignatureCapabilitiesIndicator,
+  signatureCapabilitiesIndicatorSchema,
+} from './signatureCapabilitiesIndicator.js';
+import {
+  SignatureCompression,
+  signatureCompressionSchema,
+} from './signatureCompression.js';
+import { SignaturePen, signaturePenSchema } from './signaturePen.js';
+
+/** Provides information on other services related details. */
+export interface CreditOtherServicesDetails {
+  levelIndicator?: LevelIndicator;
+  /** The number of times reauthorization has been attempted. */
+  reAuthorizationAttemptsCount?: string;
+  signatureCapabilitiesIndicator?: SignatureCapabilitiesIndicator;
+  signatureCompression?: SignatureCompression;
+  /** Indicates the encryption key of the signature. */
+  signatureEncryptKey?: string;
+  /** Used to verify the encryption method. */
+  signatureEncryptMethod?: string;
+  signaturePen?: SignaturePen;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const creditOtherServicesDetailsSchema: Schema<CreditOtherServicesDetails> = lazy(
+  () =>
+    typedExpandoObject(
+      {
+        levelIndicator: ['levelIndicator', optional(levelIndicatorSchema)],
+        reAuthorizationAttemptsCount: [
+          'reAuthorizationAttemptsCount',
+          optional(string()),
+        ],
+        signatureCapabilitiesIndicator: [
+          'signatureCapabilitiesIndicator',
+          optional(signatureCapabilitiesIndicatorSchema),
+        ],
+        signatureCompression: [
+          'signatureCompression',
+          optional(signatureCompressionSchema),
+        ],
+        signatureEncryptKey: ['signatureEncryptKey', optional(string())],
+        signatureEncryptMethod: ['signatureEncryptMethod', optional(string())],
+        signaturePen: ['signaturePen', optional(signaturePenSchema)],
+      },
+      'additionalProperties',
+      optional(unknown())
+    )
+);

package/src/models/creditPremiumPaybackDetails.ts

@@ -0,0 +1,41 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  boolean,
+  number,
+  optional,
+  Schema,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+/** Provides information on payback related details. */
+export interface CreditPremiumPaybackDetails {
+  /** Possible values are True or False. */
+  indicatorPassed?: boolean;
+  /** Possible values are True or False. */
+  eligibleBin?: boolean;
+  /** Possible values are True or False. */
+  eligible?: boolean;
+  /** Possible values are True or False. */
+  redemptionAccepted?: boolean;
+  /** Indicates the early repayment charges. */
+  redemptionAmount?: number;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const creditPremiumPaybackDetailsSchema: Schema<CreditPremiumPaybackDetails> = typedExpandoObject(
+  {
+    indicatorPassed: ['indicatorPassed', optional(boolean())],
+    eligibleBin: ['eligibleBIN', optional(boolean())],
+    eligible: ['eligible', optional(boolean())],
+    redemptionAccepted: ['redemptionAccepted', optional(boolean())],
+    redemptionAmount: ['redemptionAmount', optional(number())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);