fortis-apimatic-sdk 1.0.0

package/src/models/returnFeeTransactionAchRetry.ts

@@ -0,0 +1,45 @@
+/**
+ * Fortis APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  expandoObject,
+  nullable,
+  number,
+  optional,
+  Schema,
+  string,
+} from '../schema.js';
+
+/** [object Object] */
+export interface ReturnFeeTransactionAchRetry {
+  /** Rejected Transaction ID. */
+  rejectedTransactionId?: string;
+  /** Return Fee. */
+  returnFee?: number | null;
+  /** Transaction ACH Retry ID. */
+  id?: string;
+  /** Retry Transaction ID. */
+  retryTransactionId?: string;
+  /** Return Fee Transaction ID. */
+  returnFeeTransactionId?: string;
+  /** Created Time Stamp */
+  createdTs?: number;
+  /** User ID Created the register */
+  createdUserId?: string;
+  [key: string]: unknown;
+}
+
+export const returnFeeTransactionAchRetrySchema: Schema<ReturnFeeTransactionAchRetry> = expandoObject(
+  {
+    rejectedTransactionId: ['rejected_transaction_id', optional(string())],
+    returnFee: ['return_fee', optional(nullable(number()))],
+    id: ['id', optional(string())],
+    retryTransactionId: ['retry_transaction_id', optional(string())],
+    returnFeeTransactionId: ['return_fee_transaction_id', optional(string())],
+    createdTs: ['created_ts', optional(number())],
+    createdUserId: ['created_user_id', optional(string())],
+  }
+);

package/src/models/savedAccount.ts

