wp-apimatic 1.0.2

package/src/models/otherServices2.ts

@@ -0,0 +1,72 @@
+/**
+ * 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';
+import {
+  StandInIndicator,
+  standInIndicatorSchema,
+} from './standInIndicator.js';
+import { StandInLevel, standInLevelSchema } from './standInLevel.js';
+
+export interface OtherServices2 {
+  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;
+  standInIndicator?: StandInIndicator;
+  standInLevel?: StandInLevel;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const otherServices2Schema: Schema<OtherServices2> = 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)],
+      standInIndicator: ['standInIndicator', optional(standInIndicatorSchema)],
+      standInLevel: ['standInLevel', optional(standInLevelSchema)],
+    },
+    'additionalProperties',
+    optional(unknown())
+  )
+);

package/src/models/pagination.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 Pagination {
+  /** The number of the specific page you want to retrieve. <br> The default is page number 0. */
+  pageNumber?: number;
+  /** The number of records that you would want to retrieve per page. <br> The default is 25 items per page. */
+  pageSize?: number;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const paginationSchema: Schema<Pagination> = typedExpandoObject(
+  {
+    pageNumber: ['pageNumber', optional(number())],
+    pageSize: ['pageSize', optional(number())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/pagination4.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 Pagination4 {
+  /** The current page number returned. */
+  pageNumber?: number;
+  /** The number of records that you would want to retrieve per page. */
+  pageSize?: number;
+  /** The total number of result rows returned. */
+  totalRowCount?: number;
+  /** The total number of records returned. */
+  totalReturnedCount?: number;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const pagination4Schema: Schema<Pagination4> = typedExpandoObject(
+  {
+    pageNumber: ['pageNumber', optional(number())],
+    pageSize: ['pageSize', optional(number())],
+    totalRowCount: ['totalRowCount', optional(number())],
+    totalReturnedCount: ['totalReturnedCount', optional(number())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/paginationResponse.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';
+
+/** The format used to display your resources. */
+export interface PaginationResponse {
+  /** The current page number returned. */
+  pageNumber?: number;
+  /** The number of records that you would want to retrieve per page. */
+  pageSize?: number;
+  /** The total number of result rows returned. */
+  totalRowCount?: number;
+  /** The total number of records returned. */
+  totalReturnedCount?: number;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const paginationResponseSchema: Schema<PaginationResponse> = typedExpandoObject(
+  {
+    pageNumber: ['pageNumber', optional(number())],
+    pageSize: ['pageSize', optional(number())],
+    totalRowCount: ['totalRowCount', optional(number())],
+    totalReturnedCount: ['totalReturnedCount', optional(number())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/paginationtype.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';
+
+/** Retrieves the numbers or marks used to indicate the sequence of pages. */
+export interface Paginationtype {
+  /** The number of the specific page you want to retrieve. <br> The default is page number 0. */
+  pageNumber?: number;
+  /** The number of records that you would want to retrieve per page. <br> The default is 25 items per page. */
+  pageSize?: number;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const paginationtypeSchema: Schema<Paginationtype> = typedExpandoObject(
+  {
+    pageNumber: ['pageNumber', optional(number())],
+    pageSize: ['pageSize', optional(number())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/paymentGatewayDetails.ts

@@ -0,0 +1,40 @@
+/**
+ * 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 details of the payment gateway. */
+export interface PaymentGatewayDetails {
+  /** The unique identifier for a point-of-sale application used in transactions. */
+  posApplicationId?: string;
+  /** The name given to a point-of-sale system. */
+  posApplicationName?: string;
+  /** The specific version of the point-of-sale software. */
+  posApplicationVersion?: string;
+  /** The unique identifier for quick and efficient tracking and processing of a transaction. */
+  gatewayTransactionId?: string;
+  /** Payment Account Reference (PAR) number is a unique identifier assigned to a cardholder’s payment account. */
+  paymentReferenceNumber?: unknown;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const paymentGatewayDetailsSchema: Schema<PaymentGatewayDetails> = typedExpandoObject(
+  {
+    posApplicationId: ['posApplicationId', optional(string())],
+    posApplicationName: ['posApplicationName', optional(string())],
+    posApplicationVersion: ['posApplicationVersion', optional(string())],
+    gatewayTransactionId: ['gatewayTransactionId', optional(string())],
+    paymentReferenceNumber: ['paymentReferenceNumber', optional(unknown())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/paymentGatewayDetails1.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 PaymentGatewayDetails1 {
+  /** The unique identifier for a point-of-sale application used in transactions. */
+  posApplicationId?: string;
+  /** The name given to a point-of-sale system. */
+  posApplicationName?: string;
+  /** The specific version of the point-of-sale software. */
+  posApplicationVersion?: string;
+  /** The unique identifier for quick and efficient tracking and processing of a transaction. */
+  gatewayTransactionId?: string;
+  /** Payment Account Reference (PAR) number is a unique identifier assigned to a cardholder’s payment account. */
+  paymentReferenceNumber?: unknown;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const paymentGatewayDetails1Schema: Schema<PaymentGatewayDetails1> = typedExpandoObject(
+  {
+    posApplicationId: ['posApplicationId', optional(string())],
+    posApplicationName: ['posApplicationName', optional(string())],
+    posApplicationVersion: ['posApplicationVersion', optional(string())],
+    gatewayTransactionId: ['gatewayTransactionId', optional(string())],
+    paymentReferenceNumber: ['paymentReferenceNumber', optional(unknown())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

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

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

package/src/models/premiumPayback.ts

@@ -0,0 +1,40 @@
+/**
+ * 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';
+
+export interface PremiumPayback {
+  /** 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 premiumPaybackSchema: Schema<PremiumPayback> = typedExpandoObject(
+  {
+    indicatorPassed: ['indicatorPassed', optional(boolean())],
+    eligibleBin: ['eligibleBIN', optional(boolean())],
+    eligible: ['eligible', optional(boolean())],
+    redemptionAccepted: ['redemptionAccepted', optional(boolean())],
+    redemptionAmount: ['redemptionAmount', optional(number())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

package/src/models/processdaterange.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 Processdaterange {
+  /** 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 processdaterangeSchema: Schema<Processdaterange> = typedExpandoObject(
+  {
+    fromDate: ['fromDate', optional(string())],
+    toDate: ['toDate', optional(string())],
+  },
+  'additionalProperties',
+  optional(unknown())
+);

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

package/src/models/searchAuthTransactions.ts

@@ -0,0 +1,97 @@
+/**
+ * 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 {
+  AdditionalDetails,
+  additionalDetailsSchema,
+} from './additionalDetails.js';
+import { CardDetails2, cardDetails2Schema } from './cardDetails2.js';
+import { CustomerFields2, customerFields2Schema } from './customerFields2.js';
+import { EmvDetails2, emvDetails2Schema } from './emvDetails2.js';
+import {
+  FraudSightDetails2,
+  fraudSightDetails2Schema,
+} from './fraudSightDetails2.js';
+import {
+  InterchangeDetails,
+  interchangeDetailsSchema,
+} from './interchangeDetails.js';
+import {
+  LocationDetails2,
+  locationDetails2Schema,
+} from './locationDetails2.js';
+import { OtherServices2, otherServices2Schema } from './otherServices2.js';
+import {
+  PaymentGatewayDetails1,
+  paymentGatewayDetails1Schema,
+} from './paymentGatewayDetails1.js';
+import { PremiumPayback, premiumPaybackSchema } from './premiumPayback.js';
+import { SignifyDetails, signifyDetailsSchema } from './signifyDetails.js';
+import {
+  TransactionDetails2,
+  transactionDetails2Schema,
+} from './transactionDetails2.js';
+
+/** Search authorization transaction information. */
+export interface SearchAuthTransactions {
+  transactionDetails?: TransactionDetails2;
+  cardDetails?: CardDetails2;
+  locationDetails?: LocationDetails2;
+  interchangeDetails?: InterchangeDetails;
+  premiumPayback?: PremiumPayback;
+  otherServices?: OtherServices2;
+  emvDetails?: EmvDetails2;
+  fraudSightDetails?: FraudSightDetails2;
+  signifyDetails?: SignifyDetails;
+  additionalDetails?: AdditionalDetails;
+  customerFields?: CustomerFields2;
+  paymentGatewayDetails?: PaymentGatewayDetails1;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const searchAuthTransactionsSchema: Schema<SearchAuthTransactions> = lazy(
+  () =>
+    typedExpandoObject(
+      {
+        transactionDetails: [
+          'transactionDetails',
+          optional(transactionDetails2Schema),
+        ],
+        cardDetails: ['cardDetails', optional(cardDetails2Schema)],
+        locationDetails: ['locationDetails', optional(locationDetails2Schema)],
+        interchangeDetails: [
+          'interchangeDetails',
+          optional(interchangeDetailsSchema),
+        ],
+        premiumPayback: ['premiumPayback', optional(premiumPaybackSchema)],
+        otherServices: ['otherServices', optional(otherServices2Schema)],
+        emvDetails: ['emvDetails', optional(emvDetails2Schema)],
+        fraudSightDetails: [
+          'fraudSightDetails',
+          optional(fraudSightDetails2Schema),
+        ],
+        signifyDetails: ['signifyDetails', optional(signifyDetailsSchema)],
+        additionalDetails: [
+          'additionalDetails',
+          optional(additionalDetailsSchema),
+        ],
+        customerFields: ['customerFields', optional(customerFields2Schema)],
+        paymentGatewayDetails: [
+          'paymentGatewayDetails',
+          optional(paymentGatewayDetails1Schema),
+        ],
+      },
+      'additionalProperties',
+      optional(unknown())
+    )
+);

package/src/models/searchDailyTotals.ts

@@ -0,0 +1,42 @@
+/**
+ * Reporting: Settlement Research APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  array,
+  lazy,
+  optional,
+  Schema,
+  typedExpandoObject,
+  unknown,
+} from '../schema.js';
+import {
+  PaginationResponse,
+  paginationResponseSchema,
+} from './paginationResponse.js';
+import {
+  SearchDailyTotalsDetails,
+  searchDailyTotalsDetailsSchema,
+} from './searchDailyTotalsDetails.js';
+
+/** Provides the details of the all the card transactions grouped by card type, batch number, and process date." */
+export interface SearchDailyTotals {
+  /** The format used to display your resources. */
+  pagination?: PaginationResponse;
+  /** Retrieves the daily total information. */
+  details?: SearchDailyTotalsDetails[];
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const searchDailyTotalsSchema: Schema<SearchDailyTotals> = lazy(() =>
+  typedExpandoObject(
+    {
+      pagination: ['pagination', optional(paginationResponseSchema)],
+      details: ['details', optional(array(searchDailyTotalsDetailsSchema))],
+    },
+    'additionalProperties',
+    optional(unknown())
+  )
+);

package/src/models/searchDailyTotalsDetails.ts

@@ -0,0 +1,72 @@
+/**
+ * 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 {
+  FundedNetSettle2,
+  fundedNetSettle2Schema,
+} from './fundedNetSettle2.js';
+import { Hierarchy10, hierarchy10Schema } from './hierarchy10.js';
+import {
+  InterchangeDetails1,
+  interchangeDetails1Schema,
+} from './interchangeDetails1.js';
+import { Terminal, terminalSchema } from './terminal.js';
+import {
+  TransactionSummary,
+  transactionSummarySchema,
+} from './transactionSummary.js';
+
+/** Fields used to search daily totals. */
+export interface SearchDailyTotalsDetails {
+  /** The category or classification of a payment card based on the issuing network. */
+  cardType?: string;
+  /** The 11-byte unique identifier assigned to a group of transactions that were handled together as a single unit. */
+  batchNumber?: number;
+  /** The date when the transaction has been processed for settlement between the two parties. */
+  processDate?: string;
+  /** The date and time when the bank has settled the transaction (deposits or withdraws funds). */
+  transactionDate?: string;
+  hierarchy?: Hierarchy10;
+  transactionSummary?: TransactionSummary;
+  interchangeDetails?: InterchangeDetails1;
+  terminal?: Terminal;
+  fundedNetSettle?: FundedNetSettle2;
+  additionalProperties?: Record<string, unknown>;
+}
+
+export const searchDailyTotalsDetailsSchema: Schema<SearchDailyTotalsDetails> = lazy(
+  () =>
+    typedExpandoObject(
+      {
+        cardType: ['cardType', optional(string())],
+        batchNumber: ['batchNumber', optional(number())],
+        processDate: ['processDate', optional(string())],
+        transactionDate: ['transactionDate', optional(string())],
+        hierarchy: ['hierarchy', optional(hierarchy10Schema)],
+        transactionSummary: [
+          'transactionSummary',
+          optional(transactionSummarySchema),
+        ],
+        interchangeDetails: [
+          'interchangeDetails',
+          optional(interchangeDetails1Schema),
+        ],
+        terminal: ['terminal', optional(terminalSchema)],
+        fundedNetSettle: ['fundedNetSettle', optional(fundedNetSettle2Schema)],
+      },
+      'additionalProperties',
+      optional(unknown())
+    )
+);