wp-apimatic 1.0.2

package/src/models/fieldName4.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 FieldName4
+ */
+export enum FieldName4 {
+  ProcessDate = 'PROCESS_DATE',
+  TransactionDate = 'TRANSACTION_DATE',
+  ResubmitDate = 'RESUBMIT_DATE',
+  AccountNumber = 'ACCOUNT_NUMBER',
+  DdaNumber = 'DDA_NUMBER',
+  Amount = 'AMOUNT',
+  ChainCode = 'CHAIN_CODE',
+  MerchantId = 'MERCHANT_ID',
+}
+
+/**
+ * Schema for FieldName4
+ */
+export const fieldName4Schema: Schema<FieldName4> = stringEnum(
+  FieldName4,
+  true
+);

package/src/models/fieldName5.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 FieldName5
+ */
+export enum FieldName5 {
+  ProcessDate = 'PROCESS_DATE',
+  BatchNumber = 'BATCH_NUMBER',
+  BatchHoldStatus = 'BATCH_HOLD_STATUS',
+  ChainCode = 'CHAIN_CODE',
+  MerchantId = 'MERCHANT_ID',
+}
+
+/**
+ * Schema for FieldName5
+ */
+export const fieldName5Schema: Schema<FieldName5> = stringEnum(
+  FieldName5,
+  true
+);

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

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

package/src/models/fraudFields.ts