@@ -0,0 +1,249 @@
+/**
+ * Fortis APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  boolean,
+  expandoObject,
+  lazy,
+  nullable,
+  number,
+  optional,
+  Schema,
+  string,
+} from '../schema.js';
+import { AchSecCode3Enum, achSecCode3EnumSchema } from './achSecCode3Enum.js';
+import { BillingAddress, billingAddressSchema } from './billingAddress.js';
+import {
+  CauSummaryStatusIdEnum,
+  cauSummaryStatusIdEnumSchema,
+} from './cauSummaryStatusIdEnum.js';
+import {
+  IdentityVerification2,
+  identityVerification2Schema,
+} from './identityVerification2.js';
+import { Joi4, joi4Schema } from './joi4.js';
+import {
+  PaymentMethod16Enum,
+  paymentMethod16EnumSchema,
+} from './paymentMethod16Enum.js';
+
+/** [object Object] */
+export interface SavedAccount {
+  /**
+   * Account holder name
+   * >For CC, this is the 'Name (as it appears) on Card'. For ACH, this is the 'Name on Account'.
+   * >
+   */
+  accountHolderName?: string | null;
+  /**
+   * This field can be used to correlate Tokens in our system to data within an outside software integration
+   * >Must be unique per location. When running a transaction and using a stored token, this field can be used in place of account_vault_id.
+   * >
+   */
+  accountVaultApiId?: string | null;
+  /**
+   * This field can be used to correlate Tokens in our system to data within an outside software integration
+   * >Must be unique per location. When running a transaction and using a stored token, this field can be used in place of token_id.
+   * >
+   */
+  tokenApiId?: string | null;
+  /** DEPRECATED (Use token_c1 instead) */
+  accountvaultC1?: string | null;
+  /** DEPRECATED (Use token_c2 instead) */
+  accountvaultC2?: string | null;
+  /** DEPRECATED (Use token_c3 instead) */
+  accountvaultC3?: string | null;
+  /** Custom field 1 for API users to store custom data */
+  tokenC1?: string | null;
+  /** Custom field 2 for API users to store custom data */
+  tokenC2?: string | null;
+  /** Custom field 3 for API users to store custom data */
+  tokenC3?: string | null;
+  /** SEC code for the account */
+  achSecCode?: AchSecCode3Enum | null;
+  /** Billing Address Object */
+  billingAddress?: BillingAddress;
+  /** Used to associate the Token with a Contact. */
+  contactId?: string | null;
+  /** Used to store a customer identification number. */
+  customerId?: string | null;
+  /** Identity verification */
+  identityVerification?: IdentityVerification2;
+  /** A valid Location Id associated with the Contact for this Token */
+  locationId?: string;
+  /** Can be used to pull payment info from a previous token api id. */
+  previousAccountVaultApiId?: string | null;
+  /** Can be used to pull payment info from a previous token api id. */
+  previousTokenApiId?: string | null;
+  /** Can be used to pull payment info from a previous token. */
+  previousAccountVaultId?: string | null;
+  /** Can be used to pull payment info from a previous token. */
+  previousTokenId?: string | null;
+  /** Can be used to pull payment info from a previous transaction. */
+  previousTransactionId?: string | null;
+  /**
+   * Account number
+   * >For CC transactions, a credit card number. For ACH transactions, a bank account number. String lengths are conditional, CC should be 13-19 and ACH should be 4-19.
+   * >
+   */
+  accountNumber?: string | null;
+  /** Terms agreement. */
+  termsAgree?: boolean;
+  /** The ip address of the client that agreed to terms. */
+  termsAgreeIp?: string | null;
+  /** Used to describe the Token for easier identification within our UI. */
+  title?: string | null;
+  /** Token Import Id */
+  tokenImportId?: string | null;
+  /** (ECOMM) Directory Server Transaction ID (Such as XID, TAVV) */
+  secureDirectoryServerTransactionId?: string | null;
+  /** (ECOMM)  Secure Program Protocol Version */
+  secureProtocolVersion?: number | null;
+  /** (ECOMM) The token authentication value associated with 3D secure transactions (Such as CAVV, UCAF auth data) */
+  secureAuthData?: string | null;
+  /** (ECOMM) Used for UCAF collection indicator or Discover Autentication type */
+  secureCollectionIndicator?: number | null;
+  /** 3DS Server Transaction ID.  If this field is sent and 3DS authentication was done with Fortis, the 3DS fields secure_directory_server_transaction_id, secure_protocol_version, and secure_collection_indicator will be pre-populated. */
+  threeDsServerTransId?: string | null;
+  /** ACS Transaction ID */
+  acsTransactionId?: string | null;
+  joi?: Joi4;
+  /** A unique, system-generated identifier for the Token. */
+  id?: string;
+  /**
+   * Account type
+   * >For ACH, must be provided as either 'checking' or 'savings'. For CC, field is read only. System will identify card_type and generate a value for this field automatically. i.e. visa, mc, disc, amex, jcb, diners.
+   * >
+   */
+  accountType?: string;
+  /** Register is Active */
+  active?: boolean;
+  /** CAU Summary Status ID. */
+  cauSummaryStatusId?: CauSummaryStatusIdEnum;
+  /** Created Time Stamp */
+  createdTs?: number;
+  /** E Serial Number */
+  eSerialNumber?: string | null;
+  /** E Track Data */
+  eTrackData?: string | null;
+  /** E Format */
+  eFormat?: string | null;
+  /** E Keyed Data */
+  eKeyedData?: string | null;
+  /** Determined by API based on card exp_date. */
+  expiringInMonths?: number | null;
+  /** Required for CC. The Expiration Date for the credit card. (MMYY format). */
+  expDate?: string | null;
+  /** The first six numbers of an account number.  System will generate a value for this field automatically. */
+  firstSix?: string;
+  /** True indicates that this token is tied to a Recurring Payment */
+  hasRecurring?: boolean;
+  /** The last four numbers of an account number.  System will generate a value for this field automatically. */
+  lastFour?: string;
+  /** Modified Time Stamp */
+  modifiedTs?: number;
+  /** Must be provided as either 'cc' or 'ach'. */
+  paymentMethod?: PaymentMethod16Enum;
+  /** A valid ticket that was created to store the token. */
+  ticket?: string | null;
+  /** Track Data from a magnetic card swipe. */
+  trackData?: string | null;
+  /** User ID Created the register */
+  createdUserId?: string | null;
+  /** CAU Last Updated Timestamp */
+  cauLastUpdatedTs?: number | null;
+  /** Card bin */
+  cardBin?: string | null;
+  /** Required for ACH. The Routing Number for the bank account being used. */
+  routingNumber?: string | null;
+  [key: string]: unknown;
+}
+
+export const savedAccountSchema: Schema<SavedAccount> = lazy(() =>
+  expandoObject({
+    accountHolderName: ['account_holder_name', optional(nullable(string()))],
+    accountVaultApiId: ['account_vault_api_id', optional(nullable(string()))],
+    tokenApiId: ['token_api_id', optional(nullable(string()))],
+    accountvaultC1: ['accountvault_c1', optional(nullable(string()))],
+    accountvaultC2: ['accountvault_c2', optional(nullable(string()))],
+    accountvaultC3: ['accountvault_c3', optional(nullable(string()))],
+    tokenC1: ['token_c1', optional(nullable(string()))],
+    tokenC2: ['token_c2', optional(nullable(string()))],
+    tokenC3: ['token_c3', optional(nullable(string()))],
+    achSecCode: ['ach_sec_code', optional(nullable(achSecCode3EnumSchema))],
+    billingAddress: ['billing_address', optional(billingAddressSchema)],
+    contactId: ['contact_id', optional(nullable(string()))],
+    customerId: ['customer_id', optional(nullable(string()))],
+    identityVerification: [
+      'identity_verification',
+      optional(identityVerification2Schema),
+    ],
+    locationId: ['location_id', optional(string())],
+    previousAccountVaultApiId: [
+      'previous_account_vault_api_id',
+      optional(nullable(string())),
+    ],
+    previousTokenApiId: ['previous_token_api_id', optional(nullable(string()))],
+    previousAccountVaultId: [
+      'previous_account_vault_id',
+      optional(nullable(string())),
+    ],
+    previousTokenId: ['previous_token_id', optional(nullable(string()))],
+    previousTransactionId: [
+      'previous_transaction_id',
+      optional(nullable(string())),
+    ],
+    accountNumber: ['account_number', optional(nullable(string()))],
+    termsAgree: ['terms_agree', optional(boolean())],
+    termsAgreeIp: ['terms_agree_ip', optional(nullable(string()))],
+    title: ['title', optional(nullable(string()))],
+    tokenImportId: ['token_import_id', optional(nullable(string()))],
+    secureDirectoryServerTransactionId: [
+      'secure_directory_server_transaction_id',
+      optional(nullable(string())),
+    ],
+    secureProtocolVersion: [
+      'secure_protocol_version',
+      optional(nullable(number())),
+    ],
+    secureAuthData: ['secure_auth_data', optional(nullable(string()))],
+    secureCollectionIndicator: [
+      'secure_collection_indicator',
+      optional(nullable(number())),
+    ],
+    threeDsServerTransId: [
+      'three_ds_server_trans_id',
+      optional(nullable(string())),
+    ],
+    acsTransactionId: ['acs_transaction_id', optional(nullable(string()))],
+    joi: ['_joi', optional(joi4Schema)],
+    id: ['id', optional(string())],
+    accountType: ['account_type', optional(string())],
+    active: ['active', optional(boolean())],
+    cauSummaryStatusId: [
+      'cau_summary_status_id',
+      optional(cauSummaryStatusIdEnumSchema),
+    ],
+    createdTs: ['created_ts', optional(number())],
+    eSerialNumber: ['e_serial_number', optional(nullable(string()))],
+    eTrackData: ['e_track_data', optional(nullable(string()))],
+    eFormat: ['e_format', optional(nullable(string()))],
+    eKeyedData: ['e_keyed_data', optional(nullable(string()))],
+    expiringInMonths: ['expiring_in_months', optional(nullable(number()))],
+    expDate: ['exp_date', optional(nullable(string()))],
+    firstSix: ['first_six', optional(string())],
+    hasRecurring: ['has_recurring', optional(boolean())],
+    lastFour: ['last_four', optional(string())],
+    modifiedTs: ['modified_ts', optional(number())],
+    paymentMethod: ['payment_method', optional(paymentMethod16EnumSchema)],
+    ticket: ['ticket', optional(nullable(string()))],
+    trackData: ['track_data', optional(nullable(string()))],
+    createdUserId: ['created_user_id', optional(nullable(string()))],
+    cauLastUpdatedTs: ['cau_last_updated_ts', optional(nullable(number()))],
+    cardBin: ['card_bin', optional(nullable(string()))],
+    routingNumber: ['routing_number', optional(nullable(string()))],
+  })
+);

package/src/models/schemeIdEnum.ts

@@ -0,0 +1,24 @@
+/**
+ * Fortis APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for SchemeIdEnum
+ */
+export enum SchemeIdEnum {
+  Visa = 'Visa',
+  Mastercard = 'Mastercard',
+  EnumAmericanExpress = 'American Express',
+  Diners = 'Diners',
+}
+
+/**
+ * Schema for SchemeIdEnum
+ */
+export const schemeIdEnumSchema: Schema<SchemeIdEnum> = stringEnum(
+  SchemeIdEnum
+);

package/src/models/secCodeEnum.ts

@@ -0,0 +1,22 @@
+/**
+ * Fortis APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for SecCodeEnum
+ */
+export enum SecCodeEnum {
+  CCD = 'CCD',
+  PPD = 'PPD',
+  WEB = 'WEB',
+  TEL = 'TEL',
+}
+
+/**
+ * Schema for SecCodeEnum
+ */
+export const secCodeEnumSchema: Schema<SecCodeEnum> = stringEnum(SecCodeEnum);

package/src/models/settings.ts

@@ -0,0 +1,23 @@
+/**
+ * Fortis APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { boolean, expandoObject, number, optional, Schema } from '../schema.js';
+
+export interface Settings {
+  /** Enabled */
+  enabled?: boolean;
+  /** Columns */
+  columns?: number;
+  /** Rows */
+  rows?: number;
+  [key: string]: unknown;
+}
+
+export const settingsSchema: Schema<Settings> = expandoObject({
+  enabled: ['enabled', optional(boolean())],
+  columns: ['columns', optional(number())],
+  rows: ['rows', optional(number())],
+});