@@ -0,0 +1,42 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  lazy,
+  optional,
+  Schema,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+import {
+  FraudResponseCode,
+  fraudResponseCodeSchema,
+} from './fraudResponseCode.js';
+import { FraudRuleResult, fraudRuleResultSchema } from './fraudRuleResult.js';
+import { FraudScore, fraudScoreSchema } from './fraudScore.js';
+
+/** Metric indicating a transaction's potential fraudulent activity level. */
+export interface FraudFields {
+  fraudScore?: FraudScore;
+  fraudResponseCode?: FraudResponseCode;
+  fraudRuleResult?: FraudRuleResult;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const fraudFieldsSchema: Schema<FraudFields> = lazy(() =>
+  typedExpandoObject(
+    {
+      fraudScore: ['fraudScore', optional(fraudScoreSchema)],
+      fraudResponseCode: [
+        'fraudResponseCode',
+        optional(fraudResponseCodeSchema),
+      ],
+      fraudRuleResult: ['fraudRuleResult', optional(fraudRuleResultSchema)],
+    },
+    'additionalProperties',
+    optional(unknown())
+  )
+);

package/src/models/fraudFields2.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,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+import {
+  FraudResponseCode,
+  fraudResponseCodeSchema,
+} from './fraudResponseCode.js';
+import { FraudRuleResult, fraudRuleResultSchema } from './fraudRuleResult.js';
+import { FraudScore, fraudScoreSchema } from './fraudScore.js';
+
+export interface FraudFields2 {
+  fraudScore?: FraudScore;
+  fraudResponseCode?: FraudResponseCode;
+  fraudRuleResult?: FraudRuleResult;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const fraudFields2Schema: Schema<FraudFields2> = lazy(() =>
+  typedExpandoObject(
+    {
+      fraudScore: ['fraudScore', optional(fraudScoreSchema)],
+      fraudResponseCode: [
+        'fraudResponseCode',
+        optional(fraudResponseCodeSchema),
+      ],
+      fraudRuleResult: ['fraudRuleResult', optional(fraudRuleResultSchema)],
+    },
+    'additionalProperties',
+    optional(unknown())
+  )
+);

package/src/models/fraudFieldsFraudScore.ts

@@ -0,0 +1,31 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  number,
+  optional,
+  Schema,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+/** Fraud score is a measure that helps gauge risk involved with orders before processing. */
+export interface FraudFieldsFraudScore {
+  /** The starting score for the range for fraud. */
+  fromScore?: number;
+  /** The ending score for the range for fraud. */
+  toScore?: number;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const fraudFieldsFraudScoreSchema: Schema<FraudFieldsFraudScore> = typedExpandoObject(
+  {
+    fromScore: ['fromScore', optional(number())],
+    toScore: ['toScore', optional(number())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/fraudResponseCode.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 FraudResponseCode
+ */
+export enum FraudResponseCode {
+  FraudSystemApproved = 'FRAUD_SYSTEM_APPROVED',
+  FraudDecline = 'FRAUD_DECLINE',
+  NoResponseFraudSystemTimeout = 'NO_RESPONSE_FRAUD_SYSTEM_TIMEOUT',
+  NoResponseCommunicationError = 'NO_RESPONSE_COMMUNICATION_ERROR',
+  NoResponseFraudSystemError = 'NO_RESPONSE_FRAUD_SYSTEM_ERROR',
+  NoResponseAuthSystemError = 'NO_RESPONSE_AUTH_SYSTEM_ERROR',
+}
+
+/**
+ * Schema for FraudResponseCode
+ */
+export const fraudResponseCodeSchema: Schema<FraudResponseCode> = stringEnum(
+  FraudResponseCode,
+  true
+);

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

package/src/models/fraudRuleResult.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 FraudRuleResult
+ */
+export enum FraudRuleResult {
+  FraudSightNotInvoked = 'FRAUD_SIGHT_NOT_INVOKED',
+  Approved = 'APPROVED',
+  ManualReview = 'MANUAL_REVIEW',
+  Decline = 'DECLINE',
+  FraudRuleNotInvoked = 'FRAUD_RULE_NOT_INVOKED',
+}
+
+/**
+ * Schema for FraudRuleResult
+ */
+export const fraudRuleResultSchema: Schema<FraudRuleResult> = stringEnum(
+  FraudRuleResult,
+  true
+);

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

package/src/models/fraudScore.ts

@@ -0,0 +1,30 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  number,
+  optional,
+  Schema,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+export interface FraudScore {
+  /** The starting score for the range for fraud. */
+  fromScore?: number;
+  /** The ending score for the range for fraud. */
+  toScore?: number;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const fraudScoreSchema: Schema<FraudScore> = typedExpandoObject(
+  {
+    fromScore: ['fromScore', optional(number())],
+    toScore: ['toScore', optional(number())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/fraudSightDetails.ts

@@ -0,0 +1,53 @@
+/**
+ * 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 {
+  FraudResponseCode2,
+  fraudResponseCode2Schema,
+} from './fraudResponseCode2.js';
+import {
+  FraudRuleResult2,
+  fraudRuleResult2Schema,
+} from './fraudRuleResult2.js';
+
+/** Provides information on the Fraudsight details. */
+export interface FraudSightDetails {
+  /** The measure that helps gauge risk involved with orders before processing. */
+  fraudScore?: number;
+  /** The condition that helps you decide whether an activity is fraudulent or not. */
+  fraudRule?: string;
+  fraudResponseCode?: FraudResponseCode2;
+  fraudRuleResult?: FraudRuleResult2;
+  /** The time taken to verify if the transaction was fraudulent. */
+  fraudResponseTime?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const fraudSightDetailsSchema: Schema<FraudSightDetails> = lazy(() =>
+  typedExpandoObject(
+    {
+      fraudScore: ['fraudScore', optional(number())],
+      fraudRule: ['fraudRule', optional(string())],
+      fraudResponseCode: [
+        'fraudResponseCode',
+        optional(fraudResponseCode2Schema),
+      ],
+      fraudRuleResult: ['fraudRuleResult', optional(fraudRuleResult2Schema)],
+      fraudResponseTime: ['fraudResponseTime', optional(string())],
+    },
+    'additionalProperties',
+    optional(unknown())
+  )
+);

package/src/models/fraudSightDetails2.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 {
+  FraudResponseCode2,
+  fraudResponseCode2Schema,
+} from './fraudResponseCode2.js';
+import {
+  FraudRuleResult2,
+  fraudRuleResult2Schema,
+} from './fraudRuleResult2.js';
+
+export interface FraudSightDetails2 {
+  /** The measure that helps gauge risk involved with orders before processing. */
+  fraudScore?: number;
+  /** The condition that helps you decide whether an activity is fraudulent or not. */
+  fraudRule?: string;
+  fraudResponseCode?: FraudResponseCode2;
+  fraudRuleResult?: FraudRuleResult2;
+  /** The time taken to verify if the transaction was fraudulent. */
+  fraudResponseTime?: string;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const fraudSightDetails2Schema: Schema<FraudSightDetails2> = lazy(() =>
+  typedExpandoObject(
+    {
+      fraudScore: ['fraudScore', optional(number())],
+      fraudRule: ['fraudRule', optional(string())],
+      fraudResponseCode: [
+        'fraudResponseCode',
+        optional(fraudResponseCode2Schema),
+      ],
+      fraudRuleResult: ['fraudRuleResult', optional(fraudRuleResult2Schema)],
+      fraudResponseTime: ['fraudResponseTime', optional(string())],
+    },
+    'additionalProperties',
+    optional(unknown())
+  )
+);

package/src/models/fundedNetSettle.ts

@@ -0,0 +1,37 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  number,
+  optional,
+  Schema,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+/** Funded transaction reconciliation process for net balance finalization. */
+export interface FundedNetSettle {
+  /** The final funds transferred to merchant accounts after processing fees deductions. */
+  processorAmount?: number;
+  /** The payment method based on processing capacity for settlements. */
+  processorCount?: number;
+  /** The final transaction balance after deducting external funding sources. */
+  otherAmount?: number;
+  /** The amount of financial transactions settled through external sources. */
+  otherCount?: number;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const fundedNetSettleSchema: Schema<FundedNetSettle> = typedExpandoObject(
+  {
+    processorAmount: ['processorAmount', optional(number())],
+    processorCount: ['processorCount', optional(number())],
+    otherAmount: ['otherAmount', optional(number())],
+    otherCount: ['otherCount', optional(number())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/fundedNetSettle2.ts

@@ -0,0 +1,36 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  number,
+  optional,
+  Schema,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+
+export interface FundedNetSettle2 {
+  /** The final funds transferred to merchant accounts after processing fees deductions. */
+  processorAmount?: number;
+  /** The payment method based on processing capacity for settlements. */
+  processorCount?: number;
+  /** The final transaction balance after deducting external funding sources. */
+  otherAmount?: number;
+  /** The amount of financial transactions settled through external sources. */
+  otherCount?: number;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const fundedNetSettle2Schema: Schema<FundedNetSettle2> = typedExpandoObject(
+  {
+    processorAmount: ['processorAmount', optional(number())],
+    processorCount: ['processorCount', optional(number())],
+    otherAmount: ['otherAmount', optional(number())],
+    otherCount: ['otherCount', optional(number())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/hierarchy.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { Level, levelSchema } from './level.js';
+
+export interface Hierarchy {
+  level?: Level;
+  /** 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 hierarchySchema: Schema<Hierarchy> = typedExpandoObject(
+  {
+    level: ['level', optional(levelSchema)],
+    values: ['values', optional(array(string()))],
+    chainCode: ['chainCode', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/hierarchy1.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { Level1, level1Schema } from './level1.js';
+
+export interface Hierarchy1 {
+  level?: Level1;
+  /** 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 hierarchy1Schema: Schema<Hierarchy1> = typedExpandoObject(
+  {
+    level: ['level', optional(level1Schema)],
+    values: ['values', optional(array(string()))],
+    chainCode: ['chainCode', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);