package/src/models/severityEnum.ts

@@ -0,0 +1,24 @@
+/**
+ * Fortis APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for SeverityEnum
+ */
+export enum SeverityEnum {
+  Enum01 = '01',
+  Enum02 = '02',
+  Enum03 = '03',
+  Enum04 = '04',
+}
+
+/**
+ * Schema for SeverityEnum
+ */
+export const severityEnumSchema: Schema<SeverityEnum> = stringEnum(
+  SeverityEnum
+);

package/src/models/shipAddressUsageIndEnum.ts

@@ -0,0 +1,24 @@
+/**
+ * Fortis APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for ShipAddressUsageIndEnum
+ */
+export enum ShipAddressUsageIndEnum {
+  Enum01 = '01',
+  Enum02 = '02',
+  Enum03 = '03',
+  Enum04 = '04',
+}
+
+/**
+ * Schema for ShipAddressUsageIndEnum
+ */
+export const shipAddressUsageIndEnumSchema: Schema<ShipAddressUsageIndEnum> = stringEnum(
+  ShipAddressUsageIndEnum
+);

package/src/models/shipIndicatorEnum.ts

@@ -0,0 +1,30 @@
+/**
+ * Fortis APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for ShipIndicatorEnum
+ */
+export enum ShipIndicatorEnum {
+  Enum01 = '01',
+  Enum02 = '02',
+  Enum03 = '03',
+  Enum04 = '04',
+  Enum05 = '05',
+  Enum07 = '07',
+  Enum08 = '08',
+  Enum09 = '09',
+  Enum80 = '80',
+  Enum81 = '81',
+}
+
+/**
+ * Schema for ShipIndicatorEnum
+ */
+export const shipIndicatorEnumSchema: Schema<ShipIndicatorEnum> = stringEnum(
+  ShipIndicatorEnum
+);

package/src/models/shipNameIndicatorEnum.ts

@@ -0,0 +1,22 @@
+/**
+ * Fortis APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for ShipNameIndicatorEnum
+ */
+export enum ShipNameIndicatorEnum {
+  Enum01 = '01',
+  Enum02 = '02',
+}
+
+/**
+ * Schema for ShipNameIndicatorEnum
+ */
+export const shipNameIndicatorEnumSchema: Schema<ShipNameIndicatorEnum> = stringEnum(
+  ShipNameIndicatorEnum
+);

package/src/models/shippingAddress.ts

@@ -0,0 +1,57 @@
+/**
+ * Fortis APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { expandoObject, optional, Schema, string } from '../schema.js';
+
+/** Cardholder shipping address object */
+export interface ShippingAddress {
+  /**
+   * The city of the Cardholder shipping address associated with the card used for this purchase.
+   * This field is required unless market or regional mandate restricts sending this information.
+   */
+  city?: string;
+  /**
+   * The ISO 3166-1 alpha-3 or alpha-2 country of the Cardholder shipping address associated with the card used for this purchase.
+   * The field is required if Cardholder Shipping Address State is present and unless market or regional mandate restricts sending this information.
+   */
+  countryCode?: string;
+  /**
+   * First line of the street address or equivalent local portion of the Cardholder shipping address associated with the card use for this purchase.
+   * This field is required unless market or regional mandate restricts sending this information.
+   */
+  addressLine1?: string;
+  /**
+   * Second line of the street address or equivalent local portion of the Cardholder shipping address associated with the card use for this purchase.
+   * This field is required unless market or regional mandate restricts sending this information.
+   */
+  addressLine2?: string;
+  /**
+   * Third line of the street address or equivalent local portion of the Cardholder shipping address associated with the card use for this purchase.
+   * This field is required unless market or regional mandate restricts sending this information.
+   */
+  addressLine3?: string;
+  /**
+   * ZIP or other postal code of the Cardholder shipping address associated with the card used for this purchase.
+   * This field is required unless market or regional mandate restricts sending this information.
+   */
+  postalCode?: string;
+  /**
+   * The state or province of the Cardholder shipping address associated with the card used for this purchase. The value should be the country subdivision code defined in ISO 3166-2.
+   * This field is required unless State is not applicable for this country and unless market or regional mandate restricts sending this information.
+   */
+  state?: string;
+  [key: string]: unknown;
+}
+
+export const shippingAddressSchema: Schema<ShippingAddress> = expandoObject({
+  city: ['city', optional(string())],
+  countryCode: ['country_code', optional(string())],
+  addressLine1: ['address_line_1', optional(string())],
+  addressLine2: ['address_line_2', optional(string())],
+  addressLine3: ['address_line_3', optional(string())],
+  postalCode: ['postal_code', optional(string())],
+  state: ['state', optional(string())],
+});

package/src/models/signature.ts

@@ -0,0 +1,38 @@
+/**
+ * Fortis APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { expandoObject, number, optional, Schema, string } from '../schema.js';
+import { ResourceEnum, resourceEnumSchema } from './resourceEnum.js';
+
+/** Signature Information on `expand` */
+export interface Signature {
+  /** Signature */
+  signature?: string;
+  /**
+   * Resource
+   * >Recurring, Transaction, AccountVault, DeviceTerm
+   * >
+   */
+  resource?: ResourceEnum;
+  /** Resource ID */
+  resourceId?: string;
+  /** Signature ID */
+  id?: string;
+  /** Created Time Stamp */
+  createdTs?: number;
+  /** Modified Time Stamp */
+  modifiedTs?: number;
+  [key: string]: unknown;
+}
+
+export const signatureSchema: Schema<Signature> = expandoObject({
+  signature: ['signature', optional(string())],
+  resource: ['resource', optional(resourceEnumSchema)],
+  resourceId: ['resource_id', optional(string())],
+  id: ['id', optional(string())],
+  createdTs: ['created_ts', optional(number())],
+  modifiedTs: ['modified_ts', optional(number())],
+});

package/src/models/smsBlacklist.ts

@@ -0,0 +1,35 @@
+/**
+ * Fortis APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  boolean,
+  expandoObject,
+  nullable,
+  number,
+  optional,
+  Schema,
+  string,
+} from '../schema.js';
+
+/** Sms Blacklist Information on `expand` */
+export interface SmsBlacklist {
+  /** Blacklist ID */
+  id?: string | null;
+  /** isBlacklisted */
+  isBlacklisted?: boolean;
+  /** Contact Id */
+  detail?: boolean;
+  /** Created Time Stamp */
+  createdTs?: number | null;
+  [key: string]: unknown;
+}
+
+export const smsBlacklistSchema: Schema<SmsBlacklist> = expandoObject({
+  id: ['id', optional(nullable(string()))],
+  isBlacklisted: ['isBlacklisted', optional(boolean())],
+  detail: ['detail', optional(boolean())],
+  createdTs: ['created_ts', optional(nullable(number()))],
+});

package/src/models/smsEnum.ts

@@ -0,0 +1,20 @@
+/**
+ * Fortis APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, numberEnum } from '../schema.js';
+
+/**
+ * Enum for SmsEnum
+ */
+export enum SmsEnum {
+  Enum0 = 0,
+  Enum1 = 1,
+}
+
+/**
+ * Schema for SmsEnum
+ */
+export const smsEnumSchema: Schema<SmsEnum> = numberEnum(SmsEnum);

package/src/models/sort.ts

@@ -0,0 +1,25 @@
+/**
+ * Fortis APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { array, expandoObject, lazy, optional, Schema } from '../schema.js';
+import { Field, fieldSchema } from './field.js';
+import { Type4Enum, type4EnumSchema } from './type4Enum.js';
+
+/** Sort information used on the results */
+export interface Sort {
+  /** Object type */
+  type?: Type4Enum;
+  /** [object Object] */
+  fields?: Field[];
+  [key: string]: unknown;
+}
+
+export const sortSchema: Schema<Sort> = lazy(() =>
+  expandoObject({
+    type: ['type', optional(type4EnumSchema)],
+    fields: ['fields', optional(array(fieldSchema))],
+  })
+);

package/src/models/sourceEnum.ts

@@ -0,0 +1,21 @@
+/**
+ * Fortis APILib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for SourceEnum
+ */
+export enum SourceEnum {
+  Enum01 = '01',
+  Enum02 = '02',
+  Enum03 = '03',
+}
+
+/**
+ * Schema for SourceEnum
+ */
+export const sourceEnumSchema: Schema<SourceEnum> = stringEnum(SourceEnum);