From acbb1a7073aff12e4e171f68f8a2c035f0837b00 Mon Sep 17 00:00:00 2001 From: Adam Shannon Date: Tue, 21 Jun 2022 14:26:40 -0500 Subject: [PATCH] feat: update to ach v1.18.1 and openapi-generator v6.0.0 --- .openapi-generator/FILES | 7 + .openapi-generator/VERSION | 2 +- api.ts | 1818 ++++++----- base.ts | 9 +- common.ts | 138 + configuration.ts | 40 +- docs/.nojekyll | 1 + docs/assets/css/main.css | 2679 ----------------- docs/assets/highlight.css | 99 + docs/assets/icons.css | 1043 +++++++ docs/assets/{images => }/icons.png | Bin docs/assets/{images => }/icons@2x.png | Bin docs/assets/js/main.js | 1 - docs/assets/js/search.json | 1 - docs/assets/main.js | 52 + docs/assets/search.js | 1 + docs/assets/style.css | 1414 +++++++++ docs/assets/{images => }/widgets.png | Bin docs/assets/{images => }/widgets@2x.png | Bin docs/classes/_api_.achfilesapi.html | 1122 ------- docs/classes/_base_.baseapi.html | 271 -- docs/classes/_base_.requirederror.html | 303 -- .../_configuration_.configuration.html | 352 --- docs/classes/api.ACHFilesApi.html | 108 + docs/classes/base.BaseAPI.html | 1 + docs/classes/base.RequiredError.html | 1 + docs/classes/configuration.Configuration.html | 36 + docs/enums/_api_.offsetaccounttypeenum.html | 292 -- docs/globals.html | 137 - docs/index.html | 210 +- docs/interfaces/_api_.addenda02.html | 564 ---- docs/interfaces/_api_.addenda05.html | 396 --- docs/interfaces/_api_.addenda10.html | 444 --- docs/interfaces/_api_.addenda11.html | 396 --- docs/interfaces/_api_.addenda12.html | 396 --- docs/interfaces/_api_.addenda13.html | 420 --- docs/interfaces/_api_.addenda14.html | 444 --- docs/interfaces/_api_.addenda15.html | 396 --- docs/interfaces/_api_.addenda16.html | 396 --- docs/interfaces/_api_.addenda17.html | 396 --- docs/interfaces/_api_.addenda18.html | 468 --- docs/interfaces/_api_.addenda98.html | 444 --- docs/interfaces/_api_.addenda99.html | 468 --- docs/interfaces/_api_.advbatchcontrol.html | 492 --- docs/interfaces/_api_.adventrydetail.html | 684 ----- docs/interfaces/_api_.batch.html | 360 --- docs/interfaces/_api_.batchcontrol.html | 516 ---- docs/interfaces/_api_.batchheader.html | 540 ---- docs/interfaces/_api_.createfile.html | 426 --- docs/interfaces/_api_.entrydetail.html | 651 ---- docs/interfaces/_api_.filecontrol.html | 444 --- docs/interfaces/_api_.fileheader.html | 444 --- docs/interfaces/_api_.fileid.html | 324 -- docs/interfaces/_api_.iatbatch.html | 363 --- docs/interfaces/_api_.iatbatchheader.html | 660 ---- docs/interfaces/_api_.iatentrydetail.html | 795 ----- docs/interfaces/_api_.modelerror.html | 300 -- docs/interfaces/_api_.modelfile.html | 426 --- docs/interfaces/_api_.offset.html | 372 --- docs/interfaces/_api_.segmentedfiles.html | 324 -- docs/interfaces/_api_.validateopts.html | 348 --- docs/interfaces/_base_.requestargs.html | 211 -- ...onfiguration_.configurationparameters.html | 259 -- docs/interfaces/api.ADVBatchControl.html | 29 + docs/interfaces/api.ADVEntryDetail.html | 53 + docs/interfaces/api.ADVFileControl.html | 23 + docs/interfaces/api.Addenda02.html | 38 + docs/interfaces/api.Addenda05.html | 17 + docs/interfaces/api.Addenda10.html | 23 + docs/interfaces/api.Addenda11.html | 17 + docs/interfaces/api.Addenda12.html | 17 + docs/interfaces/api.Addenda13.html | 20 + docs/interfaces/api.Addenda14.html | 23 + docs/interfaces/api.Addenda15.html | 17 + docs/interfaces/api.Addenda16.html | 17 + docs/interfaces/api.Addenda17.html | 17 + docs/interfaces/api.Addenda18.html | 26 + docs/interfaces/api.Addenda98.html | 23 + docs/interfaces/api.Addenda99.html | 26 + docs/interfaces/api.Addenda99Contested.html | 32 + docs/interfaces/api.Addenda99Dishonored.html | 44 + docs/interfaces/api.Batch.html | 6 + docs/interfaces/api.BatchControl.html | 32 + docs/interfaces/api.BatchHeader.html | 38 + docs/interfaces/api.CreateFile.html | 11 + docs/interfaces/api.EntryDetail.html | 46 + docs/interfaces/api.FileControl.html | 23 + docs/interfaces/api.FileHeader.html | 29 + docs/interfaces/api.FileID.html | 8 + docs/interfaces/api.IATBatch.html | 8 + docs/interfaces/api.IATBatchHeader.html | 50 + docs/interfaces/api.IATEntryDetail.html | 49 + docs/interfaces/api.ModelError.html | 5 + docs/interfaces/api.ModelFile.html | 12 + docs/interfaces/api.Offset.html | 14 + docs/interfaces/api.SegmentedFiles.html | 8 + docs/interfaces/api.ValidateOpts.html | 11 + docs/interfaces/base.RequestArgs.html | 2 + ...configuration.ConfigurationParameters.html | 8 + docs/interfaces/url.Url.html | 1 + docs/modules.html | 1 + docs/modules/_api_.html | 2323 -------------- docs/modules/_base_.html | 243 -- docs/modules/_configuration_.html | 149 - docs/modules/_index_.html | 481 --- docs/modules/api.html | 277 ++ docs/modules/base.html | 1 + docs/modules/common.html | 2 + docs/modules/configuration.html | 1 + docs/modules/index.html | 1 + docs/modules/url.html | 1 + git_push.sh | 7 +- index.ts | 6 +- makefile | 2 +- 114 files changed, 5173 insertions(+), 23850 deletions(-) create mode 100644 .openapi-generator/FILES create mode 100644 common.ts create mode 100644 docs/.nojekyll delete mode 100644 docs/assets/css/main.css create mode 100644 docs/assets/highlight.css create mode 100644 docs/assets/icons.css rename docs/assets/{images => }/icons.png (100%) rename docs/assets/{images => }/icons@2x.png (100%) delete mode 100644 docs/assets/js/main.js delete mode 100644 docs/assets/js/search.json create mode 100644 docs/assets/main.js create mode 100644 docs/assets/search.js create mode 100644 docs/assets/style.css rename docs/assets/{images => }/widgets.png (100%) rename docs/assets/{images => }/widgets@2x.png (100%) delete mode 100644 docs/classes/_api_.achfilesapi.html delete mode 100644 docs/classes/_base_.baseapi.html delete mode 100644 docs/classes/_base_.requirederror.html delete mode 100644 docs/classes/_configuration_.configuration.html create mode 100644 docs/classes/api.ACHFilesApi.html create mode 100644 docs/classes/base.BaseAPI.html create mode 100644 docs/classes/base.RequiredError.html create mode 100644 docs/classes/configuration.Configuration.html delete mode 100644 docs/enums/_api_.offsetaccounttypeenum.html delete mode 100644 docs/globals.html delete mode 100644 docs/interfaces/_api_.addenda02.html delete mode 100644 docs/interfaces/_api_.addenda05.html delete mode 100644 docs/interfaces/_api_.addenda10.html delete mode 100644 docs/interfaces/_api_.addenda11.html delete mode 100644 docs/interfaces/_api_.addenda12.html delete mode 100644 docs/interfaces/_api_.addenda13.html delete mode 100644 docs/interfaces/_api_.addenda14.html delete mode 100644 docs/interfaces/_api_.addenda15.html delete mode 100644 docs/interfaces/_api_.addenda16.html delete mode 100644 docs/interfaces/_api_.addenda17.html delete mode 100644 docs/interfaces/_api_.addenda18.html delete mode 100644 docs/interfaces/_api_.addenda98.html delete mode 100644 docs/interfaces/_api_.addenda99.html delete mode 100644 docs/interfaces/_api_.advbatchcontrol.html delete mode 100644 docs/interfaces/_api_.adventrydetail.html delete mode 100644 docs/interfaces/_api_.batch.html delete mode 100644 docs/interfaces/_api_.batchcontrol.html delete mode 100644 docs/interfaces/_api_.batchheader.html delete mode 100644 docs/interfaces/_api_.createfile.html delete mode 100644 docs/interfaces/_api_.entrydetail.html delete mode 100644 docs/interfaces/_api_.filecontrol.html delete mode 100644 docs/interfaces/_api_.fileheader.html delete mode 100644 docs/interfaces/_api_.fileid.html delete mode 100644 docs/interfaces/_api_.iatbatch.html delete mode 100644 docs/interfaces/_api_.iatbatchheader.html delete mode 100644 docs/interfaces/_api_.iatentrydetail.html delete mode 100644 docs/interfaces/_api_.modelerror.html delete mode 100644 docs/interfaces/_api_.modelfile.html delete mode 100644 docs/interfaces/_api_.offset.html delete mode 100644 docs/interfaces/_api_.segmentedfiles.html delete mode 100644 docs/interfaces/_api_.validateopts.html delete mode 100644 docs/interfaces/_base_.requestargs.html delete mode 100644 docs/interfaces/_configuration_.configurationparameters.html create mode 100644 docs/interfaces/api.ADVBatchControl.html create mode 100644 docs/interfaces/api.ADVEntryDetail.html create mode 100644 docs/interfaces/api.ADVFileControl.html create mode 100644 docs/interfaces/api.Addenda02.html create mode 100644 docs/interfaces/api.Addenda05.html create mode 100644 docs/interfaces/api.Addenda10.html create mode 100644 docs/interfaces/api.Addenda11.html create mode 100644 docs/interfaces/api.Addenda12.html create mode 100644 docs/interfaces/api.Addenda13.html create mode 100644 docs/interfaces/api.Addenda14.html create mode 100644 docs/interfaces/api.Addenda15.html create mode 100644 docs/interfaces/api.Addenda16.html create mode 100644 docs/interfaces/api.Addenda17.html create mode 100644 docs/interfaces/api.Addenda18.html create mode 100644 docs/interfaces/api.Addenda98.html create mode 100644 docs/interfaces/api.Addenda99.html create mode 100644 docs/interfaces/api.Addenda99Contested.html create mode 100644 docs/interfaces/api.Addenda99Dishonored.html create mode 100644 docs/interfaces/api.Batch.html create mode 100644 docs/interfaces/api.BatchControl.html create mode 100644 docs/interfaces/api.BatchHeader.html create mode 100644 docs/interfaces/api.CreateFile.html create mode 100644 docs/interfaces/api.EntryDetail.html create mode 100644 docs/interfaces/api.FileControl.html create mode 100644 docs/interfaces/api.FileHeader.html create mode 100644 docs/interfaces/api.FileID.html create mode 100644 docs/interfaces/api.IATBatch.html create mode 100644 docs/interfaces/api.IATBatchHeader.html create mode 100644 docs/interfaces/api.IATEntryDetail.html create mode 100644 docs/interfaces/api.ModelError.html create mode 100644 docs/interfaces/api.ModelFile.html create mode 100644 docs/interfaces/api.Offset.html create mode 100644 docs/interfaces/api.SegmentedFiles.html create mode 100644 docs/interfaces/api.ValidateOpts.html create mode 100644 docs/interfaces/base.RequestArgs.html create mode 100644 docs/interfaces/configuration.ConfigurationParameters.html create mode 100644 docs/interfaces/url.Url.html create mode 100644 docs/modules.html delete mode 100644 docs/modules/_api_.html delete mode 100644 docs/modules/_base_.html delete mode 100644 docs/modules/_configuration_.html delete mode 100644 docs/modules/_index_.html create mode 100644 docs/modules/api.html create mode 100644 docs/modules/base.html create mode 100644 docs/modules/common.html create mode 100644 docs/modules/configuration.html create mode 100644 docs/modules/index.html create mode 100644 docs/modules/url.html diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES new file mode 100644 index 0000000..4e2120c --- /dev/null +++ b/.openapi-generator/FILES @@ -0,0 +1,7 @@ +.npmignore +api.ts +base.ts +common.ts +configuration.ts +git_push.sh +index.ts diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION index ecedc98..f4965a3 100644 --- a/.openapi-generator/VERSION +++ b/.openapi-generator/VERSION @@ -1 +1 @@ -4.3.1 \ No newline at end of file +6.0.0 \ No newline at end of file diff --git a/api.ts b/api.ts index 12cf3e1..ff88732 100644 --- a/api.ts +++ b/api.ts @@ -1,7 +1,8 @@ -// tslint:disable +/* tslint:disable */ +/* eslint-disable */ /** * ACH API - * Moov ACH ([Automated Clearing House](https://en.wikipedia.org/wiki/Automated_Clearing_House)) implements an HTTP API for creating, parsing and validating ACH files. ACH is the primary method of electronic money movement throughout the United States. + * Moov ACH ([Automated Clearing House](https://en.wikipedia.org/wiki/Automated_Clearing_House)) implements an HTTP API for creating, parsing, and validating ACH files. ACH is the primary method of electronic money movement throughout the United States. * * The version of the OpenAPI document: v1 * @@ -12,11 +13,12 @@ */ -import * as globalImportUrl from 'url'; import { Configuration } from './configuration'; -import globalAxios, { AxiosPromise, AxiosInstance } from 'axios'; +import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; // Some imports not used depending on template conditions // @ts-ignore +import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; +// @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base'; /** @@ -30,55 +32,55 @@ export interface ADVBatchControl { * @type {string} * @memberof ADVBatchControl */ - ID?: string; + 'ID'?: string; /** * Same as ServiceClassCode in BatchHeader record * @type {number} * @memberof ADVBatchControl */ - serviceClassCode?: number; + 'serviceClassCode': number; /** * EntryAddendaCount is a tally of each Entry Detail Record and each Addenda Record processed, within either the batch or file as appropriate. * @type {number} * @memberof ADVBatchControl */ - entryAddendaCount?: number; + 'entryAddendaCount': number; /** * Validate the Receiving DFI Identification in each Entry Detail Record is hashed to provide a check against inadvertent alteration of data contents due to hardware failure or program error. In this context the Entry Hash is the sum of the corresponding fields in the Entry Detail Records on the file. * @type {number} * @memberof ADVBatchControl */ - entryHash?: number; + 'entryHash': number; /** * Contains accumulated Entry debit totals within the batch. * @type {number} * @memberof ADVBatchControl */ - totalDebit?: number; + 'totalDebit': number; /** * Contains accumulated Entry credit totals within the batch. * @type {number} * @memberof ADVBatchControl */ - totalCredit?: number; + 'totalCredit': number; /** * Alphanumeric code used to identify an ACH Operator * @type {string} * @memberof ADVBatchControl */ - achOperatorData?: string; + 'achOperatorData': string; /** * The routing number is used to identify the DFI originating entries within a given branch. * @type {string} * @memberof ADVBatchControl */ - ODFIIdentification?: string; + 'ODFIIdentification': string; /** * BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record. - * @type {string} + * @type {number} * @memberof ADVBatchControl */ - batchNumber?: string; + 'batchNumber': number; } /** * @@ -91,103 +93,152 @@ export interface ADVEntryDetail { * @type {string} * @memberof ADVEntryDetail */ - ID?: string; + 'ID'?: string; /** - * TransactionCode representing Accounting Entries Credit for ACH debits originated - 81 Debit for ACH credits originated - 82 Credit for ACH credits received 83 Debit for ACH debits received 84 Credit for ACH credits in rejected batches 85 Debit for ACH debits in rejected batches - 86 Summary credit for respondent ACH activity - 87 Summary debit for respondent ACH activity - 88 + * TransactionCode representing Accounting Entries: 81 - Credit for ACH debits originated | 82 - Debit for ACH credits originated | 83 - Credit for ACH credits received | 84 - Debit for ACH debits received | 85 - Credit for ACH credits in rejected batches | 86 - Debit for ACH debits in rejected batches | 87 - Summary credit for respondent ACH activity | 88 - Summary debit for respondent ACH activity * @type {number} * @memberof ADVEntryDetail */ - transactionCode: number; + 'transactionCode': number; /** * RDFI\'s routing number without the last digit. * @type {string} * @memberof ADVEntryDetail */ - RDFIIdentification: string; + 'RDFIIdentification': string; /** * Last digit in RDFI routing number. * @type {string} * @memberof ADVEntryDetail */ - checkDigit: string; + 'checkDigit': string; /** - * The receiver\'s bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so its space padded, no zero padded + * The receiver\'s bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so it\'s space padded, not zero padded * @type {string} * @memberof ADVEntryDetail */ - DFIAccountNumber: string; + 'DFIAccountNumber': string; /** * Number of cents you are debiting/crediting this account * @type {number} * @memberof ADVEntryDetail */ - amount: number; + 'amount': number; /** * Suggested routing number to use * @type {string} * @memberof ADVEntryDetail */ - adviceRoutingNumber?: string; + 'adviceRoutingNumber': string; /** * Unique identifier for the File * @type {string} * @memberof ADVEntryDetail */ - fileIdentification?: string; + 'fileIdentification'?: string; /** * Information related to the ACH opreator * @type {string} * @memberof ADVEntryDetail */ - achOperatorData?: string; + 'achOperatorData'?: string; /** * The name of the receiver, usually the name on the bank account * @type {string} * @memberof ADVEntryDetail */ - individualName: string; + 'individualName': string; /** - * DiscretionaryData allows ODFIs to include codes, of significance only to them, to enable specialized handling of the entry. There will be no standardized interpretation for the value of this field. It can either be a single two-character code, or two distinct one-character codes, according to the needs of the ODFI and/or Originator involved. This field must be returned intact for any returned entry. WEB uses the Discretionary Data Field as the Payment Type Code + * DiscretionaryData allows ODFIs to include codes, of significance only to them, to enable specialized handling of the entry. There will be no standardized interpretation for the value of this field. It can either be a single two-character code, or two distinct one-character codes, according to the needs of the ODFI and/or Originator involved. This field must be returned intact for any returned entry. WEB uses the Discretionary Data Field as the Payment Type Code. * @type {string} * @memberof ADVEntryDetail */ - discretionaryData?: string; + 'discretionaryData'?: string; /** - * AddendaRecordIndicator indicates the existence of an Addenda Record. A value of \"1\" indicates that one ore more addenda records follow, and \"0\" means no such record is present. + * AddendaRecordIndicator indicates the existence of an Addenda Record. A value of \"1\" indicates that one or more addenda records follow, and \"0\" means no such record is present. * @type {number} * @memberof ADVEntryDetail */ - addendaRecordIndicator?: number; + 'addendaRecordIndicator'?: number; /** - * Routing number for ACH operator + * Routing number for ACH Operator * @type {string} * @memberof ADVEntryDetail */ - achOperatorRoutingNumber?: string; + 'achOperatorRoutingNumber': string; /** * Julian Day of the year * @type {number} * @memberof ADVEntryDetail */ - julianDay?: number; + 'julianDay'?: number; /** - * SequenceNumber is consecutively assigned to each Addenda05 Record following an Entry Detail Record. The first addenda05 sequence number must always be a 1. + * SequenceNumber is consecutively assigned to each Addenda05 Record following an Entry Detail Record. The first Addenda05 sequence number must always be a 1. * @type {number} * @memberof ADVEntryDetail */ - sequenceNumber?: number; + 'sequenceNumber': number; /** - * Addenda99 record for the Entry Detail + * Addenda99 record for the ADV Entry Detail * @type {Array} * @memberof ADVEntryDetail */ - addenda99?: Array; + 'addenda99'?: Array; /** * Category defines if the entry is a Forward, Return, or NOC * @type {string} * @memberof ADVEntryDetail */ - category?: string; + 'category'?: string; +} +/** + * + * @export + * @interface ADVFileControl + */ +export interface ADVFileControl { + /** + * ADV File Control Record + * @type {string} + * @memberof ADVFileControl + */ + 'ID': string; + /** + * Count of Batches in the File + * @type {number} + * @memberof ADVFileControl + */ + 'batchCount': number; + /** + * Total number of records in the file (include all headers and trailer) divided by 10 (This number must be evenly divisible by 10. If not, additional records consisting of all 9\'s are added to the file after the initial \'9\' record to fill out the block 10.) + * @type {number} + * @memberof ADVFileControl + */ + 'blockCount': number; + /** + * Total detail and addenda records in the file + * @type {number} + * @memberof ADVFileControl + */ + 'entryAddendaCount': number; + /** + * Calculated in the same manner as the batch total but includes total from entire file + * @type {number} + * @memberof ADVFileControl + */ + 'entryHash': number; + /** + * Accumulated Batch debit totals within the file. + * @type {number} + * @memberof ADVFileControl + */ + 'totalDebit': number; + /** + * Accumulated Batch credit totals within the file. + * @type {number} + * @memberof ADVFileControl + */ + 'totalCredit': number; } /** * @@ -196,77 +247,77 @@ export interface ADVEntryDetail { */ export interface Addenda02 { /** - * Client defined string used as a reference to this record. + * Client-defined string used as a reference to this record. * @type {string} * @memberof Addenda02 */ - id?: string; + 'id'?: string; /** * 02 - NACHA regulations * @type {string} * @memberof Addenda02 */ - typeCode?: string; + 'typeCode': string; /** * ReferenceInformationOne may be used for additional reference numbers, identification numbers, or codes that the merchant needs to identify the particular transaction or customer. * @type {string} * @memberof Addenda02 */ - referenceInformationOne?: string; + 'referenceInformationOne'?: string; /** - * ReferenceInformationTwo may be used for additional reference numbers, identification numbers, or codes that the merchant needs to identify the particular transaction or customer. + * ReferenceInformationTwo may be used for additional reference numbers, identification numbers, or codes that the merchant needs to identify the particular transaction or customer. * @type {string} * @memberof Addenda02 */ - referenceInformationTwo?: string; + 'referenceInformationTwo'?: string; /** * TerminalIdentificationCode identifies an Electronic terminal with a unique code that allows a terminal owner and/or switching network to identify the terminal at which an Entry originated. * @type {string} * @memberof Addenda02 */ - terminalIdentificationCode?: string; + 'terminalIdentificationCode': string; /** * TransactionSerialNumber is assigned by the terminal at the time the transaction is originated. The number, with the Terminal Identification Code, serves as an audit trail for the transaction and is usually assigned in ascending sequence. * @type {string} * @memberof Addenda02 */ - transactionSerialNumber?: string; + 'transactionSerialNumber': string; /** - * MMDD formatted timestamp identifies the date on which the transaction occurred. + * Timestamp identifies the date on which the transaction occurred. (Format MMDD - M=Month, D=Day) * @type {string} * @memberof Addenda02 */ - transactionDate?: string; + 'transactionDate': string; /** * Indicates the code that a card authorization center has furnished to the merchant. * @type {string} * @memberof Addenda02 */ - authorizationCodeOrExpireDate?: string; + 'authorizationCodeOrExpireDate'?: string; /** * Identifies the specific location of a terminal (i.e., street names of an intersection, address, etc.) in accordance with the requirements of Regulation E. * @type {string} * @memberof Addenda02 */ - terminalLocation?: string; + 'terminalLocation': string; /** * Identifies the city in which the electronic terminal is located. * @type {string} * @memberof Addenda02 */ - terminalCity?: string; + 'terminalCity': string; /** - * Identifies the state in which the electronic terminal is located + * Identifies the state in which the electronic terminal is located. * @type {string} * @memberof Addenda02 */ - terminalState?: string; + 'terminalState': string; /** * Entry Detail Trace Number * @type {string} * @memberof Addenda02 */ - traceNumber?: string; + 'traceNumber'?: string; } /** * @@ -275,35 +326,35 @@ export interface Addenda02 { */ export interface Addenda05 { /** - * Client defined string used as a reference to this record. + * Client-defined string used as a reference to this record. * @type {string} * @memberof Addenda05 */ - id?: string; + 'id'?: string; /** * 05 - NACHA regulations * @type {string} * @memberof Addenda05 */ - typeCode?: string; + 'typeCode': string; /** * Text for describing the related payment * @type {string} * @memberof Addenda05 */ - paymentRelatedInformation?: string; + 'paymentRelatedInformation': string; /** - * SequenceNumber is consecutively assigned to each Addenda05 Record following an Entry Detail Record. The first addenda05 sequence number must always be a 1. + * SequenceNumber is consecutively assigned to each Addenda05 Record following an Entry Detail Record. The first Addenda05 sequence number must always be a 1. * @type {number} * @memberof Addenda05 */ - sequenceNumber?: number; + 'sequenceNumber': number; /** - * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. + * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. * @type {number} * @memberof Addenda05 */ - entryDetailSequenceNumber?: number; + 'entryDetailSequenceNumber': number; } /** * @@ -312,47 +363,47 @@ export interface Addenda05 { */ export interface Addenda10 { /** - * Client defined string used as a reference to this record. + * Client-defined string used as a reference to this record. * @type {string} * @memberof Addenda10 */ - id?: string; + 'id'?: string; /** * 10 - NACHA regulations * @type {string} * @memberof Addenda10 */ - typeCode?: string; + 'typeCode': string; /** - * Transaction Type Code Describes the type of payment ANN = Annuity BUS = Business/Commercial DEP = Deposit LOA = Loan MIS = Miscellaneous MOR = Mortgage PEN = Pension RLS = Rent/Lease REM = Remittance2 SAL = Salary/Payroll TAX = Tax TEL = Telephone-Initiated Transaction WEB = Internet-Initiated Transaction ARC = Accounts Receivable Entry BOC = Back Office Conversion Entry POP = Point of Purchase Entry RCK = Re-presented Check Entry + * Describes the type of payment: \'ANN\' = Annuity | \'BUS\' = Business/Commercial | \'DEP\' = Deposit | \'LOA\' = Loan | \'MIS\' = Miscellaneous | \'MOR\' = Mortgage | \'PEN\' = Pension | \'RLS\' = Rent/Lease | \'REM\' = Remittance2 | \'SAL\' = Salary/Payroll | \'TAX\' = Tax | \'TEL\' = Telephone-Initiated Transaction | \'WEB\' = Internet-Initiated Transaction | \'ARC\' = Accounts Receivable Entry | \'BOC\' = Back Office Conversion Entry | \'POP\' = Point of Purchase Entry | \'RCK\' = Re-presented Check Entry * @type {string} * @memberof Addenda10 */ - transactionTypeCode?: string; + 'transactionTypeCode'?: string; /** * For inbound IAT payments this field should contain the USD amount or may be blank. * @type {number} * @memberof Addenda10 */ - foreignPaymentAmount?: number; + 'foreignPaymentAmount': number; /** * Trace number * @type {string} * @memberof Addenda10 */ - foreignTraceNumber?: string; + 'foreignTraceNumber'?: string; /** * Receiving Company Name/Individual Name * @type {string} * @memberof Addenda10 */ - name?: string; + 'name': string; /** - * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. + * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. * @type {number} * @memberof Addenda10 */ - entryDetailSequenceNumber?: number; + 'entryDetailSequenceNumber': number; } /** * @@ -361,35 +412,35 @@ export interface Addenda10 { */ export interface Addenda11 { /** - * Client defined string used as a reference to this record. + * Client-defined string used as a reference to this record. * @type {string} * @memberof Addenda11 */ - id?: string; + 'id'?: string; /** - * 10 - NACHA regulations + * 11 - NACHA regulations * @type {string} * @memberof Addenda11 */ - typeCode?: string; + 'typeCode': string; /** - * Originators name (your company name / name) + * Originator\'s name (your company name / name) * @type {string} * @memberof Addenda11 */ - originatorName?: string; + 'originatorName': string; /** - * Originators street address + * Originator\'s street address * @type {string} * @memberof Addenda11 */ - originatorStreetAddress?: string; + 'originatorStreetAddress': string; /** - * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. + * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. * @type {number} * @memberof Addenda11 */ - entryDetailSequenceNumber?: number; + 'entryDetailSequenceNumber': number; } /** * @@ -398,35 +449,35 @@ export interface Addenda11 { */ export interface Addenda12 { /** - * Client defined string used as a reference to this record. + * Client-defined string used as a reference to this record. * @type {string} * @memberof Addenda12 */ - id?: string; + 'id'?: string; /** - * 10 - NACHA regulations + * 12 - NACHA regulations * @type {string} * @memberof Addenda12 */ - typeCode?: string; + 'typeCode': string; /** - * Originator City & State / Province Data elements City and State / Province should be separated with an asterisk (*) as a delimiter and the field should end with a backslash (\\). + * Originator City & State / Province Data elements City and State / Province should be separated with an asterisk (*) as a delimiter and the field should end with a backslash (\\\\). * @type {string} * @memberof Addenda12 */ - originatorCityStateProvince?: string; + 'originatorCityStateProvince': string; /** - * Originator Country & Postal Code Data elements must be separated by an asterisk (*) and must end with a backslash (\\) + * Originator Country & Postal Code Data elements must be separated by an asterisk (*) and must end with a backslash (\\\\). * @type {string} * @memberof Addenda12 */ - originatorCountryPostalCode?: string; + 'originatorCountryPostalCode': string; /** - * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. + * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. * @type {number} * @memberof Addenda12 */ - entryDetailSequenceNumber?: number; + 'entryDetailSequenceNumber': number; } /** * @@ -435,41 +486,41 @@ export interface Addenda12 { */ export interface Addenda13 { /** - * Client defined string used as a reference to this record. + * Client-defined string used as a reference to this record. * @type {string} * @memberof Addenda13 */ - id?: string; + 'id'?: string; /** - * 10 - NACHA regulations + * 13 - NACHA regulations * @type {string} * @memberof Addenda13 */ - typeCode?: string; + 'typeCode': string; /** * Originating DFI Name For Outbound IAT Entries, this field must contain the name of the U.S. ODFI. For Inbound IATs: Name of the foreign bank providing funding for the payment transaction * @type {string} * @memberof Addenda13 */ - ODFIName?: string; + 'ODFIName': string; /** - * Originating DFI Identification Number Qualifier For Inbound IATs: The 2-digit code that identifies the numbering scheme used in the Foreign DFI Identification Number field 01 = National Clearing System 02 = BIC Code 03 = IBAN Code + * Originating DFI Identification Number Qualifier. For Inbound IATs: The 2-digit code that identifies the numbering scheme used in the Foreign DFI Identification Number field: \'01\' = National Clearing System | \'02\' = BIC Code | \'03\' = IBAN Code * @type {string} * @memberof Addenda13 */ - ODFIIDNumberQualifier?: string; + 'ODFIIDNumberQualifier': string; /** - * Originating DFI Branch Country Code USb = United States //(\"b\" indicates a blank space) For Inbound IATs: This 3 position field contains a 2-character code as approved by the International Organization for Standardization (ISO) used to identify the country in which the branch of the bank that originated the entry is located. Values for other countries can be found on the International Organization for Standardization website: www.iso.org. + * Originating DFI Branch Country Code: USb = United States //(\"b\" indicates a blank space) For Inbound IATs: This 3 position field contains a 2-character code as approved by the International Organization for Standardization (ISO) used to identify the country in which the branch of the bank that originated the entry is located. Values for other countries can be found on the International Organization for Standardization website: www.iso.org. * @type {string} * @memberof Addenda13 */ - ODFIBranchCountryCode?: string; + 'ODFIBranchCountryCode': string; /** - * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. + * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. * @type {number} * @memberof Addenda13 */ - entryDetailSequenceNumber?: number; + 'entryDetailSequenceNumber': number; } /** * @@ -478,47 +529,47 @@ export interface Addenda13 { */ export interface Addenda14 { /** - * Client defined string used as a reference to this record. + * Client-defined string used as a reference to this record. * @type {string} * @memberof Addenda14 */ - id?: string; + 'id'?: string; /** - * 10 - NACHA regulations + * 14 - NACHA regulations * @type {string} * @memberof Addenda14 */ - typeCode?: string; + 'typeCode': string; /** * Name of the Receiver bank * @type {string} * @memberof Addenda14 */ - RDFIName?: string; + 'RDFIName': string; /** - * Receiving DFI Identification Number Qualifier The 2-digit code that identifies the numbering scheme used in the Receiving DFI Identification Number field 01 = National Clearing System 02 = BIC Code 03 = IBAN Code + * Receiving DFI Identification Number Qualifier. The 2-digit code that identifies the numbering scheme used in the Receiving DFI Identification Number field: \'01\' = National Clearing System | \'02\' = BIC Code | \'03\' = IBAN Code * @type {string} * @memberof Addenda14 */ - RDFIIDNumberQualifier?: string; + 'RDFIIDNumberQualifier': string; /** * This field contains the bank identification number of the DFI at which the Receiver maintains his account. * @type {string} * @memberof Addenda14 */ - RDFIIdentification?: string; + 'RDFIIdentification': string; /** * Receiving DFI Branch Country Code USb\" = United States (\"b\" indicates a blank space) This 3 position field contains a 2-character code as approved by the International Organization for Standardization (ISO) used to identify the country in which the branch of the bank that receives the entry is located. Values for other countries can be found on the International Organization for Standardization website: www.iso.org * @type {string} * @memberof Addenda14 */ - RDFIBranchCountryCode?: string; + 'RDFIBranchCountryCode': string; /** - * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. + * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. * @type {number} * @memberof Addenda14 */ - entryDetailSequenceNumber?: number; + 'entryDetailSequenceNumber': number; } /** * @@ -527,35 +578,35 @@ export interface Addenda14 { */ export interface Addenda15 { /** - * Client defined string used as a reference to this record. + * Client-defined string used as a reference to this record. * @type {string} * @memberof Addenda15 */ - id?: string; + 'id'?: string; /** - * 10 - NACHA regulations + * 15 - NACHA regulations * @type {string} * @memberof Addenda15 */ - typeCode?: string; + 'typeCode': string; /** * Receiver Identification Number contains the accounting number by which the Originator is known to the Receiver for descriptive purposes. NACHA Rules recommend but do not require the RDFI to print the contents of this field on the receiver\'s statement. * @type {string} * @memberof Addenda15 */ - receiverIDNumber?: string; + 'receiverIDNumber'?: string; /** * Receiver\'s physical address * @type {string} * @memberof Addenda15 */ - receiverStreetAddress?: string; + 'receiverStreetAddress': string; /** - * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. + * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. * @type {number} * @memberof Addenda15 */ - entryDetailSequenceNumber?: number; + 'entryDetailSequenceNumber': number; } /** * @@ -564,35 +615,35 @@ export interface Addenda15 { */ export interface Addenda16 { /** - * Client defined string used as a reference to this record. + * Client-defined string used as a reference to this record. * @type {string} * @memberof Addenda16 */ - id?: string; + 'id'?: string; /** - * 10 - NACHA regulations + * 16 - NACHA regulations * @type {string} * @memberof Addenda16 */ - typeCode?: string; + 'typeCode': string; /** - * Receiver City & State / Province Data elements City and State / Province should be separated with an asterisk (*) as a delimiter and the field should end with a backslash (\\). + * Receiver City & State / Province Data elements City and State / Province should be separated with an asterisk (*) as a delimiter and the field should end with a backslash (\\\\). * @type {string} * @memberof Addenda16 */ - receiverCityStateProvince?: string; + 'receiverCityStateProvince': string; /** - * Receiver Country & Postal Code Data elements must be separated by an asterisk (*) and must end with a backslash (\\) + * Receiver Country & Postal Code Data elements must be separated by an asterisk (*) and must end with a backslash (\\\\). * @type {string} * @memberof Addenda16 */ - receiverCountryPostalCode?: string; + 'receiverCountryPostalCode': string; /** - * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. + * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. * @type {number} * @memberof Addenda16 */ - entryDetailSequenceNumber?: number; + 'entryDetailSequenceNumber': number; } /** * @@ -601,35 +652,35 @@ export interface Addenda16 { */ export interface Addenda17 { /** - * Client defined string used as a reference to this record. + * Client-defined string used as a reference to this record. * @type {string} * @memberof Addenda17 */ - id?: string; + 'id'?: string; /** - * 10 - NACHA regulations + * 17 - NACHA regulations * @type {string} * @memberof Addenda17 */ - typeCode?: string; + 'typeCode': string; /** * Additional information related to the payment * @type {string} * @memberof Addenda17 */ - paymentRelatedInformation?: string; + 'paymentRelatedInformation': string; /** - * SequenceNumber is consecutively assigned to each Addenda17 Record following an Entry Detail Record. The first addenda17 sequence number must always be a 1. + * SequenceNumber is consecutively assigned to each Addenda17 Record following an Entry Detail Record. The first Addenda17 sequence number must always be a 1. * @type {number} * @memberof Addenda17 */ - sequenceNumber?: number; + 'sequenceNumber': number; /** - * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. + * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. * @type {number} * @memberof Addenda17 */ - entryDetailSequenceNumber?: number; + 'entryDetailSequenceNumber': number; } /** * @@ -638,53 +689,53 @@ export interface Addenda17 { */ export interface Addenda18 { /** - * Client defined string used as a reference to this record. + * Client-defined string used as a reference to this record. * @type {string} * @memberof Addenda18 */ - id?: string; + 'id'?: string; /** - * 10 - NACHA regulations + * 18 - NACHA regulations * @type {string} * @memberof Addenda18 */ - typeCode?: string; + 'typeCode': string; /** * Name of the Foreign Correspondent Bank * @type {string} * @memberof Addenda18 */ - foreignCorrespondentBankName?: string; + 'foreignCorrespondentBankName': string; /** - * Foreign Correspondent Bank Identification Number Qualifier contains a 2-digit code that identifies the numbering scheme used in the Foreign Correspondent Bank Identification Number field. Code values for this field are \"01\" = National Clearing System \"02\" = BIC Code \"03\" = IBAN Code + * Foreign Correspondent Bank Identification Number Qualifier contains a 2-digit code that identifies the numbering scheme used in the Foreign Correspondent Bank Identification Number field. Code values for this field are: \"01\" = National Clearing System | \"02\" = BIC Code | \"03\" = IBAN Code * @type {string} * @memberof Addenda18 */ - foreignCorrespondentBankIDNumberQualifier?: string; + 'foreignCorrespondentBankIDNumberQualifier'?: string; /** * Foreign Correspondent Bank Identification Number contains the bank ID number of the Foreign Correspondent Bank * @type {string} * @memberof Addenda18 */ - foreignCorrespondentBankIDNumber?: string; + 'foreignCorrespondentBankIDNumber': string; /** * Foreign Correspondent Bank Branch Country Code contains the two-character code, as approved by the International Organization for Standardization (ISO), to identify the country in which the branch of the Foreign Correspondent Bank is located. Values can be found on the International Organization for Standardization website: www.iso.org * @type {string} * @memberof Addenda18 */ - foreignCorrespondentBankBranchCountryCode?: string; + 'foreignCorrespondentBankBranchCountryCode': string; /** - * SequenceNumber is consecutively assigned to each Addenda17 Record following an Entry Detail Record. The first addenda17 sequence number must always be a 1. + * SequenceNumber is consecutively assigned to each Addenda17 Record following an Entry Detail Record. The first Addenda17 sequence number must always be a 1. * @type {number} * @memberof Addenda18 */ - sequenceNumber?: number; + 'sequenceNumber': number; /** - * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. + * EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record\'s trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record. * @type {number} * @memberof Addenda18 */ - entryDetailSequenceNumber?: number; + 'entryDetailSequenceNumber': number; } /** * @@ -693,47 +744,47 @@ export interface Addenda18 { */ export interface Addenda98 { /** - * Client defined string used as a reference to this record. + * Client-defined string used as a reference to this record. * @type {string} * @memberof Addenda98 */ - id?: string; + 'id'?: string; /** * 98 - NACHA regulations * @type {string} * @memberof Addenda98 */ - typeCode?: string; + 'typeCode': string; /** * ChangeCode field contains a standard code used by an ACH Operator or RDFI to describe the reason for a change Entry. * @type {string} * @memberof Addenda98 */ - changeCode?: string; + 'changeCode': string; /** * OriginalTrace This field contains the Trace Number as originally included on the forward Entry or Prenotification. The RDFI must include the Original Entry Trace Number in the Addenda Record of an Entry being returned to an ODFI, in the Addenda Record of an 98, within an Acknowledgment Entry, or with an RDFI request for a copy of an authorization. * @type {string} * @memberof Addenda98 */ - originalTrace?: string; + 'originalTrace': string; /** * The Receiving DFI Identification (addenda.RDFIIdentification) as originally included on the forward Entry or Prenotification that the RDFI is returning or correcting. * @type {string} * @memberof Addenda98 */ - originalDFI?: string; + 'originalDFI': string; /** - * Correct field value of what ChangeCode references + * Correct field value of what changeCode references * @type {string} * @memberof Addenda98 */ - correctedData?: string; + 'correctedData': string; /** * Entry Detail Trace Number * @type {string} * @memberof Addenda98 */ - traceNumber?: string; + 'traceNumber'?: string; } /** * @@ -742,53 +793,211 @@ export interface Addenda98 { */ export interface Addenda99 { /** - * Client defined string used as a reference to this record. + * Client-defined string used as a reference to this record. * @type {string} * @memberof Addenda99 */ - id?: string; + 'id'?: string; /** * 99 - NACHA regulations * @type {string} * @memberof Addenda99 */ - typeCode?: string; + 'typeCode': string; /** * Standard code used by an ACH Operator or RDFI to describe the reason for returning an Entry. * @type {string} * @memberof Addenda99 */ - returnCode?: string; + 'returnCode': string; /** * OriginalTrace This field contains the Trace Number as originally included on the forward Entry or Prenotification. The RDFI must include the Original Entry Trace Number in the Addenda Record of an Entry being returned to an ODFI, in the Addenda Record of an 98, within an Acknowledgment Entry, or with an RDFI request for a copy of an authorization. * @type {string} * @memberof Addenda99 */ - originalTrace?: string; + 'originalTrace': string; /** - * DateOfDeath The field date of death is to be supplied on Entries being returned for reason of death (return reason codes R14 and R15). Format YYMMDD (Y=Year, M=Month, D=Day) + * The field date of death is to be supplied on Entries being returned for reason of death (return reason codes R14 and R15). (Format YYMMDD - Y=Year, M=Month, D=Day) * @type {string} * @memberof Addenda99 */ - dateOfDeath?: string; + 'dateOfDeath': string; /** - * OriginalDFI field contains the Receiving DFI Identification (addenda.RDFIIdentification) as originally included on the forward Entry or Prenotification that the RDFI is returning or correcting. + * Contains the Receiving DFI Identification (addenda.RDFIIdentification) as originally included on the forward Entry or Prenotification that the RDFI is returning or correcting. * @type {string} * @memberof Addenda99 */ - originalDFI?: string; + 'originalDFI': string; /** * Information related to the return * @type {string} * @memberof Addenda99 */ - addendaInformation?: string; + 'addendaInformation'?: string; /** * Matches the Entry Detail Trace Number of the entry being returned. * @type {string} * @memberof Addenda99 */ - traceNumber?: string; + 'traceNumber'?: string; +} +/** + * + * @export + * @interface Addenda99Contested + */ +export interface Addenda99Contested { + /** + * Client-defined string used as a reference to this record. + * @type {string} + * @memberof Addenda99Contested + */ + 'id'?: string; + /** + * 99 - NACHA regulations + * @type {string} + * @memberof Addenda99Contested + */ + 'typeCode': string; + /** + * Return reason code of the Dishonored Return + * @type {string} + * @memberof Addenda99Contested + */ + 'dishonoredReturnReasonCode': string; + /** + * Trace Number of the original entry being returned. + * @type {string} + * @memberof Addenda99Contested + */ + 'originalEntryTraceNumber': string; + /** + * Identification of the Original Receiving Depository Institution (ODFI) + * @type {string} + * @memberof Addenda99Contested + */ + 'originalReceivingDFIIdentification': string; + /** + * Return trace number + * @type {string} + * @memberof Addenda99Contested + */ + 'returnTraceNumber': string; + /** + * Return settlement date + * @type {string} + * @memberof Addenda99Contested + */ + 'returnSettlementDate': string; + /** + * Return reason code + * @type {string} + * @memberof Addenda99Contested + */ + 'returnReasonCode': string; + /** + * Additional information of the Contested Dishonored Return + * @type {string} + * @memberof Addenda99Contested + */ + 'addendaInformation': string; + /** + * Unique Trace Number for the contested dishonored return + * @type {string} + * @memberof Addenda99Contested + */ + 'traceNumber': string; +} +/** + * + * @export + * @interface Addenda99Dishonored + */ +export interface Addenda99Dishonored { + /** + * Client-defined string used as a reference to this record. + * @type {string} + * @memberof Addenda99Dishonored + */ + 'id'?: string; + /** + * 99 - NACHA regulations + * @type {string} + * @memberof Addenda99Dishonored + */ + 'typeCode': string; + /** + * return code explaining the contested dishonorment + * @type {string} + * @memberof Addenda99Dishonored + */ + 'contestedReturnCode': string; + /** + * Trace Number of the original entry being returned. + * @type {string} + * @memberof Addenda99Dishonored + */ + 'originalEntryTraceNumber': string; + /** + * Date original entry was returned + * @type {string} + * @memberof Addenda99Dishonored + */ + 'dateOriginalEntryReturned': string; + /** + * Identification of the Original Receiving Depository Institution (ODFI) + * @type {string} + * @memberof Addenda99Dishonored + */ + 'originalReceivingDFIIdentification': string; + /** + * Original date of settlement + * @type {string} + * @memberof Addenda99Dishonored + */ + 'originalSettlementDate': string; + /** + * Return trace number + * @type {string} + * @memberof Addenda99Dishonored + */ + 'returnTraceNumber': string; + /** + * Return settlement date + * @type {string} + * @memberof Addenda99Dishonored + */ + 'returnSettlementDate': string; + /** + * Return reason code + * @type {string} + * @memberof Addenda99Dishonored + */ + 'returnReasonCode': string; + /** + * Trace number from Dishonored Return + * @type {string} + * @memberof Addenda99Dishonored + */ + 'dishonoredReturnTraceNumber': string; + /** + * Settlement date of the Dishonored Return + * @type {string} + * @memberof Addenda99Dishonored + */ + 'dishonoredReturnSettlementDate': string; + /** + * Return reason code of the Dishonored Return + * @type {string} + * @memberof Addenda99Dishonored + */ + 'dishonoredReturnReasonCode': string; + /** + * Matches the Entry Detail Trace Number of the entry being returned. + * @type {string} + * @memberof Addenda99Dishonored + */ + 'traceNumber'?: string; } /** * @@ -801,25 +1010,25 @@ export interface Batch { * @type {BatchHeader} * @memberof Batch */ - batchHeader?: BatchHeader; + 'batchHeader': BatchHeader; /** * * @type {Array} * @memberof Batch */ - entryDetails?: Array; + 'entryDetails': Array; /** * * @type {BatchControl} * @memberof Batch */ - batchControl?: BatchControl; + 'batchControl': BatchControl; /** * * @type {Offset} * @memberof Batch */ - offset?: Offset; + 'offset': Offset; } /** * @@ -832,61 +1041,61 @@ export interface BatchControl { * @type {string} * @memberof BatchControl */ - ID?: string; + 'ID'?: string; /** * Same as ServiceClassCode in BatchHeaderRecord * @type {number} * @memberof BatchControl */ - serviceClassCode?: number; + 'serviceClassCode': number; /** * EntryAddendaCount is a tally of each Entry Detail Record and each Addenda Record processed, within either the batch or file as appropriate. * @type {number} * @memberof BatchControl */ - entryAddendaCount?: number; + 'entryAddendaCount': number; /** * Validate the Receiving DFI Identification in each Entry Detail Record is hashed to provide a check against inadvertent alteration of data contents due to hardware failure or program error. In this context the Entry Hash is the sum of the corresponding fields in the Entry Detail Records on the file. * @type {number} * @memberof BatchControl */ - entryHash?: number; + 'entryHash': number; /** * Contains accumulated Entry debit totals within the batch. * @type {number} * @memberof BatchControl */ - totalDebit?: number; + 'totalDebit': number; /** * Contains accumulated Entry credit totals within the batch. * @type {number} * @memberof BatchControl */ - totalCredit?: number; + 'totalCredit': number; /** - * Alphanumeric code used to identify an Originator The Company Identification Field must be included on all prenotification records and on each entry initiated pursuant to such prenotification. The Company ID may begin with the ANSI one-digit Identification Code Designator (ICD), followed by the identification number The ANSI Identification Numbers and related Identification Code IRS Employer Identification Number (EIN) \"1\" Data Universal Numbering Systems (DUNS) \"3\" User Assigned Number \"9\" + * Alphanumeric code used to identify an Originator. The Company Identification Field must be included on all prenotification records and on each entry initiated pursuant to such prenotification. The Company ID may begin with the ANSI one-digit Identification Code Designator (ICD), followed by the identification number. Possible ICDs are the IRS Employer Identification Number (EIN) \"1\", Data Universal Numbering Systems (DUNS) \"3\", and User Assigned Number \"9\". * @type {string} * @memberof BatchControl */ - companyIdentification?: string; + 'companyIdentification': string; /** * MAC is an eight character code derived from a special key used in conjunction with the DES algorithm. The purpose of the MAC is to validate the authenticity of ACH entries. The DES algorithm and key message standards must be in accordance with standards adopted by the American National Standards Institute. The remaining eleven characters of this field are blank. * @type {string} * @memberof BatchControl */ - messageAuthentication?: string; + 'messageAuthentication'?: string; /** * The routing number is used to identify the DFI originating entries within a given branch. * @type {string} * @memberof BatchControl */ - ODFIIdentification?: string; + 'ODFIIdentification': string; /** * BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record. - * @type {string} + * @type {number} * @memberof BatchControl */ - batchNumber?: string; + 'batchNumber': number; } /** * @@ -895,77 +1104,77 @@ export interface BatchControl { */ export interface BatchHeader { /** - * Batch Header ID + * A client-defined ID used as a reference to this batch * @type {string} * @memberof BatchHeader */ - ID?: string; + 'ID'?: string; /** - * Service Class Code - ACH Credits Only 220 and ACH Debits Only 225 + * Service Class Code - Mixed Debits and Credits \'200\', ACH Credits Only \'220\', or ACH Debits Only \'225\' * @type {number} * @memberof BatchHeader */ - serviceClassCode: number; + 'serviceClassCode': number; /** * Company originating the entries in the batch * @type {string} * @memberof BatchHeader */ - companyName: string; + 'companyName': string; /** * The 9 digit FEIN number (proceeded by a predetermined alpha or numeric character) of the entity in the company name field * @type {string} * @memberof BatchHeader */ - companyDiscretionaryData?: string; + 'companyDiscretionaryData'?: string; /** - * Alphanumeric code used to identify an Originator The Company Identification Field must be included on all prenotification records and on each entry initiated pursuant to such prenotification. The Company ID may begin with the ANSI one-digit Identification Code Designator (ICD), followed by the identification number The ANSI Identification Numbers and related Identification Code IRS Employer Identification Number (EIN) \"1\" Data Universal Numbering Systems (DUNS) \"3\" User Assigned Number \"9\" + * Alphanumeric code used to identify an Originator. The Company Identification Field must be included on all prenotification records and on each entry initiated pursuant to such prenotification. The Company ID may begin with the ANSI one-digit Identification Code Designator (ICD), followed by the identification number. Possible ICDs are the IRS Employer Identification Number (EIN) \"1\", Data Universal Numbering Systems (DUNS) \"3\", or User Assigned Number \"9\". * @type {string} * @memberof BatchHeader */ - companyIdentification: string; + 'companyIdentification': string; /** - * Identifies the payment type (product) found within an ACH batch-using a 3-character code. + * Identifies the payment type (product) found within an ACH batch using a 3-character code. * @type {string} * @memberof BatchHeader */ - standardEntryClassCode?: string; + 'standardEntryClassCode': string; /** - * A description of the entries contained in the batch. The Originator establishes the value of this field to provide a description of the purpose of the entry to be displayed back to the receive For example, \"GAS BILL,\" \"REG. SALARY,\" \"INS. PREM,\", \"SOC. SEC.,\" \"DTC,\" \"TRADE PAY,\" \"PURCHASE,\" etc. This field must contain the word \"REVERSAL\" (left justified) when the batch contains reversing entries. This field must contain the word \"RECLAIM\" (left justified) when the batch contains reclamation entries. This field must contain the word \"NONSETTLED\" (left justified) when the batch contains entries which could not settle. + * A description of the entries contained in the batch. The Originator establishes the value of this field to provide a description of the purpose of the entry to be displayed back to the receiver. For example, \"GAS BILL,\" \"REG. SALARY,\" \"INS. PREM,\", \"SOC. SEC.,\" \"DTC,\" \"TRADE PAY,\" \"PURCHASE,\" etc. This field must contain the word \"REVERSAL\" (left justified) when the batch contains reversing entries. This field must contain the word \"RECLAIM\" (left justified) when the batch contains reclamation entries. This field must contain the word \"NONSETTLED\" (left justified) when the batch contains entries which could not settle. * @type {string} * @memberof BatchHeader */ - companyEntryDescription?: string; + 'companyEntryDescription'?: string; /** * The Originator establishes this field as the date it would like to see displayed to the receiver for descriptive purposes. This field is never used to control timing of any computer or manual operation. It is solely for descriptive purposes. The RDFI should not assume any specific format. * @type {string} * @memberof BatchHeader */ - companyDescriptiveDate?: string; + 'companyDescriptiveDate'?: string; /** - * Date on which the entries are to settle. Format YYMMDD (Y=Year, M=Month, D=Day) + * Date on which the entries are to settle. (Format YYMMDD - Y=Year, M=Month, D=Day) * @type {string} * @memberof BatchHeader */ - effectiveEntryDate?: string; + 'effectiveEntryDate'?: string; /** - * ODFI initiating the Entry. 0 ADV File prepared by an ACH Operator. 1 This code identifies the Originator as a depository financial institution. 2 This code identifies the Originator as a Federal Government entity or agency. + * ODFI initiating the Entry. | 0 - ADV File prepared by an ACH Operator. | 1 - This code identifies the Originator as a depository financial institution. | 2 - This code identifies the Originator as a Federal Government entity or agency. * @type {number} * @memberof BatchHeader */ - originatorStatusCode?: number; + 'originatorStatusCode'?: number; /** * First 8 digits of the originating DFI transit routing number * @type {string} * @memberof BatchHeader */ - ODFIIdentification: string; + 'ODFIIdentification': string; /** * BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record. * @type {number} * @memberof BatchHeader */ - batchNumber?: number; + 'batchNumber': number; } /** * @@ -978,43 +1187,43 @@ export interface CreateFile { * @type {string} * @memberof CreateFile */ - ID?: string; + 'ID'?: string; /** * * @type {FileHeader} * @memberof CreateFile */ - fileHeader: FileHeader; + 'fileHeader': FileHeader; /** * * @type {Array} * @memberof CreateFile */ - batches?: Array; + 'batches'?: Array; /** * * @type {Array} * @memberof CreateFile */ - IATBatches?: Array; + 'IATBatches'?: Array; /** * * @type {FileControl} * @memberof CreateFile */ - fileControl?: FileControl; + 'fileControl'?: FileControl; /** * * @type {Array} * @memberof CreateFile */ - advEntryDetails?: Array; + 'advEntryDetails'?: Array; /** * * @type {ADVBatchControl} * @memberof CreateFile */ - advBatchControl?: ADVBatchControl; + 'advBatchControl'?: ADVBatchControl; } /** * @@ -1027,97 +1236,109 @@ export interface EntryDetail { * @type {string} * @memberof EntryDetail */ - ID?: string; + 'ID'?: string; /** - * transactionCode if the receivers account is: Credit (deposit) to checking account 22 Prenote for credit to checking account 23 Debit (withdrawal) to checking account 27 Prenote for debit to checking account 28 Credit to savings account 32 Prenote for credit to savings account 33 Debit to savings account 37 Prenote for debit to savings account 38 + * Based on transaction type: 22 - Credit (deposit) to checking account | 23 - Prenote for credit to checking account | 27 - Debit (withdrawal) to checking account | 28 - Prenote for debit to checking account | 32 - Credit to savings account | 33 - Prenote for credit to savings account | 37 - Debit to savings account | 38 - Prenote for debit to savings account * @type {number} * @memberof EntryDetail */ - transactionCode: number; + 'transactionCode': number; /** * RDFI\'s routing number without the last digit. * @type {string} * @memberof EntryDetail */ - RDFIIdentification: string; + 'RDFIIdentification': string; /** * Last digit in RDFI routing number. * @type {string} * @memberof EntryDetail */ - checkDigit: string; + 'checkDigit': string; /** - * The receiver\'s bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so its space padded, no zero padded + * The receiver\'s bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so it\'s space padded, not zero padded * @type {string} * @memberof EntryDetail */ - DFIAccountNumber: string; + 'DFIAccountNumber': string; /** * Number of cents you are debiting/crediting this account * @type {number} * @memberof EntryDetail */ - amount: number; + 'amount': number; /** * Internal identification (alphanumeric) that you use to uniquely identify this Entry Detail Record * @type {string} * @memberof EntryDetail */ - identificationNumber?: string; + 'identificationNumber'?: string; /** * The name of the receiver, usually the name on the bank account * @type {string} * @memberof EntryDetail */ - individualName: string; + 'individualName': string; /** - * DiscretionaryData allows ODFIs to include codes, of significance only to them, to enable specialized handling of the entry. There will be no standardized interpretation for the value of this field. It can either be a single two-character code, or two distinct one-character codes, according to the needs of the ODFI and/or Originator involved. This field must be returned intact for any returned entry. WEB uses the Discretionary Data Field as the Payment Type Code + * DiscretionaryData allows ODFIs to include codes, of significance only to them, to enable specialized handling of the entry. There will be no standardized interpretation for the value of this field. It can either be a single two-character code, or two distinct one-character codes, according to the needs of the ODFI and/or Originator involved. This field must be returned intact for any returned entry. WEB uses the Discretionary Data Field as the Payment Type Code. * @type {string} * @memberof EntryDetail */ - discretionaryData?: string; + 'discretionaryData'?: string; /** - * AddendaRecordIndicator indicates the existence of an Addenda Record. A value of \"1\" indicates that one ore more addenda records follow, and \"0\" means no such record is present. + * AddendaRecordIndicator indicates the existence of an Addenda Record. A value of \"1\" indicates that one or more addenda records follow, and \"0\" means no such record is present. * @type {number} * @memberof EntryDetail */ - addendaRecordIndicator?: number; + 'addendaRecordIndicator'?: number; /** - * TraceNumber assigned by the ODFI in ascending sequence, is included in each Entry Detail Record, Corporate Entry Detail Record, and addenda Record. Trace Numbers uniquely identify each entry within a batch in an ACH input file. In association with the Batch Number, transmission (File Creation) Date, and File ID Modifier, the Trace Number uniquely identifies an entry within a given file. For addenda Records, the Trace Number will be identical to the Trace Number in the associated Entry Detail Record, since the Trace Number is associated with an entry or item rather than a physical record. + * TraceNumber assigned by the ODFI in ascending sequence, is included in each Entry Detail Record, Corporate Entry Detail Record, and Addenda Record. Trace Numbers uniquely identify each entry within a batch in an ACH input file. In association with the Batch Number, transmission (File Creation) Date, and File ID Modifier, the Trace Number uniquely identifies an entry within a given file. For Addenda Records, the Trace Number will be identical to the Trace Number in the associated Entry Detail Record, since the Trace Number is associated with an entry or item rather than a physical record. * @type {string} * @memberof EntryDetail */ - traceNumber?: string; + 'traceNumber'?: string; /** * * @type {Addenda02} * @memberof EntryDetail */ - addenda02?: Addenda02; + 'addenda02'?: Addenda02; /** * List of Addenda05 records * @type {Array} * @memberof EntryDetail */ - addenda05?: Array; + 'addenda05'?: Array; /** * * @type {Addenda98} * @memberof EntryDetail */ - addenda98?: Addenda98; + 'addenda98'?: Addenda98; /** * * @type {Addenda99} * @memberof EntryDetail */ - addenda99?: Addenda99; + 'addenda99'?: Addenda99; + /** + * + * @type {Addenda99Dishonored} + * @memberof EntryDetail + */ + 'addenda99Dishonored'?: Addenda99Dishonored; + /** + * + * @type {Addenda99Contested} + * @memberof EntryDetail + */ + 'addenda99Contested'?: Addenda99Contested; /** * Category defines if the entry is a Forward, Return, or NOC * @type {string} * @memberof EntryDetail */ - category?: string; + 'category'?: string; } /** * @@ -1126,47 +1347,47 @@ export interface EntryDetail { */ export interface FileControl { /** - * Moov API File ID + * File ID * @type {string} * @memberof FileControl */ - ID?: string; + 'ID': string; /** * Count of Batches in the File * @type {number} * @memberof FileControl */ - batchCount?: number; + 'batchCount': number; /** - * BlockCount total number of records in the file (include all headers and trailer) divided by 10 (This number must be evenly divisible by 10. If not, additional records consisting of all 9\'s are added to the file after the initial \'9\' record to fill out the block 10.) + * Total number of records in the file (include all headers and trailer) divided by 10 (This number must be evenly divisible by 10. If not, additional records consisting of all 9\'s are added to the file after the initial \'9\' record to fill out the block 10.) * @type {number} * @memberof FileControl */ - blockCount?: number; + 'blockCount': number; /** * Total detail and addenda records in the file * @type {number} * @memberof FileControl */ - entryAddendaCount?: number; + 'entryAddendaCount': number; /** - * EntryHash calculated in the same manner as the batch has total but includes total from entire file + * Calculated in the same manner as the batch total but includes total from entire file * @type {number} * @memberof FileControl */ - entryHash?: number; + 'entryHash': number; /** * Accumulated Batch debit totals within the file. * @type {number} * @memberof FileControl */ - totalDebit?: number; + 'totalDebit': number; /** * Accumulated Batch credit totals within the file. * @type {number} * @memberof FileControl */ - totalCredit?: number; + 'totalCredit': number; } /** * @@ -1175,47 +1396,59 @@ export interface FileControl { */ export interface FileHeader { /** - * contains the Routing Number of the ACH Operator or sending point that is sending the file. + * File ID * @type {string} * @memberof FileHeader */ - immediateOrigin: string; + 'ID'?: string; /** - * The name of the ACH operator or sending point that is sending the file. + * Contains the Routing Number of the ACH Operator or sending point that is sending the file. * @type {string} * @memberof FileHeader */ - immediateOriginName: string; + 'immediateOrigin': string; /** - * contains the Routing Number of the ACH Operator or receiving point to which the file is being sent + * The name of the ACH Operator or sending point that is sending the file. * @type {string} * @memberof FileHeader */ - immediateDestination: string; + 'immediateOriginName': string; /** - * The name of the ACH or receiving point for which that file is destined. + * Contains the Routing Number of the ACH Operator or receiving point to which the file is being sent. * @type {string} * @memberof FileHeader */ - immediateDestinationName: string; + 'immediateDestination': string; /** - * The File Creation Date is the date when the file was prepared by an ODFI. (Format HHmm - H=Hour, m=Minute) + * The name of the ACH Operator or receiving point to which the file is being sent. * @type {string} * @memberof FileHeader */ - fileCreationTime?: string; + 'immediateDestinationName': string; /** - * The File Creation Time is the time when the file was prepared by an ODFI. (Format YYMMDD - Y=Year, M=Month, D=Day) + * The File Creation Time is the time when the file was prepared by an ODFI. (Format HHmm - H=Hour, m=Minute) * @type {string} * @memberof FileHeader */ - fileCreationDate?: string; + 'fileCreationTime': string; /** - * Incremented value for each file for RDFI\'s. + * The File Creation Date is the date when the file was prepared by an ODFI. (Format YYMMDD - Y=Year, M=Month, D=Day) * @type {string} * @memberof FileHeader */ - fileIDModifier?: string; + 'fileCreationDate': string; + /** + * Incremented value for each file for RDFIs. + * @type {string} + * @memberof FileHeader + */ + 'fileIDModifier'?: string; + /** + * Reserved field for information pertinent to the Originator. + * @type {string} + * @memberof FileHeader + */ + 'referenceCode'?: string; } /** * @@ -1228,13 +1461,13 @@ export interface FileID { * @type {string} * @memberof FileID */ - ID?: string; + 'ID'?: string; /** * An error message describing the problem intended for humans. * @type {string} * @memberof FileID */ - error?: string; + 'error'?: string; } /** * @@ -1243,29 +1476,29 @@ export interface FileID { */ export interface IATBatch { /** - * Client defined string used as a reference to this record. + * Client-defined string used as a reference to this record. * @type {string} * @memberof IATBatch */ - ID?: string; + 'ID'?: string; /** * * @type {IATBatchHeader} * @memberof IATBatch */ - IATBatchHeader?: IATBatchHeader; + 'IATBatchHeader': IATBatchHeader; /** * * @type {Array} * @memberof IATBatch */ - IATEntryDetails?: Array; + 'IATEntryDetails': Array; /** * * @type {BatchControl} * @memberof IATBatch */ - batchControl?: BatchControl; + 'batchControl': BatchControl; } /** * @@ -1274,101 +1507,101 @@ export interface IATBatch { */ export interface IATBatchHeader { /** - * ID is a client defined string used as a reference to this record. + * ID is a client-defined string used as a reference to this record. * @type {string} * @memberof IATBatchHeader */ - ID?: string; + 'ID'?: string; /** - * ServiceClassCode ACH Mixed Debits and Credits \'200\' ACH Credits Only \'220\' ACH Debits Only \'225\' + * Service Class Code - Mixed Debits and Credits \'200\', ACH Credits Only \'220\', or ACH Debits Only \'225\' * @type {number} * @memberof IATBatchHeader */ - serviceClassCode?: number; + 'serviceClassCode': number; /** * Leave Blank. Only used for corrected IAT entries * @type {string} * @memberof IATBatchHeader */ - IATIndicator?: string; + 'IATIndicator'?: string; /** - * Code indicating currency conversion. FV Fixed-to-Variable – Entry is originated in a fixed-value amount and is to be received in a variable amount resulting from the execution of the foreign exchange conversion. VF Variable-to-Fixed – Entry is originated in a variable-value amount based on a specific foreign exchange rate for conversion to a fixed-value amount in which the entry is to be received. FF Fixed-to-Fixed – Entry is originated in a fixed-value amount and is to be received in the same fixed-value amount in the same currency denomination. There is no foreign exchange conversion for entries transmitted using this code. For entries originated in a fixed value amount, the foreign Exchange Reference Field will be space filled. + * Code indicating currency conversion: \'FV\' (Fixed-to-Variable) – Entry is originated in a fixed-value amount and is to be received in a variable amount resulting from the execution of the foreign exchange conversion. | \'VF\' (Variable-to-Fixed) – Entry is originated in a variable-value amount based on a specific foreign exchange rate for conversion to a fixed-value amount in which the entry is to be received. | \'FF\' (Fixed-to-Fixed) – Entry is originated in a fixed-value amount and is to be received in the same fixed-value amount in the same currency denomination. There is no foreign exchange conversion for entries transmitted using this code. For entries originated in a fixed value amount, the foreign Exchange Reference Field will be space filled. * @type {string} * @memberof IATBatchHeader */ - foreignExchangeIndicator?: string; + 'foreignExchangeIndicator': string; /** - * Code used to indicate the content of the Foreign Exchange Reference Field and is filled by the gateway operator. Valid entries are 1 - Foreign Exchange Rate; 2 - Foreign Exchange Reference Number; or 3 - Space Filled + * Code used to indicate the content of the Foreign Exchange Reference Field and is filled by the gateway operator. Valid entries are 1 - Foreign Exchange Rate | 2 - Foreign Exchange Reference Number | 3 - Space Filled * @type {number} * @memberof IATBatchHeader */ - foreignExchangeReferenceIndicator?: number; + 'foreignExchangeReferenceIndicator': number; /** - * Contains either the foreign exchange rate used to execute the foreign exchange conversion of a cross-border entry or another reference to the foreign exchange transaction. + * Contains either the foreign exchange rate used to execute the foreign exchange conversion of a cross-border entry or another reference to the foreign exchange transaction. * @type {string} * @memberof IATBatchHeader */ - foreignExchangeReference?: string; + 'foreignExchangeReference': string; /** * Two-character code, as approved by the International Organization for Standardization (ISO), to identify the country in which the entry is to be received. For United States use US. * @type {string} * @memberof IATBatchHeader */ - ISODestinationCountryCode?: string; + 'ISODestinationCountryCode': string; /** * For U.S. entities: the number assigned will be your tax ID (often Social Security Number) For non-U.S. entities: the number assigned will be your DDA number, or the last 9 characters of your account number if it exceeds 9 characters * @type {string} * @memberof IATBatchHeader */ - originatorIdentification?: string; + 'originatorIdentification': string; /** - * StandardEntryClassCode for consumer and non consumer international payments is IAT. Identifies the payment type (product) found within an ACH batch-using a 3-character code. The SEC Code pertains to all items within batch. Determines format of the detail records. Determines addenda records (required or optional PLUS one or up to 9,999 records). Determines rules to follow (return time frames). Some SEC codes require specific data in predetermined fields within the ACH record + * StandardEntryClassCode for consumer and non consumer international payments is IAT. Identifies the payment type (product) found within an ACH batch using a 3-character code. The SEC Code pertains to all items within batch. Determines format of the detail records. Determines addenda records (required or optional PLUS one or up to 9,999 records). Determines rules to follow (return time frames). Some SEC codes require specific data in predetermined fields within the ACH record. * @type {string} * @memberof IATBatchHeader */ - standardEntryClassCode?: string; + 'standardEntryClassCode': string; /** - * A description of the entries contained in the batch The Originator establishes the value of this field to provide a description of the purpose of the entry to be displayed back to the receive For example, \"GAS BILL,\" \"REG. SALARY,\" \"INS. PREM,\" \"SOC. SEC.,\" \"DTC,\" \"TRADE PAY,\" \"PURCHASE,\" etc. This field must contain the word \"REVERSAL\" (left justified) when the batch contains reversing entries. This field must contain the word \"RECLAIM\" (left justified) when the batch contains reclamation entries. This field must contain the word \"NONSETTLED\" (left justified) when the batch contains entries which could not settle. + * A description of the entries contained in the batch The Originator establishes the value of this field to provide a description of the purpose of the entry to be displayed back to the receiver. For example, \"GAS BILL,\" \"REG. SALARY,\" \"INS. PREM,\" \"SOC. SEC.,\" \"DTC,\" \"TRADE PAY,\" \"PURCHASE,\" etc. This field must contain the word \"REVERSAL\" (left justified) when the batch contains reversing entries. This field must contain the word \"RECLAIM\" (left justified) when the batch contains reclamation entries. This field must contain the word \"NONSETTLED\" (left justified) when the batch contains entries which could not settle. * @type {string} * @memberof IATBatchHeader */ - companyEntryDescription?: string; + 'companyEntryDescription'?: string; /** * Three-character code, as approved by the International Organization for Standardization (ISO), to identify the currency denomination in which the entry was first originated. If the source of funds is within the territorial jurisdiction of the U.S., enter \'USD\', otherwise refer to International Organization for Standardization website for value: www.iso.org * @type {string} * @memberof IATBatchHeader */ - ISOOriginatingCurrencyCode?: string; + 'ISOOriginatingCurrencyCode': string; /** * ISODestinationCurrencyCode is the three-character code, as approved by the International Organization for Standardization (ISO), to identify the currency denomination in which the entry will ultimately be settled. If the final destination of funds is within the territorial jurisdiction of the U.S., enter \"USD\", otherwise refer to International Organization for Standardization website for value: www.iso.org * @type {string} * @memberof IATBatchHeader */ - ISODestinationCurrencyCode?: string; + 'ISODestinationCurrencyCode': string; /** - * EffectiveEntryDate the date on which the entries are to settle format YYMMDD (Y=Year, M=Month, D=Day) + * EffectiveEntryDate the date on which the entries are to settle. Format YYMMDD (Y=Year, M=Month, D=Day) * @type {string} * @memberof IATBatchHeader */ - effectiveEntryDate?: string; + 'effectiveEntryDate'?: string; /** - * SettlementDate Leave blank, this field is inserted by the ACH operator settlementDate string OriginatorStatusCode refers to the ODFI initiating the Entry. 0 ADV File prepared by an ACH Operator. 1 This code identifies the Originator as a depository financial institution. 2 This code identifies the Originator as a Federal Government entity or agency. + * ODFI initiating the Entry. | 0 - ADV File prepared by an ACH Operator. | 1 - This code identifies the Originator as a depository financial institution. | 2 - This code identifies the Originator as a Federal Government entity or agency. * @type {number} * @memberof IATBatchHeader */ - originatorStatusCode?: number; + 'originatorStatusCode'?: number; /** - * ODFIIdentification First 8 digits of the originating DFI transit routing number for Inbound IAT Entries, this field contains the routing number of the U.S. Gateway Operator. For Outbound IAT Entries, this field contains the standard routing number, as assigned by Accuity, that identifies the U.S. ODFI initiating the Entry. Format - TTTTAAAA + * First 8 digits of the originating DFI transit routing number. For Inbound IAT Entries, this field contains the routing number of the U.S. Gateway Operator. For Outbound IAT Entries, this field contains the standard routing number, as assigned by Accuity, that identifies the U.S. ODFI initiating the Entry. (Format TTTTAAAA - T=Federal Reserve Routing Symbol, A=ABA Institution Identifier) * @type {string} * @memberof IATBatchHeader */ - ODFIIdentification?: string; + 'ODFIIdentification': string; /** * BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record. * @type {number} * @memberof IATBatchHeader */ - batchNumber?: number; + 'batchNumber': number; } /** * @@ -1381,139 +1614,139 @@ export interface IATEntryDetail { * @type {string} * @memberof IATEntryDetail */ - ID?: string; + 'ID'?: string; /** - * TransactionCode if the receivers account is Credit (deposit) to checking account \'22\' Prenote for credit to checking account \'23\' Debit (withdrawal) to checking account \'27\' Prenote for debit to checking account \'28\' Credit to savings account \'32\' Prenote for credit to savings account \'33\' Debit to savings account \'37\' Prenote for debit to savings account \'38\' + * Based on transaction type: 22 - Credit (deposit) to checking account | 23 - Prenote for credit to checking account | 27 - Debit (withdrawal) to checking account | 28 - Prenote for debit to checking account | 32 - Credit to savings account | 33 - Prenote for credit to savings account | 37 - Debit to savings account | 38 - Prenote for debit to savings account * @type {number} * @memberof IATEntryDetail */ - transactionCode?: number; + 'transactionCode': number; /** * RDFI\'s routing number without the last digit. * @type {string} * @memberof IATEntryDetail */ - RDFIIdentification?: string; + 'RDFIIdentification': string; /** * Last digit in RDFI routing number. * @type {string} * @memberof IATEntryDetail */ - checkDigit?: string; + 'checkDigit': string; /** * Number of Addenda Records * @type {number} * @memberof IATEntryDetail */ - AddendaRecords?: number; + 'addendaRecords': number; /** * Number of cents you are debiting/crediting this account * @type {number} * @memberof IATEntryDetail */ - amount?: number; + 'amount': number; /** - * The receiver\'s bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so its space padded, no zero padded + * The receiver\'s bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so it\'s space padded, not zero padded * @type {string} * @memberof IATEntryDetail */ - DFIAccountNumber?: string; + 'DFIAccountNumber': string; /** * Signifies if the record has been screened against OFAC records * @type {string} * @memberof IATEntryDetail */ - OFACScreeningIndicator?: string; + 'OFACScreeningIndicator': string; /** * Signifies if the record has been screened against OFAC records by a secondary entry * @type {string} * @memberof IATEntryDetail */ - SecondaryOFACScreeningIndicator?: string; + 'secondaryOFACScreeningIndicator': string; /** - * AddendaRecordIndicator indicates the existence of an Addenda Record. A value of \"1\" indicates that one ore more addenda records follow, and \"0\" means no such record is present. + * AddendaRecordIndicator indicates the existence of an Addenda Record. A value of \"1\" indicates that one or more addenda records follow, and \"0\" means no such record is present. * @type {number} * @memberof IATEntryDetail */ - addendaRecordIndicator?: number; + 'addendaRecordIndicator': number; /** * Matches the Entry Detail Trace Number of the entry being returned. * @type {string} * @memberof IATEntryDetail */ - traceNumber?: string; + 'traceNumber'?: string; /** * * @type {Addenda10} * @memberof IATEntryDetail */ - addenda10?: Addenda10; + 'addenda10': Addenda10; /** * * @type {Addenda11} * @memberof IATEntryDetail */ - addenda11?: Addenda11; + 'addenda11': Addenda11; /** * * @type {Addenda12} * @memberof IATEntryDetail */ - addenda12?: Addenda12; + 'addenda12': Addenda12; /** * * @type {Addenda13} * @memberof IATEntryDetail */ - addenda13?: Addenda13; + 'addenda13': Addenda13; /** * * @type {Addenda14} * @memberof IATEntryDetail */ - addenda14?: Addenda14; + 'addenda14': Addenda14; /** * * @type {Addenda15} * @memberof IATEntryDetail */ - addenda15?: Addenda15; + 'addenda15': Addenda15; /** * * @type {Addenda16} * @memberof IATEntryDetail */ - addenda16?: Addenda16; + 'addenda16': Addenda16; /** * * @type {Addenda17} * @memberof IATEntryDetail */ - addenda17?: Addenda17; + 'addenda17'?: Addenda17; /** * * @type {Addenda18} * @memberof IATEntryDetail */ - addenda18?: Addenda18; + 'addenda18'?: Addenda18; /** * * @type {Addenda98} * @memberof IATEntryDetail */ - addenda98?: Addenda98; + 'addenda98'?: Addenda98; /** * * @type {Addenda99} * @memberof IATEntryDetail */ - addenda99?: Addenda99; + 'addenda99'?: Addenda99; /** * Category defines if the entry is a Forward, Return, or NOC * @type {string} * @memberof IATEntryDetail */ - category?: string; + 'category'?: string; } /** * @@ -1526,7 +1759,7 @@ export interface ModelError { * @type {string} * @memberof ModelError */ - error: string; + 'error': string; } /** * @@ -1539,43 +1772,49 @@ export interface ModelFile { * @type {string} * @memberof ModelFile */ - ID?: string; + 'ID': string; /** * * @type {FileHeader} * @memberof ModelFile */ - fileHeader?: FileHeader; + 'fileHeader': FileHeader; /** * * @type {Array} * @memberof ModelFile */ - batches?: Array; + 'batches'?: Array; /** * * @type {Array} * @memberof ModelFile */ - IATBatches?: Array; + 'IATBatches'?: Array; /** * * @type {FileControl} * @memberof ModelFile */ - fileControl?: FileControl; + 'fileControl': FileControl; /** * * @type {Array} * @memberof ModelFile */ - NotificationOfChange?: Array; + 'NotificationOfChange'?: Array | null; /** * * @type {Array} * @memberof ModelFile */ - ReturnEntries?: Array; + 'ReturnEntries'?: Array | null; + /** + * + * @type {ADVFileControl} + * @memberof ModelFile + */ + 'fileADVControl'?: ADVFileControl; } /** * @@ -1588,35 +1827,33 @@ export interface Offset { * @type {string} * @memberof Offset */ - routingNumber?: string; + 'routingNumber': string; /** * Account number used to offset records * @type {string} * @memberof Offset */ - accountNumber?: string; + 'accountNumber': string; /** * Account type used in offset record * @type {string} * @memberof Offset */ - accountType?: OffsetAccountTypeEnum; + 'accountType': OffsetAccountTypeEnum; /** * Memo for Offset EntryDetail record * @type {string} * @memberof Offset */ - description?: string; + 'description': string; } -/** - * @export - * @enum {string} - */ -export enum OffsetAccountTypeEnum { - Checking = 'checking', - Savings = 'savings' -} +export const OffsetAccountTypeEnum = { + Checking: 'checking', + Savings: 'savings' +} as const; + +export type OffsetAccountTypeEnum = typeof OffsetAccountTypeEnum[keyof typeof OffsetAccountTypeEnum]; /** * @@ -1629,13 +1866,13 @@ export interface SegmentedFiles { * @type {string} * @memberof SegmentedFiles */ - creditFileID?: string; + 'creditFileID'?: string; /** * File ID * @type {string} * @memberof SegmentedFiles */ - debitFileID?: string; + 'debitFileID'?: string; } /** * @@ -1648,19 +1885,19 @@ export interface ValidateOpts { * @type {boolean} * @memberof ValidateOpts */ - requireABAOrigin?: boolean; + 'requireABAOrigin'?: boolean; /** * Skip ImmediateOrigin validation steps. * @type {boolean} * @memberof ValidateOpts */ - bypassOriginValidation?: boolean; + 'bypassOriginValidation'?: boolean; /** * Skip ImmediateDestination validation steps. * @type {boolean} * @memberof ValidateOpts */ - bypassDestinationValidation?: boolean; + 'bypassDestinationValidation'?: boolean; } /** @@ -1670,31 +1907,29 @@ export interface ValidateOpts { export const ACHFilesApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Append a Batch record to the specified file - * @summary Add Batch to File + * Append a Batch record to the specified File. + * @summary Append Batch to File * @param {string} fileID File ID * @param {Batch} batch - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs - * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy for to not collide with each other in your requests. + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - addBatchToFile: async (fileID: string, batch: Batch, xRequestID?: string, xIdempotencyKey?: string, options: any = {}): Promise => { + addBatchToFile: async (fileID: string, batch: Batch, xRequestID?: string, xIdempotencyKey?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'fileID' is not null or undefined - if (fileID === null || fileID === undefined) { - throw new RequiredError('fileID','Required parameter fileID was null or undefined when calling addBatchToFile.'); - } + assertParamExists('addBatchToFile', 'fileID', fileID) // verify required parameter 'batch' is not null or undefined - if (batch === null || batch === undefined) { - throw new RequiredError('batch','Required parameter batch was null or undefined when calling addBatchToFile.'); - } + assertParamExists('addBatchToFile', 'batch', batch) const localVarPath = `/files/{fileID}/batches` .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); - const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -1711,39 +1946,75 @@ export const ACHFilesApiAxiosParamCreator = function (configuration?: Configurat localVarHeaderParameter['Content-Type'] = 'application/json'; - localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; - // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 - delete localVarUrlObj.search; + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - const needsSerialization = (typeof batch !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; - localVarRequestOptions.data = needsSerialization ? JSON.stringify(batch !== undefined ? batch : {}) : (batch || ""); + localVarRequestOptions.data = serializeDataIfNeeded(batch, localVarRequestOptions, configuration) return { - url: globalImportUrl.format(localVarUrlObj), + url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** - * Validates the existing file. You need only supply the unique File identifier that was returned upon creation. - * @summary Validate file + * Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file. + * @summary Build File * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ - checkFile: async (fileID: string, xRequestID?: string, options: any = {}): Promise => { + buildFile: async (fileID: string, xRequestID?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'fileID' is not null or undefined - if (fileID === null || fileID === undefined) { - throw new RequiredError('fileID','Required parameter fileID was null or undefined when calling checkFile.'); + assertParamExists('buildFile', 'fileID', fileID) + const localVarPath = `/files/{fileID}/build` + .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (xRequestID !== undefined && xRequestID !== null) { + localVarHeaderParameter['X-Request-ID'] = String(xRequestID); } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Validates the existing File. You need only supply the unique File identifier that was returned upon creation. + * @summary Validate File + * @param {string} fileID File ID + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + checkFile: async (fileID: string, xRequestID?: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'fileID' is not null or undefined + assertParamExists('checkFile', 'fileID', fileID) const localVarPath = `/files/{fileID}/validate` .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); - const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -1754,14 +2025,12 @@ export const ACHFilesApiAxiosParamCreator = function (configuration?: Configurat - localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; - // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 - delete localVarUrlObj.search; + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { - url: globalImportUrl.format(localVarUrlObj), + url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, @@ -1769,26 +2038,76 @@ export const ACHFilesApiAxiosParamCreator = function (configuration?: Configurat * Create a new File object from either the plaintext or JSON representation. * @summary Create File * @param {string} body Content of the ACH file (in json or raw text) - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs - * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy for to not collide with each other in your requests. + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests. + * @param {boolean} [requireABAOrigin] Optional parameter to configure ImmediateOrigin validation + * @param {boolean} [bypassOrigin] Optional parameter to configure ImmediateOrigin validation + * @param {boolean} [bypassDestination] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [customTraceNumbers] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [allowZeroBatches] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [allowMissingFileHeader] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [allowMissingFileControl] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [bypassCompanyIdentificationMatch] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [customReturnCodes] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [unequalServiceClassCode] Optional parameter to configure ImmediateDestination validation * @param {*} [options] Override http request option. * @throws {RequiredError} */ - createFile: async (body: string, xRequestID?: string, xIdempotencyKey?: string, options: any = {}): Promise => { + createFile: async (body: string, xRequestID?: string, xIdempotencyKey?: string, requireABAOrigin?: boolean, bypassOrigin?: boolean, bypassDestination?: boolean, customTraceNumbers?: boolean, allowZeroBatches?: boolean, allowMissingFileHeader?: boolean, allowMissingFileControl?: boolean, bypassCompanyIdentificationMatch?: boolean, customReturnCodes?: boolean, unequalServiceClassCode?: boolean, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'body' is not null or undefined - if (body === null || body === undefined) { - throw new RequiredError('body','Required parameter body was null or undefined when calling createFile.'); - } + assertParamExists('createFile', 'body', body) const localVarPath = `/files/create`; - const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (requireABAOrigin !== undefined) { + localVarQueryParameter['requireABAOrigin'] = requireABAOrigin; + } + + if (bypassOrigin !== undefined) { + localVarQueryParameter['bypassOrigin'] = bypassOrigin; + } + + if (bypassDestination !== undefined) { + localVarQueryParameter['bypassDestination'] = bypassDestination; + } + + if (customTraceNumbers !== undefined) { + localVarQueryParameter['customTraceNumbers'] = customTraceNumbers; + } + + if (allowZeroBatches !== undefined) { + localVarQueryParameter['allowZeroBatches'] = allowZeroBatches; + } + + if (allowMissingFileHeader !== undefined) { + localVarQueryParameter['allowMissingFileHeader'] = allowMissingFileHeader; + } + + if (allowMissingFileControl !== undefined) { + localVarQueryParameter['allowMissingFileControl'] = allowMissingFileControl; + } + + if (bypassCompanyIdentificationMatch !== undefined) { + localVarQueryParameter['bypassCompanyIdentificationMatch'] = bypassCompanyIdentificationMatch; + } + + if (customReturnCodes !== undefined) { + localVarQueryParameter['customReturnCodes'] = customReturnCodes; + } + + if (unequalServiceClassCode !== undefined) { + localVarQueryParameter['unequalServiceClassCode'] = unequalServiceClassCode; + } + if (xRequestID !== undefined && xRequestID !== null) { localVarHeaderParameter['X-Request-ID'] = String(xRequestID); } @@ -1801,39 +2120,36 @@ export const ACHFilesApiAxiosParamCreator = function (configuration?: Configurat localVarHeaderParameter['Content-Type'] = 'text/plain'; - localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; - // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 - delete localVarUrlObj.search; + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - const needsSerialization = (typeof body !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; - localVarRequestOptions.data = needsSerialization ? JSON.stringify(body !== undefined ? body : {}) : (body || ""); + localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration) return { - url: globalImportUrl.format(localVarUrlObj), + url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Permanently deletes a File and associated Batches. It cannot be undone. - * @summary Delete file + * @summary Delete File * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteACHFile: async (fileID: string, xRequestID?: string, options: any = {}): Promise => { + deleteACHFile: async (fileID: string, xRequestID?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'fileID' is not null or undefined - if (fileID === null || fileID === undefined) { - throw new RequiredError('fileID','Required parameter fileID was null or undefined when calling deleteACHFile.'); - } + assertParamExists('deleteACHFile', 'fileID', fileID) const localVarPath = `/files/{fileID}` .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); - const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -1844,43 +2160,39 @@ export const ACHFilesApiAxiosParamCreator = function (configuration?: Configurat - localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; - // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 - delete localVarUrlObj.search; + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { - url: globalImportUrl.format(localVarUrlObj), + url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** - * Delete a Batch from a File - * @summary Delete batch + * Delete a Batch from a File. + * @summary Delete Batch * @param {string} fileID File ID * @param {string} batchID Batch ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteFileBatch: async (fileID: string, batchID: string, xRequestID?: string, options: any = {}): Promise => { + deleteFileBatch: async (fileID: string, batchID: string, xRequestID?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'fileID' is not null or undefined - if (fileID === null || fileID === undefined) { - throw new RequiredError('fileID','Required parameter fileID was null or undefined when calling deleteFileBatch.'); - } + assertParamExists('deleteFileBatch', 'fileID', fileID) // verify required parameter 'batchID' is not null or undefined - if (batchID === null || batchID === undefined) { - throw new RequiredError('batchID','Required parameter batchID was null or undefined when calling deleteFileBatch.'); - } + assertParamExists('deleteFileBatch', 'batchID', batchID) const localVarPath = `/files/{fileID}/batches/{batchID}` .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))) .replace(`{${"batchID"}}`, encodeURIComponent(String(batchID))); - const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -1891,38 +2203,36 @@ export const ACHFilesApiAxiosParamCreator = function (configuration?: Configurat - localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; - // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 - delete localVarUrlObj.search; + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { - url: globalImportUrl.format(localVarUrlObj), + url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** - * Consolidate batches and entries into the minimum number of batches needed. - * @summary Flatten batches + * Consolidate Batches and Entries into the minimum number of Batches needed. + * @summary Flatten Batches * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs - * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy for to not collide with each other in your requests. + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - flattenFile: async (fileID: string, xRequestID?: string, xIdempotencyKey?: string, options: any = {}): Promise => { + flattenFile: async (fileID: string, xRequestID?: string, xIdempotencyKey?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'fileID' is not null or undefined - if (fileID === null || fileID === undefined) { - throw new RequiredError('fileID','Required parameter fileID was null or undefined when calling flattenFile.'); - } + assertParamExists('flattenFile', 'fileID', fileID) const localVarPath = `/files/{fileID}/flatten` .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); - const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -1937,43 +2247,39 @@ export const ACHFilesApiAxiosParamCreator = function (configuration?: Configurat - localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; - // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 - delete localVarUrlObj.search; + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { - url: globalImportUrl.format(localVarUrlObj), + url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** - * Get a specific Batch on a File + * Get a specific Batch on a File. * @summary Get Batch * @param {string} fileID File ID * @param {string} batchID Batch ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFileBatch: async (fileID: string, batchID: string, xRequestID?: string, options: any = {}): Promise => { + getFileBatch: async (fileID: string, batchID: string, xRequestID?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'fileID' is not null or undefined - if (fileID === null || fileID === undefined) { - throw new RequiredError('fileID','Required parameter fileID was null or undefined when calling getFileBatch.'); - } + assertParamExists('getFileBatch', 'fileID', fileID) // verify required parameter 'batchID' is not null or undefined - if (batchID === null || batchID === undefined) { - throw new RequiredError('batchID','Required parameter batchID was null or undefined when calling getFileBatch.'); - } + assertParamExists('getFileBatch', 'batchID', batchID) const localVarPath = `/files/{fileID}/batches/{batchID}` .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))) .replace(`{${"batchID"}}`, encodeURIComponent(String(batchID))); - const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -1984,37 +2290,35 @@ export const ACHFilesApiAxiosParamCreator = function (configuration?: Configurat - localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; - // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 - delete localVarUrlObj.search; + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { - url: globalImportUrl.format(localVarUrlObj), + url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** - * Get the batches on a File. - * @summary Get batches + * Get the Batches on a File. + * @summary Get Batches * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFileBatches: async (fileID: string, xRequestID?: string, options: any = {}): Promise => { + getFileBatches: async (fileID: string, xRequestID?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'fileID' is not null or undefined - if (fileID === null || fileID === undefined) { - throw new RequiredError('fileID','Required parameter fileID was null or undefined when calling getFileBatches.'); - } + assertParamExists('getFileBatches', 'fileID', fileID) const localVarPath = `/files/{fileID}/batches` .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); - const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -2025,37 +2329,35 @@ export const ACHFilesApiAxiosParamCreator = function (configuration?: Configurat - localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; - // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 - delete localVarUrlObj.search; + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { - url: globalImportUrl.format(localVarUrlObj), + url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Get the details of an existing File using the unique File identifier that was returned upon creation. - * @summary Retrieve a file + * @summary Retrieve File * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFileByID: async (fileID: string, xRequestID?: string, options: any = {}): Promise => { + getFileByID: async (fileID: string, xRequestID?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'fileID' is not null or undefined - if (fileID === null || fileID === undefined) { - throw new RequiredError('fileID','Required parameter fileID was null or undefined when calling getFileByID.'); - } + assertParamExists('getFileByID', 'fileID', fileID) const localVarPath = `/files/{fileID}` .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); - const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -2066,37 +2368,35 @@ export const ACHFilesApiAxiosParamCreator = function (configuration?: Configurat - localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; - // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 - delete localVarUrlObj.search; + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { - url: globalImportUrl.format(localVarUrlObj), + url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** - * Assembles the existing file (batches and controls) records, computes sequence numbers and totals. Returns plaintext file. - * @summary Get file contents + * Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file. + * @summary Get File Contents * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFileContents: async (fileID: string, xRequestID?: string, options: any = {}): Promise => { + getFileContents: async (fileID: string, xRequestID?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'fileID' is not null or undefined - if (fileID === null || fileID === undefined) { - throw new RequiredError('fileID','Required parameter fileID was null or undefined when calling getFileContents.'); - } + assertParamExists('getFileContents', 'fileID', fileID) const localVarPath = `/files/{fileID}/contents` .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); - const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -2107,31 +2407,31 @@ export const ACHFilesApiAxiosParamCreator = function (configuration?: Configurat - localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; - // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 - delete localVarUrlObj.search; + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { - url: globalImportUrl.format(localVarUrlObj), + url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** - * List all ACH files created with the ACH service. These files are not persisted through multiple runs of the service. - * @summary Get ACH files - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service. + * @summary List Files + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFiles: async (xRequestID?: string, options: any = {}): Promise => { + getFiles: async (xRequestID?: string, options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/files`; - const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -2142,68 +2442,66 @@ export const ACHFilesApiAxiosParamCreator = function (configuration?: Configurat - localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; - // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 - delete localVarUrlObj.search; + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { - url: globalImportUrl.format(localVarUrlObj), + url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** - * Check the ACH service to check if running + * Check if the ACH service is running. * @summary Ping ACH service * @param {*} [options] Override http request option. * @throws {RequiredError} */ - ping: async (options: any = {}): Promise => { + ping: async (options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/ping`; - const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; - // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 - delete localVarUrlObj.search; + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { - url: globalImportUrl.format(localVarUrlObj), + url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** - * Split one file into two. One with only debits and one with only credits. - * @summary Segment file + * Split one File into two. One with only debits and one with only credits. + * @summary Segment File * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs - * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy for to not collide with each other in your requests. + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - segmentFile: async (fileID: string, xRequestID?: string, xIdempotencyKey?: string, options: any = {}): Promise => { + segmentFile: async (fileID: string, xRequestID?: string, xIdempotencyKey?: string, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'fileID' is not null or undefined - if (fileID === null || fileID === undefined) { - throw new RequiredError('fileID','Required parameter fileID was null or undefined when calling segmentFile.'); - } + assertParamExists('segmentFile', 'fileID', fileID) const localVarPath = `/files/{fileID}/segment` .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); - const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -2218,38 +2516,36 @@ export const ACHFilesApiAxiosParamCreator = function (configuration?: Configurat - localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; - // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 - delete localVarUrlObj.search; + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { - url: globalImportUrl.format(localVarUrlObj), + url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** - * Validates the existing file. You need only supply the unique File identifier that was returned upon creation. - * @summary Validate file + * Validates the existing File. You need only supply the unique File identifier that was returned upon creation. + * @summary Validate File (Custom) * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {ValidateOpts} [validateOpts] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - validateFile: async (fileID: string, xRequestID?: string, validateOpts?: ValidateOpts, options: any = {}): Promise => { + validateFile: async (fileID: string, xRequestID?: string, validateOpts?: ValidateOpts, options: AxiosRequestConfig = {}): Promise => { // verify required parameter 'fileID' is not null or undefined - if (fileID === null || fileID === undefined) { - throw new RequiredError('fileID','Required parameter fileID was null or undefined when calling validateFile.'); - } + assertParamExists('validateFile', 'fileID', fileID) const localVarPath = `/files/{fileID}/validate` .replace(`{${"fileID"}}`, encodeURIComponent(String(fileID))); - const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; @@ -2262,16 +2558,13 @@ export const ACHFilesApiAxiosParamCreator = function (configuration?: Configurat localVarHeaderParameter['Content-Type'] = 'application/json'; - localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; - // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 - delete localVarUrlObj.search; + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - const needsSerialization = (typeof validateOpts !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json'; - localVarRequestOptions.data = needsSerialization ? JSON.stringify(validateOpts !== undefined ? validateOpts : {}) : (validateOpts || ""); + localVarRequestOptions.data = serializeDataIfNeeded(validateOpts, localVarRequestOptions, configuration) return { - url: globalImportUrl.format(localVarUrlObj), + url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, @@ -2283,221 +2576,202 @@ export const ACHFilesApiAxiosParamCreator = function (configuration?: Configurat * @export */ export const ACHFilesApiFp = function(configuration?: Configuration) { + const localVarAxiosParamCreator = ACHFilesApiAxiosParamCreator(configuration) return { /** - * Append a Batch record to the specified file - * @summary Add Batch to File + * Append a Batch record to the specified File. + * @summary Append Batch to File * @param {string} fileID File ID * @param {Batch} batch - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs - * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy for to not collide with each other in your requests. + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async addBatchToFile(fileID: string, batch: Batch, xRequestID?: string, xIdempotencyKey?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await ACHFilesApiAxiosParamCreator(configuration).addBatchToFile(fileID, batch, xRequestID, xIdempotencyKey, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; + async addBatchToFile(fileID: string, batch: Batch, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.addBatchToFile(fileID, batch, xRequestID, xIdempotencyKey, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Validates the existing file. You need only supply the unique File identifier that was returned upon creation. - * @summary Validate file + * Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file. + * @summary Build File * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async checkFile(fileID: string, xRequestID?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await ACHFilesApiAxiosParamCreator(configuration).checkFile(fileID, xRequestID, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; + async buildFile(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.buildFile(fileID, xRequestID, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * Validates the existing File. You need only supply the unique File identifier that was returned upon creation. + * @summary Validate File + * @param {string} fileID File ID + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async checkFile(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.checkFile(fileID, xRequestID, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Create a new File object from either the plaintext or JSON representation. * @summary Create File * @param {string} body Content of the ACH file (in json or raw text) - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs - * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy for to not collide with each other in your requests. + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests. + * @param {boolean} [requireABAOrigin] Optional parameter to configure ImmediateOrigin validation + * @param {boolean} [bypassOrigin] Optional parameter to configure ImmediateOrigin validation + * @param {boolean} [bypassDestination] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [customTraceNumbers] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [allowZeroBatches] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [allowMissingFileHeader] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [allowMissingFileControl] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [bypassCompanyIdentificationMatch] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [customReturnCodes] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [unequalServiceClassCode] Optional parameter to configure ImmediateDestination validation * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async createFile(body: string, xRequestID?: string, xIdempotencyKey?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await ACHFilesApiAxiosParamCreator(configuration).createFile(body, xRequestID, xIdempotencyKey, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; + async createFile(body: string, xRequestID?: string, xIdempotencyKey?: string, requireABAOrigin?: boolean, bypassOrigin?: boolean, bypassDestination?: boolean, customTraceNumbers?: boolean, allowZeroBatches?: boolean, allowMissingFileHeader?: boolean, allowMissingFileControl?: boolean, bypassCompanyIdentificationMatch?: boolean, customReturnCodes?: boolean, unequalServiceClassCode?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createFile(body, xRequestID, xIdempotencyKey, requireABAOrigin, bypassOrigin, bypassDestination, customTraceNumbers, allowZeroBatches, allowMissingFileHeader, allowMissingFileControl, bypassCompanyIdentificationMatch, customReturnCodes, unequalServiceClassCode, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Permanently deletes a File and associated Batches. It cannot be undone. - * @summary Delete file + * @summary Delete File * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async deleteACHFile(fileID: string, xRequestID?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await ACHFilesApiAxiosParamCreator(configuration).deleteACHFile(fileID, xRequestID, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; + async deleteACHFile(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteACHFile(fileID, xRequestID, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Delete a Batch from a File - * @summary Delete batch + * Delete a Batch from a File. + * @summary Delete Batch * @param {string} fileID File ID * @param {string} batchID Batch ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async deleteFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await ACHFilesApiAxiosParamCreator(configuration).deleteFileBatch(fileID, batchID, xRequestID, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; + async deleteFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteFileBatch(fileID, batchID, xRequestID, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Consolidate batches and entries into the minimum number of batches needed. - * @summary Flatten batches + * Consolidate Batches and Entries into the minimum number of Batches needed. + * @summary Flatten Batches * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs - * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy for to not collide with each other in your requests. + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async flattenFile(fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await ACHFilesApiAxiosParamCreator(configuration).flattenFile(fileID, xRequestID, xIdempotencyKey, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; + async flattenFile(fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.flattenFile(fileID, xRequestID, xIdempotencyKey, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Get a specific Batch on a File + * Get a specific Batch on a File. * @summary Get Batch * @param {string} fileID File ID * @param {string} batchID Batch ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await ACHFilesApiAxiosParamCreator(configuration).getFileBatch(fileID, batchID, xRequestID, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; + async getFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFileBatch(fileID, batchID, xRequestID, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Get the batches on a File. - * @summary Get batches + * Get the Batches on a File. + * @summary Get Batches * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getFileBatches(fileID: string, xRequestID?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await ACHFilesApiAxiosParamCreator(configuration).getFileBatches(fileID, xRequestID, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; + async getFileBatches(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFileBatches(fileID, xRequestID, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Get the details of an existing File using the unique File identifier that was returned upon creation. - * @summary Retrieve a file + * @summary Retrieve File * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getFileByID(fileID: string, xRequestID?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await ACHFilesApiAxiosParamCreator(configuration).getFileByID(fileID, xRequestID, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; + async getFileByID(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFileByID(fileID, xRequestID, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Assembles the existing file (batches and controls) records, computes sequence numbers and totals. Returns plaintext file. - * @summary Get file contents + * Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file. + * @summary Get File Contents * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getFileContents(fileID: string, xRequestID?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await ACHFilesApiAxiosParamCreator(configuration).getFileContents(fileID, xRequestID, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; + async getFileContents(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFileContents(fileID, xRequestID, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * List all ACH files created with the ACH service. These files are not persisted through multiple runs of the service. - * @summary Get ACH files - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service. + * @summary List Files + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getFiles(xRequestID?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await ACHFilesApiAxiosParamCreator(configuration).getFiles(xRequestID, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; + async getFiles(xRequestID?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFiles(xRequestID, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Check the ACH service to check if running + * Check if the ACH service is running. * @summary Ping ACH service * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async ping(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await ACHFilesApiAxiosParamCreator(configuration).ping(options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; + async ping(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.ping(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Split one file into two. One with only debits and one with only credits. - * @summary Segment file + * Split one File into two. One with only debits and one with only credits. + * @summary Segment File * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs - * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy for to not collide with each other in your requests. + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async segmentFile(fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await ACHFilesApiAxiosParamCreator(configuration).segmentFile(fileID, xRequestID, xIdempotencyKey, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; + async segmentFile(fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.segmentFile(fileID, xRequestID, xIdempotencyKey, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Validates the existing file. You need only supply the unique File identifier that was returned upon creation. - * @summary Validate file + * Validates the existing File. You need only supply the unique File identifier that was returned upon creation. + * @summary Validate File (Custom) * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {ValidateOpts} [validateOpts] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async validateFile(fileID: string, xRequestID?: string, validateOpts?: ValidateOpts, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await ACHFilesApiAxiosParamCreator(configuration).validateFile(fileID, xRequestID, validateOpts, options); - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { - const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; - return axios.request(axiosRequestArgs); - }; + async validateFile(fileID: string, xRequestID?: string, validateOpts?: ValidateOpts, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.validateFile(fileID, xRequestID, validateOpts, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } }; @@ -2507,165 +2781,187 @@ export const ACHFilesApiFp = function(configuration?: Configuration) { * @export */ export const ACHFilesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { + const localVarFp = ACHFilesApiFp(configuration) return { /** - * Append a Batch record to the specified file - * @summary Add Batch to File + * Append a Batch record to the specified File. + * @summary Append Batch to File * @param {string} fileID File ID * @param {Batch} batch - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs - * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy for to not collide with each other in your requests. + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests. * @param {*} [options] Override http request option. * @throws {RequiredError} */ addBatchToFile(fileID: string, batch: Batch, xRequestID?: string, xIdempotencyKey?: string, options?: any): AxiosPromise { - return ACHFilesApiFp(configuration).addBatchToFile(fileID, batch, xRequestID, xIdempotencyKey, options).then((request) => request(axios, basePath)); + return localVarFp.addBatchToFile(fileID, batch, xRequestID, xIdempotencyKey, options).then((request) => request(axios, basePath)); + }, + /** + * Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file. + * @summary Build File + * @param {string} fileID File ID + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + buildFile(fileID: string, xRequestID?: string, options?: any): AxiosPromise { + return localVarFp.buildFile(fileID, xRequestID, options).then((request) => request(axios, basePath)); }, /** - * Validates the existing file. You need only supply the unique File identifier that was returned upon creation. - * @summary Validate file + * Validates the existing File. You need only supply the unique File identifier that was returned upon creation. + * @summary Validate File * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ checkFile(fileID: string, xRequestID?: string, options?: any): AxiosPromise { - return ACHFilesApiFp(configuration).checkFile(fileID, xRequestID, options).then((request) => request(axios, basePath)); + return localVarFp.checkFile(fileID, xRequestID, options).then((request) => request(axios, basePath)); }, /** * Create a new File object from either the plaintext or JSON representation. * @summary Create File * @param {string} body Content of the ACH file (in json or raw text) - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs - * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy for to not collide with each other in your requests. + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests. + * @param {boolean} [requireABAOrigin] Optional parameter to configure ImmediateOrigin validation + * @param {boolean} [bypassOrigin] Optional parameter to configure ImmediateOrigin validation + * @param {boolean} [bypassDestination] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [customTraceNumbers] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [allowZeroBatches] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [allowMissingFileHeader] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [allowMissingFileControl] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [bypassCompanyIdentificationMatch] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [customReturnCodes] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [unequalServiceClassCode] Optional parameter to configure ImmediateDestination validation * @param {*} [options] Override http request option. * @throws {RequiredError} */ - createFile(body: string, xRequestID?: string, xIdempotencyKey?: string, options?: any): AxiosPromise { - return ACHFilesApiFp(configuration).createFile(body, xRequestID, xIdempotencyKey, options).then((request) => request(axios, basePath)); + createFile(body: string, xRequestID?: string, xIdempotencyKey?: string, requireABAOrigin?: boolean, bypassOrigin?: boolean, bypassDestination?: boolean, customTraceNumbers?: boolean, allowZeroBatches?: boolean, allowMissingFileHeader?: boolean, allowMissingFileControl?: boolean, bypassCompanyIdentificationMatch?: boolean, customReturnCodes?: boolean, unequalServiceClassCode?: boolean, options?: any): AxiosPromise { + return localVarFp.createFile(body, xRequestID, xIdempotencyKey, requireABAOrigin, bypassOrigin, bypassDestination, customTraceNumbers, allowZeroBatches, allowMissingFileHeader, allowMissingFileControl, bypassCompanyIdentificationMatch, customReturnCodes, unequalServiceClassCode, options).then((request) => request(axios, basePath)); }, /** * Permanently deletes a File and associated Batches. It cannot be undone. - * @summary Delete file + * @summary Delete File * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteACHFile(fileID: string, xRequestID?: string, options?: any): AxiosPromise { - return ACHFilesApiFp(configuration).deleteACHFile(fileID, xRequestID, options).then((request) => request(axios, basePath)); + return localVarFp.deleteACHFile(fileID, xRequestID, options).then((request) => request(axios, basePath)); }, /** - * Delete a Batch from a File - * @summary Delete batch + * Delete a Batch from a File. + * @summary Delete Batch * @param {string} fileID File ID * @param {string} batchID Batch ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: any): AxiosPromise { - return ACHFilesApiFp(configuration).deleteFileBatch(fileID, batchID, xRequestID, options).then((request) => request(axios, basePath)); + return localVarFp.deleteFileBatch(fileID, batchID, xRequestID, options).then((request) => request(axios, basePath)); }, /** - * Consolidate batches and entries into the minimum number of batches needed. - * @summary Flatten batches + * Consolidate Batches and Entries into the minimum number of Batches needed. + * @summary Flatten Batches * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs - * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy for to not collide with each other in your requests. + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests. * @param {*} [options] Override http request option. * @throws {RequiredError} */ flattenFile(fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: any): AxiosPromise { - return ACHFilesApiFp(configuration).flattenFile(fileID, xRequestID, xIdempotencyKey, options).then((request) => request(axios, basePath)); + return localVarFp.flattenFile(fileID, xRequestID, xIdempotencyKey, options).then((request) => request(axios, basePath)); }, /** - * Get a specific Batch on a File + * Get a specific Batch on a File. * @summary Get Batch * @param {string} fileID File ID * @param {string} batchID Batch ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: any): AxiosPromise { - return ACHFilesApiFp(configuration).getFileBatch(fileID, batchID, xRequestID, options).then((request) => request(axios, basePath)); + return localVarFp.getFileBatch(fileID, batchID, xRequestID, options).then((request) => request(axios, basePath)); }, /** - * Get the batches on a File. - * @summary Get batches + * Get the Batches on a File. + * @summary Get Batches * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFileBatches(fileID: string, xRequestID?: string, options?: any): AxiosPromise> { - return ACHFilesApiFp(configuration).getFileBatches(fileID, xRequestID, options).then((request) => request(axios, basePath)); + return localVarFp.getFileBatches(fileID, xRequestID, options).then((request) => request(axios, basePath)); }, /** * Get the details of an existing File using the unique File identifier that was returned upon creation. - * @summary Retrieve a file + * @summary Retrieve File * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFileByID(fileID: string, xRequestID?: string, options?: any): AxiosPromise { - return ACHFilesApiFp(configuration).getFileByID(fileID, xRequestID, options).then((request) => request(axios, basePath)); + return localVarFp.getFileByID(fileID, xRequestID, options).then((request) => request(axios, basePath)); }, /** - * Assembles the existing file (batches and controls) records, computes sequence numbers and totals. Returns plaintext file. - * @summary Get file contents + * Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file. + * @summary Get File Contents * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFileContents(fileID: string, xRequestID?: string, options?: any): AxiosPromise { - return ACHFilesApiFp(configuration).getFileContents(fileID, xRequestID, options).then((request) => request(axios, basePath)); + return localVarFp.getFileContents(fileID, xRequestID, options).then((request) => request(axios, basePath)); }, /** - * List all ACH files created with the ACH service. These files are not persisted through multiple runs of the service. - * @summary Get ACH files - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service. + * @summary List Files + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} */ getFiles(xRequestID?: string, options?: any): AxiosPromise> { - return ACHFilesApiFp(configuration).getFiles(xRequestID, options).then((request) => request(axios, basePath)); + return localVarFp.getFiles(xRequestID, options).then((request) => request(axios, basePath)); }, /** - * Check the ACH service to check if running + * Check if the ACH service is running. * @summary Ping ACH service * @param {*} [options] Override http request option. * @throws {RequiredError} */ ping(options?: any): AxiosPromise { - return ACHFilesApiFp(configuration).ping(options).then((request) => request(axios, basePath)); + return localVarFp.ping(options).then((request) => request(axios, basePath)); }, /** - * Split one file into two. One with only debits and one with only credits. - * @summary Segment file + * Split one File into two. One with only debits and one with only credits. + * @summary Segment File * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs - * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy for to not collide with each other in your requests. + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests. * @param {*} [options] Override http request option. * @throws {RequiredError} */ segmentFile(fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: any): AxiosPromise { - return ACHFilesApiFp(configuration).segmentFile(fileID, xRequestID, xIdempotencyKey, options).then((request) => request(axios, basePath)); + return localVarFp.segmentFile(fileID, xRequestID, xIdempotencyKey, options).then((request) => request(axios, basePath)); }, /** - * Validates the existing file. You need only supply the unique File identifier that was returned upon creation. - * @summary Validate file + * Validates the existing File. You need only supply the unique File identifier that was returned upon creation. + * @summary Validate File (Custom) * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {ValidateOpts} [validateOpts] * @param {*} [options] Override http request option. * @throws {RequiredError} */ validateFile(fileID: string, xRequestID?: string, validateOpts?: ValidateOpts, options?: any): AxiosPromise { - return ACHFilesApiFp(configuration).validateFile(fileID, xRequestID, validateOpts, options).then((request) => request(axios, basePath)); + return localVarFp.validateFile(fileID, xRequestID, validateOpts, options).then((request) => request(axios, basePath)); }, }; }; @@ -2678,30 +2974,43 @@ export const ACHFilesApiFactory = function (configuration?: Configuration, baseP */ export class ACHFilesApi extends BaseAPI { /** - * Append a Batch record to the specified file - * @summary Add Batch to File + * Append a Batch record to the specified File. + * @summary Append Batch to File * @param {string} fileID File ID * @param {Batch} batch - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs - * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy for to not collide with each other in your requests. + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ACHFilesApi */ - public addBatchToFile(fileID: string, batch: Batch, xRequestID?: string, xIdempotencyKey?: string, options?: any) { + public addBatchToFile(fileID: string, batch: Batch, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig) { return ACHFilesApiFp(this.configuration).addBatchToFile(fileID, batch, xRequestID, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath)); } /** - * Validates the existing file. You need only supply the unique File identifier that was returned upon creation. - * @summary Validate file + * Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file. + * @summary Build File + * @param {string} fileID File ID + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ACHFilesApi + */ + public buildFile(fileID: string, xRequestID?: string, options?: AxiosRequestConfig) { + return ACHFilesApiFp(this.configuration).buildFile(fileID, xRequestID, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Validates the existing File. You need only supply the unique File identifier that was returned upon creation. + * @summary Validate File * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ACHFilesApi */ - public checkFile(fileID: string, xRequestID?: string, options?: any) { + public checkFile(fileID: string, xRequestID?: string, options?: AxiosRequestConfig) { return ACHFilesApiFp(this.configuration).checkFile(fileID, xRequestID, options).then((request) => request(this.axios, this.basePath)); } @@ -2709,161 +3018,170 @@ export class ACHFilesApi extends BaseAPI { * Create a new File object from either the plaintext or JSON representation. * @summary Create File * @param {string} body Content of the ACH file (in json or raw text) - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs - * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy for to not collide with each other in your requests. + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests. + * @param {boolean} [requireABAOrigin] Optional parameter to configure ImmediateOrigin validation + * @param {boolean} [bypassOrigin] Optional parameter to configure ImmediateOrigin validation + * @param {boolean} [bypassDestination] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [customTraceNumbers] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [allowZeroBatches] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [allowMissingFileHeader] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [allowMissingFileControl] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [bypassCompanyIdentificationMatch] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [customReturnCodes] Optional parameter to configure ImmediateDestination validation + * @param {boolean} [unequalServiceClassCode] Optional parameter to configure ImmediateDestination validation * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ACHFilesApi */ - public createFile(body: string, xRequestID?: string, xIdempotencyKey?: string, options?: any) { - return ACHFilesApiFp(this.configuration).createFile(body, xRequestID, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath)); + public createFile(body: string, xRequestID?: string, xIdempotencyKey?: string, requireABAOrigin?: boolean, bypassOrigin?: boolean, bypassDestination?: boolean, customTraceNumbers?: boolean, allowZeroBatches?: boolean, allowMissingFileHeader?: boolean, allowMissingFileControl?: boolean, bypassCompanyIdentificationMatch?: boolean, customReturnCodes?: boolean, unequalServiceClassCode?: boolean, options?: AxiosRequestConfig) { + return ACHFilesApiFp(this.configuration).createFile(body, xRequestID, xIdempotencyKey, requireABAOrigin, bypassOrigin, bypassDestination, customTraceNumbers, allowZeroBatches, allowMissingFileHeader, allowMissingFileControl, bypassCompanyIdentificationMatch, customReturnCodes, unequalServiceClassCode, options).then((request) => request(this.axios, this.basePath)); } /** * Permanently deletes a File and associated Batches. It cannot be undone. - * @summary Delete file + * @summary Delete File * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ACHFilesApi */ - public deleteACHFile(fileID: string, xRequestID?: string, options?: any) { + public deleteACHFile(fileID: string, xRequestID?: string, options?: AxiosRequestConfig) { return ACHFilesApiFp(this.configuration).deleteACHFile(fileID, xRequestID, options).then((request) => request(this.axios, this.basePath)); } /** - * Delete a Batch from a File - * @summary Delete batch + * Delete a Batch from a File. + * @summary Delete Batch * @param {string} fileID File ID * @param {string} batchID Batch ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ACHFilesApi */ - public deleteFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: any) { + public deleteFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig) { return ACHFilesApiFp(this.configuration).deleteFileBatch(fileID, batchID, xRequestID, options).then((request) => request(this.axios, this.basePath)); } /** - * Consolidate batches and entries into the minimum number of batches needed. - * @summary Flatten batches + * Consolidate Batches and Entries into the minimum number of Batches needed. + * @summary Flatten Batches * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs - * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy for to not collide with each other in your requests. + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ACHFilesApi */ - public flattenFile(fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: any) { + public flattenFile(fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig) { return ACHFilesApiFp(this.configuration).flattenFile(fileID, xRequestID, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath)); } /** - * Get a specific Batch on a File + * Get a specific Batch on a File. * @summary Get Batch * @param {string} fileID File ID * @param {string} batchID Batch ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ACHFilesApi */ - public getFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: any) { + public getFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig) { return ACHFilesApiFp(this.configuration).getFileBatch(fileID, batchID, xRequestID, options).then((request) => request(this.axios, this.basePath)); } /** - * Get the batches on a File. - * @summary Get batches + * Get the Batches on a File. + * @summary Get Batches * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ACHFilesApi */ - public getFileBatches(fileID: string, xRequestID?: string, options?: any) { + public getFileBatches(fileID: string, xRequestID?: string, options?: AxiosRequestConfig) { return ACHFilesApiFp(this.configuration).getFileBatches(fileID, xRequestID, options).then((request) => request(this.axios, this.basePath)); } /** * Get the details of an existing File using the unique File identifier that was returned upon creation. - * @summary Retrieve a file + * @summary Retrieve File * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ACHFilesApi */ - public getFileByID(fileID: string, xRequestID?: string, options?: any) { + public getFileByID(fileID: string, xRequestID?: string, options?: AxiosRequestConfig) { return ACHFilesApiFp(this.configuration).getFileByID(fileID, xRequestID, options).then((request) => request(this.axios, this.basePath)); } /** - * Assembles the existing file (batches and controls) records, computes sequence numbers and totals. Returns plaintext file. - * @summary Get file contents + * Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file. + * @summary Get File Contents * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ACHFilesApi */ - public getFileContents(fileID: string, xRequestID?: string, options?: any) { + public getFileContents(fileID: string, xRequestID?: string, options?: AxiosRequestConfig) { return ACHFilesApiFp(this.configuration).getFileContents(fileID, xRequestID, options).then((request) => request(this.axios, this.basePath)); } /** - * List all ACH files created with the ACH service. These files are not persisted through multiple runs of the service. - * @summary Get ACH files - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service. + * @summary List Files + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ACHFilesApi */ - public getFiles(xRequestID?: string, options?: any) { + public getFiles(xRequestID?: string, options?: AxiosRequestConfig) { return ACHFilesApiFp(this.configuration).getFiles(xRequestID, options).then((request) => request(this.axios, this.basePath)); } /** - * Check the ACH service to check if running + * Check if the ACH service is running. * @summary Ping ACH service * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ACHFilesApi */ - public ping(options?: any) { + public ping(options?: AxiosRequestConfig) { return ACHFilesApiFp(this.configuration).ping(options).then((request) => request(this.axios, this.basePath)); } /** - * Split one file into two. One with only debits and one with only credits. - * @summary Segment file + * Split one File into two. One with only debits and one with only credits. + * @summary Segment File * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs - * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy for to not collide with each other in your requests. + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs + * @param {string} [xIdempotencyKey] Idempotent key in the header which expires after 24 hours. These strings should contain enough entropy to not collide with each other in your requests. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ACHFilesApi */ - public segmentFile(fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: any) { + public segmentFile(fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig) { return ACHFilesApiFp(this.configuration).segmentFile(fileID, xRequestID, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath)); } /** - * Validates the existing file. You need only supply the unique File identifier that was returned upon creation. - * @summary Validate file + * Validates the existing File. You need only supply the unique File identifier that was returned upon creation. + * @summary Validate File (Custom) * @param {string} fileID File ID - * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the systems logs + * @param {string} [xRequestID] Optional Request ID allows application developer to trace requests through the system\'s logs * @param {ValidateOpts} [validateOpts] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ACHFilesApi */ - public validateFile(fileID: string, xRequestID?: string, validateOpts?: ValidateOpts, options?: any) { + public validateFile(fileID: string, xRequestID?: string, validateOpts?: ValidateOpts, options?: AxiosRequestConfig) { return ACHFilesApiFp(this.configuration).validateFile(fileID, xRequestID, validateOpts, options).then((request) => request(this.axios, this.basePath)); } - } diff --git a/base.ts b/base.ts index fce716d..1c10601 100644 --- a/base.ts +++ b/base.ts @@ -1,7 +1,8 @@ -// tslint:disable +/* tslint:disable */ +/* eslint-disable */ /** * ACH API - * Moov ACH ([Automated Clearing House](https://en.wikipedia.org/wiki/Automated_Clearing_House)) implements an HTTP API for creating, parsing and validating ACH files. ACH is the primary method of electronic money movement throughout the United States. + * Moov ACH ([Automated Clearing House](https://en.wikipedia.org/wiki/Automated_Clearing_House)) implements an HTTP API for creating, parsing, and validating ACH files. ACH is the primary method of electronic money movement throughout the United States. * * The version of the OpenAPI document: v1 * @@ -15,7 +16,7 @@ import { Configuration } from "./configuration"; // Some imports not used depending on template conditions // @ts-ignore -import globalAxios, { AxiosPromise, AxiosInstance } from 'axios'; +import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; export const BASE_PATH = "http://localhost:8080".replace(/\/+$/, ""); @@ -37,7 +38,7 @@ export const COLLECTION_FORMATS = { */ export interface RequestArgs { url: string; - options: any; + options: AxiosRequestConfig; } /** diff --git a/common.ts b/common.ts new file mode 100644 index 0000000..f5fb476 --- /dev/null +++ b/common.ts @@ -0,0 +1,138 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * ACH API + * Moov ACH ([Automated Clearing House](https://en.wikipedia.org/wiki/Automated_Clearing_House)) implements an HTTP API for creating, parsing, and validating ACH files. ACH is the primary method of electronic money movement throughout the United States. + * + * The version of the OpenAPI document: v1 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +import { Configuration } from "./configuration"; +import { RequiredError, RequestArgs } from "./base"; +import { AxiosInstance, AxiosResponse } from 'axios'; + +/** + * + * @export + */ +export const DUMMY_BASE_URL = 'https://example.com' + +/** + * + * @throws {RequiredError} + * @export + */ +export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) { + if (paramValue === null || paramValue === undefined) { + throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`); + } +} + +/** + * + * @export + */ +export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) { + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey(keyParamName) + : await configuration.apiKey; + object[keyParamName] = localVarApiKeyValue; + } +} + +/** + * + * @export + */ +export const setBasicAuthToObject = function (object: any, configuration?: Configuration) { + if (configuration && (configuration.username || configuration.password)) { + object["auth"] = { username: configuration.username, password: configuration.password }; + } +} + +/** + * + * @export + */ +export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const accessToken = typeof configuration.accessToken === 'function' + ? await configuration.accessToken() + : await configuration.accessToken; + object["Authorization"] = "Bearer " + accessToken; + } +} + +/** + * + * @export + */ +export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) { + if (configuration && configuration.accessToken) { + const localVarAccessTokenValue = typeof configuration.accessToken === 'function' + ? await configuration.accessToken(name, scopes) + : await configuration.accessToken; + object["Authorization"] = "Bearer " + localVarAccessTokenValue; + } +} + +/** + * + * @export + */ +export const setSearchParams = function (url: URL, ...objects: any[]) { + const searchParams = new URLSearchParams(url.search); + for (const object of objects) { + for (const key in object) { + if (Array.isArray(object[key])) { + searchParams.delete(key); + for (const item of object[key]) { + searchParams.append(key, item); + } + } else { + searchParams.set(key, object[key]); + } + } + } + url.search = searchParams.toString(); +} + +/** + * + * @export + */ +export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) { + const nonString = typeof value !== 'string'; + const needsSerialization = nonString && configuration && configuration.isJsonMime + ? configuration.isJsonMime(requestOptions.headers['Content-Type']) + : nonString; + return needsSerialization + ? JSON.stringify(value !== undefined ? value : {}) + : (value || ""); +} + +/** + * + * @export + */ +export const toPathString = function (url: URL) { + return url.pathname + url.search + url.hash +} + +/** + * + * @export + */ +export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) { + return >(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + const axiosRequestArgs = {...axiosArgs.options, url: (configuration?.basePath || basePath) + axiosArgs.url}; + return axios.request(axiosRequestArgs); + }; +} diff --git a/configuration.ts b/configuration.ts index 647ef3a..556c267 100644 --- a/configuration.ts +++ b/configuration.ts @@ -1,7 +1,8 @@ -// tslint:disable +/* tslint:disable */ +/* eslint-disable */ /** * ACH API - * Moov ACH ([Automated Clearing House](https://en.wikipedia.org/wiki/Automated_Clearing_House)) implements an HTTP API for creating, parsing and validating ACH files. ACH is the primary method of electronic money movement throughout the United States. + * Moov ACH ([Automated Clearing House](https://en.wikipedia.org/wiki/Automated_Clearing_House)) implements an HTTP API for creating, parsing, and validating ACH files. ACH is the primary method of electronic money movement throughout the United States. * * The version of the OpenAPI document: v1 * @@ -16,9 +17,10 @@ export interface ConfigurationParameters { apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); username?: string; password?: string; - accessToken?: string | ((name?: string, scopes?: string[]) => string); + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); basePath?: string; baseOptions?: any; + formDataCtor?: new () => any; } export class Configuration { @@ -30,14 +32,14 @@ export class Configuration { apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security - * + * * @type {string} * @memberof Configuration */ username?: string; /** * parameter for basic security - * + * * @type {string} * @memberof Configuration */ @@ -48,10 +50,10 @@ export class Configuration { * @param scopes oauth2 scope * @memberof Configuration */ - accessToken?: string | ((name?: string, scopes?: string[]) => string); + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path - * + * * @type {string} * @memberof Configuration */ @@ -63,6 +65,14 @@ export class Configuration { * @memberof Configuration */ baseOptions?: any; + /** + * The FormData constructor that will be used to create multipart form data + * requests. You can inject this here so that execution environments that + * do not support the FormData class can still run the generated client. + * + * @type {new () => FormData} + */ + formDataCtor?: new () => any; constructor(param: ConfigurationParameters = {}) { this.apiKey = param.apiKey; @@ -71,5 +81,21 @@ export class Configuration { this.accessToken = param.accessToken; this.basePath = param.basePath; this.baseOptions = param.baseOptions; + this.formDataCtor = param.formDataCtor; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); } } diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e2ac661 --- /dev/null +++ b/docs/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/assets/css/main.css b/docs/assets/css/main.css deleted file mode 100644 index 959edd7..0000000 --- a/docs/assets/css/main.css +++ /dev/null @@ -1,2679 +0,0 @@ -/*! normalize.css v1.1.3 | MIT License | git.io/normalize */ -/* ========================================================================== - * * HTML5 display definitions - * * ========================================================================== */ -/** - * * Correct `block` display not defined in IE 6/7/8/9 and Firefox 3. */ -article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { - display: block; -} - -/** - * * Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3. */ -audio, canvas, video { - display: inline-block; - *display: inline; - *zoom: 1; -} - -/** - * * Prevent modern browsers from displaying `audio` without controls. - * * Remove excess height in iOS 5 devices. */ -audio:not([controls]) { - display: none; - height: 0; -} - -/** - * * Address styling not present in IE 7/8/9, Firefox 3, and Safari 4. - * * Known issue: no IE 6 support. */ -[hidden] { - display: none; -} - -/* ========================================================================== - * * Base - * * ========================================================================== */ -/** - * * 1. Correct text resizing oddly in IE 6/7 when body `font-size` is set using - * * `em` units. - * * 2. Prevent iOS text size adjust after orientation change, without disabling - * * user zoom. */ -html { - font-size: 100%; - /* 1 */ - -ms-text-size-adjust: 100%; - /* 2 */ - -webkit-text-size-adjust: 100%; - /* 2 */ - font-family: sans-serif; -} - -/** - * * Address `font-family` inconsistency between `textarea` and other form - * * elements. */ -button, input, select, textarea { - font-family: sans-serif; -} - -/** - * * Address margins handled incorrectly in IE 6/7. */ -body { - margin: 0; -} - -/* ========================================================================== - * * Links - * * ========================================================================== */ -/** - * * Address `outline` inconsistency between Chrome and other browsers. */ -a:focus { - outline: thin dotted; -} -a:active, a:hover { - outline: 0; -} - -/** - * * Improve readability when focused and also mouse hovered in all browsers. */ -/* ========================================================================== - * * Typography - * * ========================================================================== */ -/** - * * Address font sizes and margins set differently in IE 6/7. - * * Address font sizes within `section` and `article` in Firefox 4+, Safari 5, - * * and Chrome. */ -h1 { - font-size: 2em; - margin: 0.67em 0; -} - -h2 { - font-size: 1.5em; - margin: 0.83em 0; -} - -h3 { - font-size: 1.17em; - margin: 1em 0; -} - -h4, .tsd-index-panel h3 { - font-size: 1em; - margin: 1.33em 0; -} - -h5 { - font-size: 0.83em; - margin: 1.67em 0; -} - -h6 { - font-size: 0.67em; - margin: 2.33em 0; -} - -/** - * * Address styling not present in IE 7/8/9, Safari 5, and Chrome. */ -abbr[title] { - border-bottom: 1px dotted; -} - -/** - * * Address style set to `bolder` in Firefox 3+, Safari 4/5, and Chrome. */ -b, strong { - font-weight: bold; -} - -blockquote { - margin: 1em 40px; -} - -/** - * * Address styling not present in Safari 5 and Chrome. */ -dfn { - font-style: italic; -} - -/** - * * Address differences between Firefox and other browsers. - * * Known issue: no IE 6/7 normalization. */ -hr { - box-sizing: content-box; - height: 0; -} - -/** - * * Address styling not present in IE 6/7/8/9. */ -mark { - background: #ff0; - color: #000; -} - -/** - * * Address margins set differently in IE 6/7. */ -p, pre { - margin: 1em 0; -} - -/** - * * Correct font family set oddly in IE 6, Safari 4/5, and Chrome. */ -code, kbd, pre, samp { - font-family: monospace, serif; - _font-family: "courier new", monospace; - font-size: 1em; -} - -/** - * * Improve readability of pre-formatted text in all browsers. */ -pre { - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; -} - -/** - * * Address CSS quotes not supported in IE 6/7. */ -q { - quotes: none; -} -q:before, q:after { - content: ""; - content: none; -} - -/** - * * Address `quotes` property not supported in Safari 4. */ -/** - * * Address inconsistent and variable font size in all browsers. */ -small { - font-size: 80%; -} - -/** - * * Prevent `sub` and `sup` affecting `line-height` in all browsers. */ -sub { - font-size: 75%; - line-height: 0; - position: relative; - vertical-align: baseline; -} - -sup { - font-size: 75%; - line-height: 0; - position: relative; - vertical-align: baseline; - top: -0.5em; -} - -sub { - bottom: -0.25em; -} - -/* ========================================================================== - * * Lists - * * ========================================================================== */ -/** - * * Address margins set differently in IE 6/7. */ -dl, menu, ol, ul { - margin: 1em 0; -} - -dd { - margin: 0 0 0 40px; -} - -/** - * * Address paddings set differently in IE 6/7. */ -menu, ol, ul { - padding: 0 0 0 40px; -} - -/** - * * Correct list images handled incorrectly in IE 7. */ -nav ul, nav ol { - list-style: none; - list-style-image: none; -} - -/* ========================================================================== - * * Embedded content - * * ========================================================================== */ -/** - * * 1. Remove border when inside `a` element in IE 6/7/8/9 and Firefox 3. - * * 2. Improve image quality when scaled in IE 7. */ -img { - border: 0; - /* 1 */ - -ms-interpolation-mode: bicubic; -} - -/* 2 */ -/** - * * Correct overflow displayed oddly in IE 9. */ -svg:not(:root) { - overflow: hidden; -} - -/* ========================================================================== - * * Figures - * * ========================================================================== */ -/** - * * Address margin not present in IE 6/7/8/9, Safari 5, and Opera 11. */ -figure, form { - margin: 0; -} - -/* ========================================================================== - * * Forms - * * ========================================================================== */ -/** - * * Correct margin displayed oddly in IE 6/7. */ -/** - * * Define consistent border, margin, and padding. */ -fieldset { - border: 1px solid #c0c0c0; - margin: 0 2px; - padding: 0.35em 0.625em 0.75em; -} - -/** - * * 1. Correct color not being inherited in IE 6/7/8/9. - * * 2. Correct text not wrapping in Firefox 3. - * * 3. Correct alignment displayed oddly in IE 6/7. */ -legend { - border: 0; - /* 1 */ - padding: 0; - white-space: normal; - /* 2 */ - *margin-left: -7px; -} - -/* 3 */ -/** - * * 1. Correct font size not being inherited in all browsers. - * * 2. Address margins set differently in IE 6/7, Firefox 3+, Safari 5, - * * and Chrome. - * * 3. Improve appearance and consistency in all browsers. */ -button, input, select, textarea { - font-size: 100%; - /* 1 */ - margin: 0; - /* 2 */ - vertical-align: baseline; - /* 3 */ - *vertical-align: middle; -} - -/* 3 */ -/** - * * Address Firefox 3+ setting `line-height` on `input` using `!important` in - * * the UA stylesheet. */ -button, input { - line-height: normal; -} - -/** - * * Address inconsistent `text-transform` inheritance for `button` and `select`. - * * All other form control elements do not inherit `text-transform` values. - * * Correct `button` style inheritance in Chrome, Safari 5+, and IE 6+. - * * Correct `select` style inheritance in Firefox 4+ and Opera. */ -button, select { - text-transform: none; -} - -/** - * * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` - * * and `video` controls. - * * 2. Correct inability to style clickable `input` types in iOS. - * * 3. Improve usability and consistency of cursor style between image-type - * * `input` and others. - * * 4. Remove inner spacing in IE 7 without affecting normal text inputs. - * * Known issue: inner spacing remains in IE 6. */ -button, html input[type=button] { - -webkit-appearance: button; - /* 2 */ - cursor: pointer; - /* 3 */ - *overflow: visible; -} - -/* 4 */ -input[type=reset], input[type=submit] { - -webkit-appearance: button; - /* 2 */ - cursor: pointer; - /* 3 */ - *overflow: visible; -} - -/* 4 */ -/** - * * Re-set default cursor for disabled elements. */ -button[disabled], html input[disabled] { - cursor: default; -} - -/** - * * 1. Address box sizing set to content-box in IE 8/9. - * * 2. Remove excess padding in IE 8/9. - * * 3. Remove excess padding in IE 7. - * * Known issue: excess padding remains in IE 6. */ -input { - /* 3 */ -} -input[type=checkbox], input[type=radio] { - box-sizing: border-box; - /* 1 */ - padding: 0; - /* 2 */ - *height: 13px; - /* 3 */ - *width: 13px; -} -input[type=search] { - -webkit-appearance: textfield; - /* 1 */ - /* 2 */ - box-sizing: content-box; -} -input[type=search]::-webkit-search-cancel-button, input[type=search]::-webkit-search-decoration { - -webkit-appearance: none; -} - -/** - * * 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome. - * * 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome - * * (include `-moz` to future-proof). */ -/** - * * Remove inner padding and search cancel button in Safari 5 and Chrome - * * on OS X. */ -/** - * * Remove inner padding and border in Firefox 3+. */ -button::-moz-focus-inner, input::-moz-focus-inner { - border: 0; - padding: 0; -} - -/** - * * 1. Remove default vertical scrollbar in IE 6/7/8/9. - * * 2. Improve readability and alignment in all browsers. */ -textarea { - overflow: auto; - /* 1 */ - vertical-align: top; -} - -/* 2 */ -/* ========================================================================== - * * Tables - * * ========================================================================== */ -/** - * * Remove most spacing between table cells. */ -table { - border-collapse: collapse; - border-spacing: 0; -} - -/* * - * *Visual Studio-like style based on original C# coloring by Jason Diamond */ -.hljs { - display: inline-block; - padding: 0.5em; - background: white; - color: black; -} - -.hljs-comment, .hljs-annotation, .hljs-template_comment, .diff .hljs-header, .hljs-chunk, .apache .hljs-cbracket { - color: #008000; -} - -.hljs-keyword, .hljs-id, .hljs-built_in, .css .smalltalk .hljs-class, .hljs-winutils, .bash .hljs-variable, .tex .hljs-command, .hljs-request, .hljs-status, .nginx .hljs-title { - color: #00f; -} - -.xml .hljs-tag { - color: #00f; -} -.xml .hljs-tag .hljs-value { - color: #00f; -} - -.hljs-string, .hljs-title, .hljs-parent, .hljs-tag .hljs-value, .hljs-rules .hljs-value { - color: #a31515; -} - -.ruby .hljs-symbol { - color: #a31515; -} -.ruby .hljs-symbol .hljs-string { - color: #a31515; -} - -.hljs-template_tag, .django .hljs-variable, .hljs-addition, .hljs-flow, .hljs-stream, .apache .hljs-tag, .hljs-date, .tex .hljs-formula, .coffeescript .hljs-attribute { - color: #a31515; -} - -.ruby .hljs-string, .hljs-decorator, .hljs-filter .hljs-argument, .hljs-localvars, .hljs-array, .hljs-attr_selector, .hljs-pseudo, .hljs-pi, .hljs-doctype, .hljs-deletion, .hljs-envvar, .hljs-shebang, .hljs-preprocessor, .hljs-pragma, .userType, .apache .hljs-sqbracket, .nginx .hljs-built_in, .tex .hljs-special, .hljs-prompt { - color: #2b91af; -} - -.hljs-phpdoc, .hljs-javadoc, .hljs-xmlDocTag { - color: #808080; -} - -.vhdl .hljs-typename { - font-weight: bold; -} -.vhdl .hljs-string { - color: #666666; -} -.vhdl .hljs-literal { - color: #a31515; -} -.vhdl .hljs-attribute { - color: #00b0e8; -} - -.xml .hljs-attribute { - color: #f00; -} - -ul.tsd-descriptions > li > :first-child, .tsd-panel > :first-child, .col > :first-child, .col-11 > :first-child, .col-10 > :first-child, .col-9 > :first-child, .col-8 > :first-child, .col-7 > :first-child, .col-6 > :first-child, .col-5 > :first-child, .col-4 > :first-child, .col-3 > :first-child, .col-2 > :first-child, .col-1 > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child, -.tsd-panel > :first-child > :first-child, -.col > :first-child > :first-child, -.col-11 > :first-child > :first-child, -.col-10 > :first-child > :first-child, -.col-9 > :first-child > :first-child, -.col-8 > :first-child > :first-child, -.col-7 > :first-child > :first-child, -.col-6 > :first-child > :first-child, -.col-5 > :first-child > :first-child, -.col-4 > :first-child > :first-child, -.col-3 > :first-child > :first-child, -.col-2 > :first-child > :first-child, -.col-1 > :first-child > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child > :first-child, -.tsd-panel > :first-child > :first-child > :first-child, -.col > :first-child > :first-child > :first-child, -.col-11 > :first-child > :first-child > :first-child, -.col-10 > :first-child > :first-child > :first-child, -.col-9 > :first-child > :first-child > :first-child, -.col-8 > :first-child > :first-child > :first-child, -.col-7 > :first-child > :first-child > :first-child, -.col-6 > :first-child > :first-child > :first-child, -.col-5 > :first-child > :first-child > :first-child, -.col-4 > :first-child > :first-child > :first-child, -.col-3 > :first-child > :first-child > :first-child, -.col-2 > :first-child > :first-child > :first-child, -.col-1 > :first-child > :first-child > :first-child { - margin-top: 0; -} -ul.tsd-descriptions > li > :last-child, .tsd-panel > :last-child, .col > :last-child, .col-11 > :last-child, .col-10 > :last-child, .col-9 > :last-child, .col-8 > :last-child, .col-7 > :last-child, .col-6 > :last-child, .col-5 > :last-child, .col-4 > :last-child, .col-3 > :last-child, .col-2 > :last-child, .col-1 > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child, -.tsd-panel > :last-child > :last-child, -.col > :last-child > :last-child, -.col-11 > :last-child > :last-child, -.col-10 > :last-child > :last-child, -.col-9 > :last-child > :last-child, -.col-8 > :last-child > :last-child, -.col-7 > :last-child > :last-child, -.col-6 > :last-child > :last-child, -.col-5 > :last-child > :last-child, -.col-4 > :last-child > :last-child, -.col-3 > :last-child > :last-child, -.col-2 > :last-child > :last-child, -.col-1 > :last-child > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child > :last-child, -.tsd-panel > :last-child > :last-child > :last-child, -.col > :last-child > :last-child > :last-child, -.col-11 > :last-child > :last-child > :last-child, -.col-10 > :last-child > :last-child > :last-child, -.col-9 > :last-child > :last-child > :last-child, -.col-8 > :last-child > :last-child > :last-child, -.col-7 > :last-child > :last-child > :last-child, -.col-6 > :last-child > :last-child > :last-child, -.col-5 > :last-child > :last-child > :last-child, -.col-4 > :last-child > :last-child > :last-child, -.col-3 > :last-child > :last-child > :last-child, -.col-2 > :last-child > :last-child > :last-child, -.col-1 > :last-child > :last-child > :last-child { - margin-bottom: 0; -} - -.container { - max-width: 1200px; - margin: 0 auto; - padding: 0 40px; -} -@media (max-width: 640px) { - .container { - padding: 0 20px; - } -} - -.container-main { - padding-bottom: 200px; -} - -.row { - display: -ms-flexbox; - display: flex; - position: relative; - margin: 0 -10px; -} -.row:after { - visibility: hidden; - display: block; - content: ""; - clear: both; - height: 0; -} - -.col, .col-11, .col-10, .col-9, .col-8, .col-7, .col-6, .col-5, .col-4, .col-3, .col-2, .col-1 { - box-sizing: border-box; - float: left; - padding: 0 10px; -} - -.col-1 { - width: 8.3333333333%; -} - -.offset-1 { - margin-left: 8.3333333333%; -} - -.col-2 { - width: 16.6666666667%; -} - -.offset-2 { - margin-left: 16.6666666667%; -} - -.col-3 { - width: 25%; -} - -.offset-3 { - margin-left: 25%; -} - -.col-4 { - width: 33.3333333333%; -} - -.offset-4 { - margin-left: 33.3333333333%; -} - -.col-5 { - width: 41.6666666667%; -} - -.offset-5 { - margin-left: 41.6666666667%; -} - -.col-6 { - width: 50%; -} - -.offset-6 { - margin-left: 50%; -} - -.col-7 { - width: 58.3333333333%; -} - -.offset-7 { - margin-left: 58.3333333333%; -} - -.col-8 { - width: 66.6666666667%; -} - -.offset-8 { - margin-left: 66.6666666667%; -} - -.col-9 { - width: 75%; -} - -.offset-9 { - margin-left: 75%; -} - -.col-10 { - width: 83.3333333333%; -} - -.offset-10 { - margin-left: 83.3333333333%; -} - -.col-11 { - width: 91.6666666667%; -} - -.offset-11 { - margin-left: 91.6666666667%; -} - -.tsd-kind-icon { - display: block; - position: relative; - padding-left: 20px; - text-indent: -20px; -} -.tsd-kind-icon:before { - content: ""; - display: inline-block; - vertical-align: middle; - width: 17px; - height: 17px; - margin: 0 3px 2px 0; - background-image: url(../images/icons.png); -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-kind-icon:before { - background-image: url(../images/icons@2x.png); - background-size: 238px 204px; - } -} - -.tsd-signature.tsd-kind-icon:before { - background-position: 0 -153px; -} - -.tsd-kind-object-literal > .tsd-kind-icon:before { - background-position: 0px -17px; -} -.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -17px; -} -.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -17px; -} - -.tsd-kind-class > .tsd-kind-icon:before { - background-position: 0px -34px; -} -.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -34px; -} -.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -34px; -} - -.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -51px; -} - -.tsd-kind-interface > .tsd-kind-icon:before { - background-position: 0px -68px; -} -.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -68px; -} -.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -68px; -} - -.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -85px; -} - -.tsd-kind-namespace > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-module > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-enum > .tsd-kind-icon:before { - background-position: 0px -119px; -} -.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -119px; -} -.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -119px; -} - -.tsd-kind-enum-member > .tsd-kind-icon:before { - background-position: 0px -136px; -} -.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -136px; -} -.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -136px; -} - -.tsd-kind-signature > .tsd-kind-icon:before { - background-position: 0px -153px; -} -.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -153px; -} -.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -153px; -} - -.tsd-kind-type-alias > .tsd-kind-icon:before { - background-position: 0px -170px; -} -.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -170px; -} -.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -170px; -} - -.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -187px; -} - -.tsd-kind-variable > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-property > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-get-signature > .tsd-kind-icon:before { - background-position: -136px -17px; -} -.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -17px; -} -.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -17px; -} - -.tsd-kind-set-signature > .tsd-kind-icon:before { - background-position: -136px -34px; -} -.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -34px; -} -.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -34px; -} - -.tsd-kind-accessor > .tsd-kind-icon:before { - background-position: -136px -51px; -} -.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -51px; -} -.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -51px; -} - -.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-constructor > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-constructor-signature > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-index-signature > .tsd-kind-icon:before { - background-position: -136px -119px; -} -.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -119px; -} -.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -119px; -} - -.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -136px; -} -.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -136px; -} -.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -136px; -} - -.tsd-is-static > .tsd-kind-icon:before { - background-position: -136px -153px; -} -.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -153px; -} -.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -153px; -} -.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -153px; -} - -.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -102px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -221px -187px; -} - -@keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; - } - 33% { - opacity: 0; - } - 100% { - opacity: 1; - } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; - } - 66% { - opacity: 0; - } - 100% { - opacity: 0; - } -} -@keyframes shift-to-left { - from { - transform: translate(0, 0); - } - to { - transform: translate(-25%, 0); - } -} -@keyframes unshift-to-left { - from { - transform: translate(-25%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } -} -body { - background: #fdfdfd; - font-family: "Segoe UI", sans-serif; - font-size: 16px; - color: #222; -} - -a { - color: #4da6ff; - text-decoration: none; -} -a:hover { - text-decoration: underline; -} - -code, pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 14px; - background-color: rgba(0, 0, 0, 0.04); -} - -pre { - padding: 10px; -} -pre code { - padding: 0; - font-size: 100%; - background-color: transparent; -} - -.tsd-typography { - line-height: 1.333em; -} -.tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, .tsd-typography h5, .tsd-typography h6 { - font-size: 1em; - margin: 0; -} -.tsd-typography h5, .tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, .tsd-typography ul, .tsd-typography ol { - margin: 1em 0; -} - -@media (min-width: 901px) and (max-width: 1024px) { - html.default .col-content { - width: 72%; - } - html.default .col-menu { - width: 28%; - } - html.default .tsd-navigation { - padding-left: 10px; - } -} -@media (max-width: 900px) { - html.default .col-content { - float: none; - width: 100%; - } - html.default .col-menu { - position: fixed !important; - overflow: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - width: 100%; - padding: 20px 20px 0 0; - max-width: 450px; - visibility: hidden; - background-color: #fff; - transform: translate(100%, 0); - } - html.default .col-menu > *:last-child { - padding-bottom: 20px; - } - html.default .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - html.default.to-has-menu .overlay { - animation: fade-in 0.4s; - } - html.default.to-has-menu header, -html.default.to-has-menu footer, -html.default.to-has-menu .col-content { - animation: shift-to-left 0.4s; - } - html.default.to-has-menu .col-menu { - animation: pop-in-from-right 0.4s; - } - html.default.from-has-menu .overlay { - animation: fade-out 0.4s; - } - html.default.from-has-menu header, -html.default.from-has-menu footer, -html.default.from-has-menu .col-content { - animation: unshift-to-left 0.4s; - } - html.default.from-has-menu .col-menu { - animation: pop-out-to-right 0.4s; - } - html.default.has-menu body { - overflow: hidden; - } - html.default.has-menu .overlay { - visibility: visible; - } - html.default.has-menu header, -html.default.has-menu footer, -html.default.has-menu .col-content { - transform: translate(-25%, 0); - } - html.default.has-menu .col-menu { - visibility: visible; - transform: translate(0, 0); - } -} - -.tsd-page-title { - padding: 70px 0 20px 0; - margin: 0 0 40px 0; - background: #fff; - box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); -} -.tsd-page-title h1 { - margin: 0; -} - -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: #808080; -} -.tsd-breadcrumb a { - color: #808080; - text-decoration: none; -} -.tsd-breadcrumb a:hover { - text-decoration: underline; -} -.tsd-breadcrumb li { - display: inline; -} -.tsd-breadcrumb li:after { - content: " / "; -} - -html.minimal .container { - margin: 0; -} -html.minimal .container-main { - padding-top: 50px; - padding-bottom: 0; -} -html.minimal .content-wrap { - padding-left: 300px; -} -html.minimal .tsd-navigation { - position: fixed !important; - overflow: auto; - -webkit-overflow-scrolling: touch; - box-sizing: border-box; - z-index: 1; - left: 0; - top: 40px; - bottom: 0; - width: 300px; - padding: 20px; - margin: 0; -} -html.minimal .tsd-member .tsd-member { - margin-left: 0; -} -html.minimal .tsd-page-toolbar { - position: fixed; - z-index: 2; -} -html.minimal #tsd-filter .tsd-filter-group { - right: 0; - transform: none; -} -html.minimal footer { - background-color: transparent; -} -html.minimal footer .container { - padding: 0; -} -html.minimal .tsd-generator { - padding: 0; -} -@media (max-width: 900px) { - html.minimal .tsd-navigation { - display: none; - } - html.minimal .content-wrap { - padding-left: 0; - } -} - -dl.tsd-comment-tags { - overflow: hidden; -} -dl.tsd-comment-tags dt { - float: left; - padding: 1px 5px; - margin: 0 10px 0 0; - border-radius: 4px; - border: 1px solid #808080; - color: #808080; - font-size: 0.8em; - font-weight: normal; -} -dl.tsd-comment-tags dd { - margin: 0 0 10px 0; -} -dl.tsd-comment-tags dd:before, dl.tsd-comment-tags dd:after { - display: table; - content: " "; -} -dl.tsd-comment-tags dd pre, dl.tsd-comment-tags dd:after { - clear: both; -} -dl.tsd-comment-tags p { - margin: 0; -} - -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; -} -.tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; -} - -.toggle-protected .tsd-is-private { - display: none; -} - -.toggle-public .tsd-is-private, -.toggle-public .tsd-is-protected, -.toggle-public .tsd-is-private-protected { - display: none; -} - -.toggle-inherited .tsd-is-inherited { - display: none; -} - -.toggle-only-exported .tsd-is-not-exported { - display: none; -} - -.toggle-externals .tsd-is-external { - display: none; -} - -#tsd-filter { - position: relative; - display: inline-block; - height: 40px; - vertical-align: bottom; -} -.no-filter #tsd-filter { - display: none; -} -#tsd-filter .tsd-filter-group { - display: inline-block; - height: 40px; - vertical-align: bottom; - white-space: nowrap; -} -#tsd-filter input { - display: none; -} -@media (max-width: 900px) { - #tsd-filter .tsd-filter-group { - display: block; - position: absolute; - top: 40px; - right: 20px; - height: auto; - background-color: #fff; - visibility: hidden; - transform: translate(50%, 0); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - } - .has-options #tsd-filter .tsd-filter-group { - visibility: visible; - } - .to-has-options #tsd-filter .tsd-filter-group { - animation: fade-in 0.2s; - } - .from-has-options #tsd-filter .tsd-filter-group { - animation: fade-out 0.2s; - } - #tsd-filter label, -#tsd-filter .tsd-select { - display: block; - padding-right: 20px; - } -} - -footer { - border-top: 1px solid #eee; - background-color: #fff; -} -footer.with-border-bottom { - border-bottom: 1px solid #eee; -} -footer .tsd-legend-group { - font-size: 0; -} -footer .tsd-legend { - display: inline-block; - width: 25%; - padding: 0; - font-size: 16px; - list-style: none; - line-height: 1.333em; - vertical-align: top; -} -@media (max-width: 900px) { - footer .tsd-legend { - width: 50%; - } -} - -.tsd-hierarchy { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} - -.tsd-index-panel .tsd-index-content { - margin-bottom: -30px !important; -} -.tsd-index-panel .tsd-index-section { - margin-bottom: 30px !important; -} -.tsd-index-panel h3 { - margin: 0 -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid #eee; -} -.tsd-index-panel ul.tsd-index-list { - -moz-column-count: 3; - -ms-column-count: 3; - -o-column-count: 3; - column-count: 3; - -moz-column-gap: 20px; - -ms-column-gap: 20px; - -o-column-gap: 20px; - column-gap: 20px; - padding: 0; - list-style: none; - line-height: 1.333em; -} -@media (max-width: 900px) { - .tsd-index-panel ul.tsd-index-list { - -moz-column-count: 1; - -ms-column-count: 1; - -o-column-count: 1; - column-count: 1; - } -} -@media (min-width: 901px) and (max-width: 1024px) { - .tsd-index-panel ul.tsd-index-list { - -moz-column-count: 2; - -ms-column-count: 2; - -o-column-count: 2; - column-count: 2; - } -} -.tsd-index-panel ul.tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; -} -.tsd-index-panel a, -.tsd-index-panel .tsd-parent-kind-module a { - color: #9600ff; -} -.tsd-index-panel .tsd-parent-kind-interface a { - color: #7da01f; -} -.tsd-index-panel .tsd-parent-kind-enum a { - color: #cc9900; -} -.tsd-index-panel .tsd-parent-kind-class a { - color: #4da6ff; -} -.tsd-index-panel .tsd-kind-module a { - color: #9600ff; -} -.tsd-index-panel .tsd-kind-interface a { - color: #7da01f; -} -.tsd-index-panel .tsd-kind-enum a { - color: #cc9900; -} -.tsd-index-panel .tsd-kind-class a { - color: #4da6ff; -} -.tsd-index-panel .tsd-is-private a { - color: #808080; -} - -.tsd-flag { - display: inline-block; - padding: 1px 5px; - border-radius: 4px; - color: #fff; - background-color: #808080; - text-indent: 0; - font-size: 14px; - font-weight: normal; -} - -.tsd-anchor { - position: absolute; - top: -100px; -} - -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} - -.tsd-navigation { - margin: 0 0 0 40px; -} -.tsd-navigation a { - display: block; - padding-top: 2px; - padding-bottom: 2px; - border-left: 2px solid transparent; - color: #222; - text-decoration: none; - transition: border-left-color 0.1s; -} -.tsd-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul { - margin: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li { - padding: 0; -} - -.tsd-navigation.primary { - padding-bottom: 40px; -} -.tsd-navigation.primary a { - display: block; - padding-top: 6px; - padding-bottom: 6px; -} -.tsd-navigation.primary ul li a { - padding-left: 5px; -} -.tsd-navigation.primary ul li li a { - padding-left: 25px; -} -.tsd-navigation.primary ul li li li a { - padding-left: 45px; -} -.tsd-navigation.primary ul li li li li a { - padding-left: 65px; -} -.tsd-navigation.primary ul li li li li li a { - padding-left: 85px; -} -.tsd-navigation.primary ul li li li li li li a { - padding-left: 105px; -} -.tsd-navigation.primary > ul { - border-bottom: 1px solid #eee; -} -.tsd-navigation.primary li { - border-top: 1px solid #eee; -} -.tsd-navigation.primary li.current > a { - font-weight: bold; -} -.tsd-navigation.primary li.label span { - display: block; - padding: 20px 0 6px 5px; - color: #808080; -} -.tsd-navigation.primary li.globals + li > span, .tsd-navigation.primary li.globals + li > a { - padding-top: 20px; -} - -.tsd-navigation.secondary { - max-height: calc(100vh - 1rem - 40px); - overflow: auto; - position: -webkit-sticky; - position: sticky; - top: calc(.5rem + 40px); - transition: 0.3s; -} -.tsd-navigation.secondary.tsd-navigation--toolbar-hide { - max-height: calc(100vh - 1rem); - top: 0.5rem; -} -.tsd-navigation.secondary ul { - transition: opacity 0.2s; -} -.tsd-navigation.secondary ul li a { - padding-left: 25px; -} -.tsd-navigation.secondary ul li li a { - padding-left: 45px; -} -.tsd-navigation.secondary ul li li li a { - padding-left: 65px; -} -.tsd-navigation.secondary ul li li li li a { - padding-left: 85px; -} -.tsd-navigation.secondary ul li li li li li a { - padding-left: 105px; -} -.tsd-navigation.secondary ul li li li li li li a { - padding-left: 125px; -} -.tsd-navigation.secondary ul.current a { - border-left-color: #eee; -} -.tsd-navigation.secondary li.focus > a, -.tsd-navigation.secondary ul.current li.focus > a { - border-left-color: #000; -} -.tsd-navigation.secondary li.current { - margin-top: 20px; - margin-bottom: 20px; - border-left-color: #eee; -} -.tsd-navigation.secondary li.current > a { - font-weight: bold; -} - -@media (min-width: 901px) { - .menu-sticky-wrap { - position: static; - } -} - -.tsd-panel { - margin: 20px 0; - padding: 20px; - background-color: #fff; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 { - margin: 1.5em -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid #eee; -} -.tsd-panel > h1.tsd-before-signature, .tsd-panel > h2.tsd-before-signature, .tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: 0; -} -.tsd-panel table { - display: block; - width: 100%; - overflow: auto; - margin-top: 10px; - word-break: normal; - word-break: keep-all; -} -.tsd-panel table th { - font-weight: bold; -} -.tsd-panel table th, .tsd-panel table td { - padding: 6px 13px; - border: 1px solid #ddd; -} -.tsd-panel table tr { - background-color: #fff; - border-top: 1px solid #ccc; -} -.tsd-panel table tr:nth-child(2n) { - background-color: #f8f8f8; -} - -.tsd-panel-group { - margin: 60px 0; -} -.tsd-panel-group > h1, .tsd-panel-group > h2, .tsd-panel-group > h3 { - padding-left: 20px; - padding-right: 20px; -} - -#tsd-search { - transition: background-color 0.2s; -} -#tsd-search .title { - position: relative; - z-index: 2; -} -#tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 40px; - height: 40px; -} -#tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: #222; -} -#tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; -} -#tsd-search .field input, -#tsd-search .title { - transition: opacity 0.2s; -} -#tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -#tsd-search .results li { - padding: 0 10px; - background-color: #fdfdfd; -} -#tsd-search .results li:nth-child(even) { - background-color: #fff; -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current, -#tsd-search .results li:hover { - background-color: #eee; -} -#tsd-search .results a { - display: block; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: #808080; - font-weight: normal; -} -#tsd-search.has-focus { - background-color: #eee; -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title { - z-index: 0; - opacity: 0; -} -#tsd-search.has-focus .results { - visibility: visible; -} -#tsd-search.loading .results li.state.loading { - display: block; -} -#tsd-search.failure .results li.state.failure { - display: block; -} - -.tsd-signature { - margin: 0 0 1em 0; - padding: 10px; - border: 1px solid #eee; - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} -.tsd-signature.tsd-kind-icon { - padding-left: 30px; -} -.tsd-signature.tsd-kind-icon:before { - top: 10px; - left: 10px; -} -.tsd-panel > .tsd-signature { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signature.tsd-kind-icon:before { - left: 20px; -} - -.tsd-signature-symbol { - color: #808080; - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - border: 1px solid #eee; -} -.tsd-signatures .tsd-signature { - margin: 0; - border-width: 1px 0 0 0; - transition: background-color 0.1s; -} -.tsd-signatures .tsd-signature:first-child { - border-top-width: 0; -} -.tsd-signatures .tsd-signature.current { - background-color: #eee; -} -.tsd-signatures.active > .tsd-signature { - cursor: pointer; -} -.tsd-panel > .tsd-signatures { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { - left: 20px; -} -.tsd-panel > a.anchor + .tsd-signatures { - border-top-width: 0; - margin-top: -20px; -} - -ul.tsd-descriptions { - position: relative; - overflow: hidden; - padding: 0; - list-style: none; -} -ul.tsd-descriptions.active > .tsd-description { - display: none; -} -ul.tsd-descriptions.active > .tsd-description.current { - display: block; -} -ul.tsd-descriptions.active > .tsd-description.fade-in { - animation: fade-in-delayed 0.3s; -} -ul.tsd-descriptions.active > .tsd-description.fade-out { - animation: fade-out-delayed 0.3s; - position: absolute; - display: block; - top: 0; - left: 0; - right: 0; - opacity: 0; - visibility: hidden; -} -ul.tsd-descriptions h4, ul.tsd-descriptions .tsd-index-panel h3, .tsd-index-panel ul.tsd-descriptions h3 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} - -ul.tsd-parameters, -ul.tsd-type-parameters { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameters > li.tsd-parameter-signature, -ul.tsd-type-parameters > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameters h5, -ul.tsd-type-parameters h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -ul.tsd-parameters .tsd-comment, -ul.tsd-type-parameters .tsd-comment { - margin-top: -0.5em; -} - -.tsd-sources { - font-size: 14px; - color: #808080; - margin: 0 0 1em 0; -} -.tsd-sources a { - color: #808080; - text-decoration: underline; -} -.tsd-sources ul, .tsd-sources p { - margin: 0 !important; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: fixed; - z-index: 1; - top: 0; - left: 0; - width: 100%; - height: 40px; - color: #333; - background: #fff; - border-bottom: 1px solid #eee; - transition: transform 0.3s linear; -} -.tsd-page-toolbar a { - color: #333; - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .table-wrap { - display: table; - width: 100%; - height: 40px; -} -.tsd-page-toolbar .table-cell { - display: table-cell; - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} - -.tsd-page-toolbar--hide { - transform: translateY(-100%); -} - -.tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { - content: ""; - display: inline-block; - width: 40px; - height: 40px; - margin: 0 -8px 0 0; - background-image: url(../images/widgets.png); - background-repeat: no-repeat; - text-indent: -1024px; - vertical-align: bottom; -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { - background-image: url(../images/widgets@2x.png); - background-size: 320px 40px; - } -} - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.6; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-widget:hover { - opacity: 0.8; -} -.tsd-widget.active { - opacity: 1; - background-color: #eee; -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} -.tsd-widget.search:before { - background-position: 0 0; -} -.tsd-widget.menu:before { - background-position: -40px 0; -} -.tsd-widget.options:before { - background-position: -80px 0; -} -.tsd-widget.options, .tsd-widget.menu { - display: none; -} -@media (max-width: 900px) { - .tsd-widget.options, .tsd-widget.menu { - display: inline-block; - } -} -input[type=checkbox] + .tsd-widget:before { - background-position: -120px 0; -} -input[type=checkbox]:checked + .tsd-widget:before { - background-position: -160px 0; -} - -.tsd-select { - position: relative; - display: inline-block; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-select .tsd-select-label { - opacity: 0.6; - transition: opacity 0.2s; -} -.tsd-select .tsd-select-label:before { - background-position: -240px 0; -} -.tsd-select.active .tsd-select-label { - opacity: 0.8; -} -.tsd-select.active .tsd-select-list { - visibility: visible; - opacity: 1; - transition-delay: 0s; -} -.tsd-select .tsd-select-list { - position: absolute; - visibility: hidden; - top: 40px; - left: 0; - margin: 0; - padding: 0; - opacity: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - transition: visibility 0s 0.2s, opacity 0.2s; -} -.tsd-select .tsd-select-list li { - padding: 0 20px 0 0; - background-color: #fdfdfd; -} -.tsd-select .tsd-select-list li:before { - background-position: 40px 0; -} -.tsd-select .tsd-select-list li:nth-child(even) { - background-color: #fff; -} -.tsd-select .tsd-select-list li:hover { - background-color: #eee; -} -.tsd-select .tsd-select-list li.selected:before { - background-position: -200px 0; -} -@media (max-width: 900px) { - .tsd-select .tsd-select-list { - top: 0; - left: auto; - right: 100%; - margin-right: -5px; - } - .tsd-select .tsd-select-label:before { - background-position: -280px 0; - } -} - -img { - max-width: 100%; -} \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css new file mode 100644 index 0000000..3309010 --- /dev/null +++ b/docs/assets/highlight.css @@ -0,0 +1,99 @@ +:root { + --light-hl-0: #000000; + --dark-hl-0: #D4D4D4; + --light-hl-1: #0000FF; + --dark-hl-1: #569CD6; + --light-hl-2: #0070C1; + --dark-hl-2: #4FC1FF; + --light-hl-3: #795E26; + --dark-hl-3: #DCDCAA; + --light-hl-4: #A31515; + --dark-hl-4: #CE9178; + --light-hl-5: #AF00DB; + --dark-hl-5: #C586C0; + --light-hl-6: #001080; + --dark-hl-6: #9CDCFE; + --light-hl-7: #267F99; + --dark-hl-7: #4EC9B0; + --light-hl-8: #800000; + --dark-hl-8: #808080; + --light-hl-9: #800000; + --dark-hl-9: #569CD6; + --light-hl-10: #000000FF; + --dark-hl-10: #D4D4D4; + --light-code-background: #F5F5F5; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --code-background: var(--dark-code-background); +} } + +body.light { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --code-background: var(--light-code-background); +} + +body.dark { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } +pre, code { background: var(--code-background); } diff --git a/docs/assets/icons.css b/docs/assets/icons.css new file mode 100644 index 0000000..776a356 --- /dev/null +++ b/docs/assets/icons.css @@ -0,0 +1,1043 @@ +.tsd-kind-icon { + display: block; + position: relative; + padding-left: 20px; + text-indent: -20px; +} +.tsd-kind-icon:before { + content: ""; + display: inline-block; + vertical-align: middle; + width: 17px; + height: 17px; + margin: 0 3px 2px 0; + background-image: url(./icons.png); +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-kind-icon:before { + background-image: url(./icons@2x.png); + background-size: 238px 204px; + } +} + +.tsd-signature.tsd-kind-icon:before { + background-position: 0 -153px; +} + +.tsd-kind-object-literal > .tsd-kind-icon:before { + background-position: 0px -17px; +} +.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -17px; +} +.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -17px; +} + +.tsd-kind-class > .tsd-kind-icon:before { + background-position: 0px -34px; +} +.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -34px; +} +.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -34px; +} + +.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -17px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -51px; +} + +.tsd-kind-interface > .tsd-kind-icon:before { + background-position: 0px -68px; +} +.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -68px; +} +.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -68px; +} + +.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -17px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private + > .tsd-kind-icon:before { + background-position: -34px -85px; +} + +.tsd-kind-namespace > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-module > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-enum > .tsd-kind-icon:before { + background-position: 0px -119px; +} +.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -119px; +} +.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -119px; +} + +.tsd-kind-enum-member > .tsd-kind-icon:before { + background-position: 0px -136px; +} +.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -136px; +} +.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -136px; +} + +.tsd-kind-signature > .tsd-kind-icon:before { + background-position: 0px -153px; +} +.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -153px; +} +.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -153px; +} + +.tsd-kind-type-alias > .tsd-kind-icon:before { + background-position: 0px -170px; +} +.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -170px; +} +.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -170px; +} + +.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -17px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private + > .tsd-kind-icon:before { + background-position: -34px -187px; +} + +.tsd-kind-variable > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-property > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-get-signature > .tsd-kind-icon:before { + background-position: -136px -17px; +} +.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -17px; +} +.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -17px; +} + +.tsd-kind-set-signature > .tsd-kind-icon:before { + background-position: -136px -34px; +} +.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -34px; +} +.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -34px; +} + +.tsd-kind-accessor > .tsd-kind-icon:before { + background-position: -136px -51px; +} +.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -51px; +} +.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -51px; +} + +.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class + > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum + > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class + > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum + > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-constructor > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-constructor-signature > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-index-signature > .tsd-kind-icon:before { + background-position: -136px -119px; +} +.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -119px; +} +.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -119px; +} + +.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -136px; +} +.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -136px; +} +.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -136px; +} + +.tsd-is-static > .tsd-kind-icon:before { + background-position: -136px -153px; +} +.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -153px; +} +.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -153px; +} +.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -153px; +} + +.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class + > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum + > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -68px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -85px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -102px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected + > .tsd-kind-icon:before { + background-position: -187px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private + > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface + > .tsd-kind-icon:before { + background-position: -204px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited + > .tsd-kind-icon:before { + background-position: -221px -187px; +} diff --git a/docs/assets/images/icons.png b/docs/assets/icons.png similarity index 100% rename from docs/assets/images/icons.png rename to docs/assets/icons.png diff --git a/docs/assets/images/icons@2x.png b/docs/assets/icons@2x.png similarity index 100% rename from docs/assets/images/icons@2x.png rename to docs/assets/icons@2x.png diff --git a/docs/assets/js/main.js b/docs/assets/js/main.js deleted file mode 100644 index 39a8066..0000000 --- a/docs/assets/js/main.js +++ /dev/null @@ -1 +0,0 @@ -!function(){var e=function(t){var r=new e.Builder;return r.pipeline.add(e.trimmer,e.stopWordFilter,e.stemmer),r.searchPipeline.add(e.stemmer),t.call(r,r),r.build()};e.version="2.3.7",e.utils={},e.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),e.utils.asString=function(e){return null==e?"":e.toString()},e.utils.clone=function(e){if(null==e)return e;for(var t=Object.create(null),r=Object.keys(e),i=0;i=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){for(var t,r;47<(r=(t=this.next()).charCodeAt(0))&&r<58;);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos=this.scrollTop||0===this.scrollTop,isShown!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.secondaryNav.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop},Viewport}(typedoc.EventTarget);typedoc.Viewport=Viewport,typedoc.registerService(Viewport,"viewport")}(typedoc||(typedoc={})),function(typedoc){function Component(options){this.el=options.el}typedoc.Component=Component}(typedoc||(typedoc={})),function(typedoc){typedoc.pointerDown="mousedown",typedoc.pointerMove="mousemove",typedoc.pointerUp="mouseup",typedoc.pointerDownPosition={x:0,y:0},typedoc.preventNextClick=!1,typedoc.isPointerDown=!1,typedoc.isPointerTouch=!1,typedoc.hasPointerMoved=!1,typedoc.isMobile=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent),document.documentElement.classList.add(typedoc.isMobile?"is-mobile":"not-mobile"),typedoc.isMobile&&"ontouchstart"in document.documentElement&&(typedoc.isPointerTouch=!0,typedoc.pointerDown="touchstart",typedoc.pointerMove="touchmove",typedoc.pointerUp="touchend"),document.addEventListener(typedoc.pointerDown,function(e){typedoc.isPointerDown=!0,typedoc.hasPointerMoved=!1;var t="touchstart"==typedoc.pointerDown?e.targetTouches[0]:e;typedoc.pointerDownPosition.y=t.pageY||0,typedoc.pointerDownPosition.x=t.pageX||0}),document.addEventListener(typedoc.pointerMove,function(e){if(typedoc.isPointerDown&&!typedoc.hasPointerMoved){var t="touchstart"==typedoc.pointerDown?e.targetTouches[0]:e,x=typedoc.pointerDownPosition.x-(t.pageX||0),y=typedoc.pointerDownPosition.y-(t.pageY||0);typedoc.hasPointerMoved=10scrollTop;)index-=1;for(;index"+match+""}),parent=row.parent||"";(parent=parent.replace(new RegExp(this.query,"i"),function(match){return""+match+""}))&&(name=''+parent+"."+name);var item=document.createElement("li");item.classList.value=row.classes,item.innerHTML='\n '+name+"\n ",this.results.appendChild(item)}}},Search.prototype.setLoadingState=function(value){this.loadingState!=value&&(this.el.classList.remove(SearchLoadingState[this.loadingState].toLowerCase()),this.loadingState=value,this.el.classList.add(SearchLoadingState[this.loadingState].toLowerCase()),this.updateResults())},Search.prototype.setHasFocus=function(value){this.hasFocus!=value&&(this.hasFocus=value,this.el.classList.toggle("has-focus"),value?(this.setQuery(""),this.field.value=""):this.field.value=this.query)},Search.prototype.setQuery=function(value){this.query=value.trim(),this.updateResults()},Search.prototype.setCurrentResult=function(dir){var current=this.results.querySelector(".current");if(current){var rel=1==dir?current.nextElementSibling:current.previousElementSibling;rel&&(current.classList.remove("current"),rel.classList.add("current"))}else(current=this.results.querySelector(1==dir?"li:first-child":"li:last-child"))&¤t.classList.add("current")},Search.prototype.gotoCurrentResult=function(){var current=this.results.querySelector(".current");if(current||(current=this.results.querySelector("li:first-child")),current){var link=current.querySelector("a");link&&(window.location.href=link.href),this.field.blur()}},Search.prototype.bindEvents=function(){var _this=this;this.results.addEventListener("mousedown",function(){_this.resultClicked=!0}),this.results.addEventListener("mouseup",function(){_this.resultClicked=!1,_this.setHasFocus(!1)}),this.field.addEventListener("focusin",function(){_this.setHasFocus(!0),_this.loadIndex()}),this.field.addEventListener("focusout",function(){_this.resultClicked?_this.resultClicked=!1:setTimeout(function(){return _this.setHasFocus(!1)},100)}),this.field.addEventListener("input",function(){_this.setQuery(_this.field.value)}),this.field.addEventListener("keydown",function(e){13==e.keyCode||27==e.keyCode||38==e.keyCode||40==e.keyCode?(_this.preventPress=!0,e.preventDefault(),13==e.keyCode?_this.gotoCurrentResult():27==e.keyCode?_this.field.blur():38==e.keyCode?_this.setCurrentResult(-1):40==e.keyCode&&_this.setCurrentResult(1)):_this.preventPress=!1}),this.field.addEventListener("keypress",function(e){_this.preventPress&&e.preventDefault()}),document.body.addEventListener("keydown",function(e){e.altKey||e.ctrlKey||e.metaKey||!_this.hasFocus&&47this.groups.length-1&&(index=this.groups.length-1),this.index!=index){var to=this.groups[index];if(-1{var Ce=Object.create;var ue=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,_e=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!_e.call(t,i)&&i!==r&&ue(t,i,{get:()=>e[i],enumerable:!(n=Pe(e,i))||n.enumerable});return t};var Fe=(t,e,r)=>(r=t!=null?Ce(Re(t)):{},De(e||!t||!t.__esModule?ue(r,"default",{value:t,enumerable:!0}):r,t));var pe=Me((de,fe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var h=t.utils.clone(r)||{};h.position=[a,u],h.index=s.length,s.push(new t.Token(n.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?h+=2:a==l&&(r+=n[u+1]*i[h+1],u+=2,h+=2);return r},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var r=e.peekLexeme();if(r!=null)switch(r.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,r){typeof define=="function"&&define.amd?define(r):typeof de=="object"?fe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ce=[];function N(t,e){ce.push({selector:e,constructor:t})}var Y=class{constructor(){this.createComponents(document.body)}createComponents(e){ce.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n}),n.dataset.hasInstance=String(!0))})})}};var k=class{constructor(e){this.el=e.el}};var J=class{constructor(){this.listeners={}}addEventListener(e,r){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(r)}removeEventListener(e,r){if(!(e in this.listeners))return;let n=this.listeners[e];for(let i=0,s=n.length;i{let r=Date.now();return(...n)=>{r+e-Date.now()<0&&(t(...n),r=Date.now())}};var ie=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.secondaryNav=document.querySelector(".tsd-navigation.secondary"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.onResize(),this.onScroll()}triggerResize(){let r=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(r)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let r=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(r)}onScroll(){this.scrollTop=window.scrollY||0;let r=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(r),this.hideShowToolbar()}hideShowToolbar(){var n;let r=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0,r!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),(n=this.secondaryNav)==null||n.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop}},Q=ie;Q.instance=new ie;var X=class extends k{constructor(r){super(r);this.anchors=[];this.index=-1;Q.instance.addEventListener("resize",()=>this.onResize()),Q.instance.addEventListener("scroll",n=>this.onScroll(n)),this.createAnchors()}createAnchors(){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substr(0,r.indexOf("#"))),this.el.querySelectorAll("a").forEach(n=>{let i=n.href;if(i.indexOf("#")==-1||i.substr(0,r.length)!=r)return;let s=i.substr(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=n.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let r;for(let i=0,s=this.anchors.length;ii.position-s.position);let n=new CustomEvent("scroll",{detail:{scrollTop:Q.instance.scrollTop}});this.onScroll(n)}onScroll(r){let n=r.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>n;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var he=(t,e=100)=>{let r;return(...n)=>{clearTimeout(r),r=setTimeout(()=>t(n),e)}};var ge=Fe(pe());function ye(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Ae(t,n,r,s)}function Ae(t,e,r,n){r.addEventListener("input",he(()=>{He(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?ze(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?me(e,-1):s.key==="ArrowDown"?me(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function Ve(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ge.Index.load(window.searchData.index))}function He(t,e,r,n){var o,a;if(Ve(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let l=0;lu.score-l.score);for(let l=0,u=Math.min(10,s.length);l${ve(h.parent,i)}.${f}`);let p=document.createElement("li");p.classList.value=(a=h.classes)!=null?a:"";let E=document.createElement("a");E.href=n.base+h.url,E.classList.add("tsd-kind-icon"),E.innerHTML=f,p.append(E),e.appendChild(p)}}function me(t,e){var n,i;let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let s=r;if(e===1)do s=(n=s.nextElementSibling)!=null?n:void 0;while(s instanceof HTMLElement&&s.offsetParent==null);else do s=(i=s.previousElementSibling)!=null?i:void 0;while(s instanceof HTMLElement&&s.offsetParent==null);s&&(r.classList.remove("current"),s.classList.add("current"))}}function ze(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function ve(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(se(t.substring(s,o)),`${se(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(se(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function se(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var oe=class{constructor(e,r){this.signature=e,this.description=r}addClass(e){return this.signature.classList.add(e),this.description.classList.add(e),this}removeClass(e){return this.signature.classList.remove(e),this.description.classList.remove(e),this}},Z=class extends k{constructor(r){super(r);this.groups=[];this.index=-1;this.createGroups(),this.container&&(this.el.classList.add("active"),Array.from(this.el.children).forEach(n=>{n.addEventListener("touchstart",i=>this.onClick(i)),n.addEventListener("click",i=>this.onClick(i))}),this.container.classList.add("active"),this.setIndex(0))}setIndex(r){if(r<0&&(r=0),r>this.groups.length-1&&(r=this.groups.length-1),this.index==r)return;let n=this.groups[r];if(this.index>-1){let i=this.groups[this.index];i.removeClass("current").addClass("fade-out"),n.addClass("current"),n.addClass("fade-in"),Q.instance.triggerResize(),setTimeout(()=>{i.removeClass("fade-out"),n.removeClass("fade-in")},300)}else n.addClass("current"),Q.instance.triggerResize();this.index=r}createGroups(){let r=this.el.children;if(r.length<2)return;this.container=this.el.nextElementSibling;let n=this.container.children;this.groups=[];for(let i=0;i{n.signature===r.currentTarget&&this.setIndex(i)})}};var C="mousedown",Le="mousemove",_="mouseup",K={x:0,y:0},xe=!1,ae=!1,je=!1,A=!1,Ee=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Ee?"is-mobile":"not-mobile");Ee&&"ontouchstart"in document.documentElement&&(je=!0,C="touchstart",Le="touchmove",_="touchend");document.addEventListener(C,t=>{ae=!0,A=!1;let e=C=="touchstart"?t.targetTouches[0]:t;K.y=e.pageY||0,K.x=e.pageX||0});document.addEventListener(Le,t=>{if(!!ae&&!A){let e=C=="touchstart"?t.targetTouches[0]:t,r=K.x-(e.pageX||0),n=K.y-(e.pageY||0);A=Math.sqrt(r*r+n*n)>10}});document.addEventListener(_,()=>{ae=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var ee=class extends k{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(_,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(C,n=>this.onDocumentPointerDown(n)),document.addEventListener(_,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){A||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!A&&this.active&&r.target.closest(".col-menu")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substr(0,i.indexOf("#"))),n.href.substr(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te=class{constructor(e,r){this.key=e,this.value=r,this.defaultValue=r,this.initialize(),window.localStorage[this.key]&&this.setValue(this.fromLocalStorage(window.localStorage[this.key]))}initialize(){}setValue(e){if(this.value==e)return;let r=this.value;this.value=e,window.localStorage[this.key]=this.toLocalStorage(e),this.handleValueChange(r,e)}},re=class extends te{initialize(){let r=document.querySelector("#tsd-filter-"+this.key);!r||(this.checkbox=r,this.checkbox.addEventListener("change",()=>{this.setValue(this.checkbox.checked)}))}handleValueChange(r,n){!this.checkbox||(this.checkbox.checked=this.value,document.documentElement.classList.toggle("toggle-"+this.key,this.value!=this.defaultValue))}fromLocalStorage(r){return r=="true"}toLocalStorage(r){return r?"true":"false"}},le=class extends te{initialize(){document.documentElement.classList.add("toggle-"+this.key+this.value);let r=document.querySelector("#tsd-filter-"+this.key);if(!r)return;this.select=r;let n=()=>{this.select.classList.add("active")},i=()=>{this.select.classList.remove("active")};this.select.addEventListener(C,n),this.select.addEventListener("mouseover",n),this.select.addEventListener("mouseleave",i),this.select.querySelectorAll("li").forEach(s=>{s.addEventListener(_,o=>{r.classList.remove("active"),this.setValue(o.target.dataset.value||"")})}),document.addEventListener(C,s=>{this.select.contains(s.target)||this.select.classList.remove("active")})}handleValueChange(r,n){this.select.querySelectorAll("li.selected").forEach(o=>{o.classList.remove("selected")});let i=this.select.querySelector('li[data-value="'+n+'"]'),s=this.select.querySelector(".tsd-select-label");i&&s&&(i.classList.add("selected"),s.textContent=i.textContent),document.documentElement.classList.remove("toggle-"+r),document.documentElement.classList.add("toggle-"+n)}fromLocalStorage(r){return r}toLocalStorage(r){return r}},j=class extends k{constructor(r){super(r);this.optionVisibility=new le("visibility","private"),this.optionInherited=new re("inherited",!0),this.optionExternals=new re("externals",!0)}static isSupported(){try{return typeof window.localStorage!="undefined"}catch{return!1}}};function we(t){let e=localStorage.getItem("tsd-theme")||"os";t.value=e,be(e),t.addEventListener("change",()=>{localStorage.setItem("tsd-theme",t.value),be(t.value)})}function be(t){switch(t){case"os":document.body.classList.remove("light","dark");break;case"light":document.body.classList.remove("dark"),document.body.classList.add("light");break;case"dark":document.body.classList.remove("light"),document.body.classList.add("dark");break}}ye();N(X,".menu-highlight");N(Z,".tsd-signatures");N(ee,"a[data-toggle]");j.isSupported()?N(j,"#tsd-filter"):document.documentElement.classList.add("no-filter");var Te=document.getElementById("theme");Te&&we(Te);var Be=new Y;Object.defineProperty(window,"app",{value:Be});})(); +/*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + */ +/*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + */ +/** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + */ diff --git a/docs/assets/search.js b/docs/assets/search.js new file mode 100644 index 0000000..3635b9c --- /dev/null +++ b/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = JSON.parse("{\"kinds\":{\"2\":\"Module\",\"32\":\"Variable\",\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\",\"16777216\":\"Reference\"},\"rows\":[{\"id\":0,\"kind\":2,\"name\":\"api\",\"url\":\"modules/api.html\",\"classes\":\"tsd-kind-module\"},{\"id\":1,\"kind\":256,\"name\":\"ADVBatchControl\",\"url\":\"interfaces/api.ADVBatchControl.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":2,\"kind\":1024,\"name\":\"ID\",\"url\":\"interfaces/api.ADVBatchControl.html#ID\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVBatchControl\"},{\"id\":3,\"kind\":1024,\"name\":\"serviceClassCode\",\"url\":\"interfaces/api.ADVBatchControl.html#serviceClassCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVBatchControl\"},{\"id\":4,\"kind\":1024,\"name\":\"entryAddendaCount\",\"url\":\"interfaces/api.ADVBatchControl.html#entryAddendaCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVBatchControl\"},{\"id\":5,\"kind\":1024,\"name\":\"entryHash\",\"url\":\"interfaces/api.ADVBatchControl.html#entryHash\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVBatchControl\"},{\"id\":6,\"kind\":1024,\"name\":\"totalDebit\",\"url\":\"interfaces/api.ADVBatchControl.html#totalDebit\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVBatchControl\"},{\"id\":7,\"kind\":1024,\"name\":\"totalCredit\",\"url\":\"interfaces/api.ADVBatchControl.html#totalCredit\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVBatchControl\"},{\"id\":8,\"kind\":1024,\"name\":\"achOperatorData\",\"url\":\"interfaces/api.ADVBatchControl.html#achOperatorData\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVBatchControl\"},{\"id\":9,\"kind\":1024,\"name\":\"ODFIIdentification\",\"url\":\"interfaces/api.ADVBatchControl.html#ODFIIdentification\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVBatchControl\"},{\"id\":10,\"kind\":1024,\"name\":\"batchNumber\",\"url\":\"interfaces/api.ADVBatchControl.html#batchNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVBatchControl\"},{\"id\":11,\"kind\":256,\"name\":\"ADVEntryDetail\",\"url\":\"interfaces/api.ADVEntryDetail.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":12,\"kind\":1024,\"name\":\"ID\",\"url\":\"interfaces/api.ADVEntryDetail.html#ID\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVEntryDetail\"},{\"id\":13,\"kind\":1024,\"name\":\"transactionCode\",\"url\":\"interfaces/api.ADVEntryDetail.html#transactionCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVEntryDetail\"},{\"id\":14,\"kind\":1024,\"name\":\"RDFIIdentification\",\"url\":\"interfaces/api.ADVEntryDetail.html#RDFIIdentification\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVEntryDetail\"},{\"id\":15,\"kind\":1024,\"name\":\"checkDigit\",\"url\":\"interfaces/api.ADVEntryDetail.html#checkDigit\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVEntryDetail\"},{\"id\":16,\"kind\":1024,\"name\":\"DFIAccountNumber\",\"url\":\"interfaces/api.ADVEntryDetail.html#DFIAccountNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVEntryDetail\"},{\"id\":17,\"kind\":1024,\"name\":\"amount\",\"url\":\"interfaces/api.ADVEntryDetail.html#amount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVEntryDetail\"},{\"id\":18,\"kind\":1024,\"name\":\"adviceRoutingNumber\",\"url\":\"interfaces/api.ADVEntryDetail.html#adviceRoutingNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVEntryDetail\"},{\"id\":19,\"kind\":1024,\"name\":\"fileIdentification\",\"url\":\"interfaces/api.ADVEntryDetail.html#fileIdentification\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVEntryDetail\"},{\"id\":20,\"kind\":1024,\"name\":\"achOperatorData\",\"url\":\"interfaces/api.ADVEntryDetail.html#achOperatorData\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVEntryDetail\"},{\"id\":21,\"kind\":1024,\"name\":\"individualName\",\"url\":\"interfaces/api.ADVEntryDetail.html#individualName\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVEntryDetail\"},{\"id\":22,\"kind\":1024,\"name\":\"discretionaryData\",\"url\":\"interfaces/api.ADVEntryDetail.html#discretionaryData\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVEntryDetail\"},{\"id\":23,\"kind\":1024,\"name\":\"addendaRecordIndicator\",\"url\":\"interfaces/api.ADVEntryDetail.html#addendaRecordIndicator\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVEntryDetail\"},{\"id\":24,\"kind\":1024,\"name\":\"achOperatorRoutingNumber\",\"url\":\"interfaces/api.ADVEntryDetail.html#achOperatorRoutingNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVEntryDetail\"},{\"id\":25,\"kind\":1024,\"name\":\"julianDay\",\"url\":\"interfaces/api.ADVEntryDetail.html#julianDay\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVEntryDetail\"},{\"id\":26,\"kind\":1024,\"name\":\"sequenceNumber\",\"url\":\"interfaces/api.ADVEntryDetail.html#sequenceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVEntryDetail\"},{\"id\":27,\"kind\":1024,\"name\":\"addenda99\",\"url\":\"interfaces/api.ADVEntryDetail.html#addenda99\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVEntryDetail\"},{\"id\":28,\"kind\":1024,\"name\":\"category\",\"url\":\"interfaces/api.ADVEntryDetail.html#category\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVEntryDetail\"},{\"id\":29,\"kind\":256,\"name\":\"ADVFileControl\",\"url\":\"interfaces/api.ADVFileControl.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":30,\"kind\":1024,\"name\":\"ID\",\"url\":\"interfaces/api.ADVFileControl.html#ID\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVFileControl\"},{\"id\":31,\"kind\":1024,\"name\":\"batchCount\",\"url\":\"interfaces/api.ADVFileControl.html#batchCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVFileControl\"},{\"id\":32,\"kind\":1024,\"name\":\"blockCount\",\"url\":\"interfaces/api.ADVFileControl.html#blockCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVFileControl\"},{\"id\":33,\"kind\":1024,\"name\":\"entryAddendaCount\",\"url\":\"interfaces/api.ADVFileControl.html#entryAddendaCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVFileControl\"},{\"id\":34,\"kind\":1024,\"name\":\"entryHash\",\"url\":\"interfaces/api.ADVFileControl.html#entryHash\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVFileControl\"},{\"id\":35,\"kind\":1024,\"name\":\"totalDebit\",\"url\":\"interfaces/api.ADVFileControl.html#totalDebit\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVFileControl\"},{\"id\":36,\"kind\":1024,\"name\":\"totalCredit\",\"url\":\"interfaces/api.ADVFileControl.html#totalCredit\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ADVFileControl\"},{\"id\":37,\"kind\":256,\"name\":\"Addenda02\",\"url\":\"interfaces/api.Addenda02.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":38,\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/api.Addenda02.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda02\"},{\"id\":39,\"kind\":1024,\"name\":\"typeCode\",\"url\":\"interfaces/api.Addenda02.html#typeCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda02\"},{\"id\":40,\"kind\":1024,\"name\":\"referenceInformationOne\",\"url\":\"interfaces/api.Addenda02.html#referenceInformationOne\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda02\"},{\"id\":41,\"kind\":1024,\"name\":\"referenceInformationTwo\",\"url\":\"interfaces/api.Addenda02.html#referenceInformationTwo\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda02\"},{\"id\":42,\"kind\":1024,\"name\":\"terminalIdentificationCode\",\"url\":\"interfaces/api.Addenda02.html#terminalIdentificationCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda02\"},{\"id\":43,\"kind\":1024,\"name\":\"transactionSerialNumber\",\"url\":\"interfaces/api.Addenda02.html#transactionSerialNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda02\"},{\"id\":44,\"kind\":1024,\"name\":\"transactionDate\",\"url\":\"interfaces/api.Addenda02.html#transactionDate\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda02\"},{\"id\":45,\"kind\":1024,\"name\":\"authorizationCodeOrExpireDate\",\"url\":\"interfaces/api.Addenda02.html#authorizationCodeOrExpireDate\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda02\"},{\"id\":46,\"kind\":1024,\"name\":\"terminalLocation\",\"url\":\"interfaces/api.Addenda02.html#terminalLocation\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda02\"},{\"id\":47,\"kind\":1024,\"name\":\"terminalCity\",\"url\":\"interfaces/api.Addenda02.html#terminalCity\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda02\"},{\"id\":48,\"kind\":1024,\"name\":\"terminalState\",\"url\":\"interfaces/api.Addenda02.html#terminalState\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda02\"},{\"id\":49,\"kind\":1024,\"name\":\"traceNumber\",\"url\":\"interfaces/api.Addenda02.html#traceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda02\"},{\"id\":50,\"kind\":256,\"name\":\"Addenda05\",\"url\":\"interfaces/api.Addenda05.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":51,\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/api.Addenda05.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda05\"},{\"id\":52,\"kind\":1024,\"name\":\"typeCode\",\"url\":\"interfaces/api.Addenda05.html#typeCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda05\"},{\"id\":53,\"kind\":1024,\"name\":\"paymentRelatedInformation\",\"url\":\"interfaces/api.Addenda05.html#paymentRelatedInformation\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda05\"},{\"id\":54,\"kind\":1024,\"name\":\"sequenceNumber\",\"url\":\"interfaces/api.Addenda05.html#sequenceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda05\"},{\"id\":55,\"kind\":1024,\"name\":\"entryDetailSequenceNumber\",\"url\":\"interfaces/api.Addenda05.html#entryDetailSequenceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda05\"},{\"id\":56,\"kind\":256,\"name\":\"Addenda10\",\"url\":\"interfaces/api.Addenda10.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":57,\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/api.Addenda10.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda10\"},{\"id\":58,\"kind\":1024,\"name\":\"typeCode\",\"url\":\"interfaces/api.Addenda10.html#typeCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda10\"},{\"id\":59,\"kind\":1024,\"name\":\"transactionTypeCode\",\"url\":\"interfaces/api.Addenda10.html#transactionTypeCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda10\"},{\"id\":60,\"kind\":1024,\"name\":\"foreignPaymentAmount\",\"url\":\"interfaces/api.Addenda10.html#foreignPaymentAmount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda10\"},{\"id\":61,\"kind\":1024,\"name\":\"foreignTraceNumber\",\"url\":\"interfaces/api.Addenda10.html#foreignTraceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda10\"},{\"id\":62,\"kind\":1024,\"name\":\"name\",\"url\":\"interfaces/api.Addenda10.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda10\"},{\"id\":63,\"kind\":1024,\"name\":\"entryDetailSequenceNumber\",\"url\":\"interfaces/api.Addenda10.html#entryDetailSequenceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda10\"},{\"id\":64,\"kind\":256,\"name\":\"Addenda11\",\"url\":\"interfaces/api.Addenda11.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":65,\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/api.Addenda11.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda11\"},{\"id\":66,\"kind\":1024,\"name\":\"typeCode\",\"url\":\"interfaces/api.Addenda11.html#typeCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda11\"},{\"id\":67,\"kind\":1024,\"name\":\"originatorName\",\"url\":\"interfaces/api.Addenda11.html#originatorName\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda11\"},{\"id\":68,\"kind\":1024,\"name\":\"originatorStreetAddress\",\"url\":\"interfaces/api.Addenda11.html#originatorStreetAddress\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda11\"},{\"id\":69,\"kind\":1024,\"name\":\"entryDetailSequenceNumber\",\"url\":\"interfaces/api.Addenda11.html#entryDetailSequenceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda11\"},{\"id\":70,\"kind\":256,\"name\":\"Addenda12\",\"url\":\"interfaces/api.Addenda12.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":71,\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/api.Addenda12.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda12\"},{\"id\":72,\"kind\":1024,\"name\":\"typeCode\",\"url\":\"interfaces/api.Addenda12.html#typeCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda12\"},{\"id\":73,\"kind\":1024,\"name\":\"originatorCityStateProvince\",\"url\":\"interfaces/api.Addenda12.html#originatorCityStateProvince\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda12\"},{\"id\":74,\"kind\":1024,\"name\":\"originatorCountryPostalCode\",\"url\":\"interfaces/api.Addenda12.html#originatorCountryPostalCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda12\"},{\"id\":75,\"kind\":1024,\"name\":\"entryDetailSequenceNumber\",\"url\":\"interfaces/api.Addenda12.html#entryDetailSequenceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda12\"},{\"id\":76,\"kind\":256,\"name\":\"Addenda13\",\"url\":\"interfaces/api.Addenda13.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":77,\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/api.Addenda13.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda13\"},{\"id\":78,\"kind\":1024,\"name\":\"typeCode\",\"url\":\"interfaces/api.Addenda13.html#typeCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda13\"},{\"id\":79,\"kind\":1024,\"name\":\"ODFIName\",\"url\":\"interfaces/api.Addenda13.html#ODFIName\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda13\"},{\"id\":80,\"kind\":1024,\"name\":\"ODFIIDNumberQualifier\",\"url\":\"interfaces/api.Addenda13.html#ODFIIDNumberQualifier\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda13\"},{\"id\":81,\"kind\":1024,\"name\":\"ODFIBranchCountryCode\",\"url\":\"interfaces/api.Addenda13.html#ODFIBranchCountryCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda13\"},{\"id\":82,\"kind\":1024,\"name\":\"entryDetailSequenceNumber\",\"url\":\"interfaces/api.Addenda13.html#entryDetailSequenceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda13\"},{\"id\":83,\"kind\":256,\"name\":\"Addenda14\",\"url\":\"interfaces/api.Addenda14.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":84,\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/api.Addenda14.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda14\"},{\"id\":85,\"kind\":1024,\"name\":\"typeCode\",\"url\":\"interfaces/api.Addenda14.html#typeCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda14\"},{\"id\":86,\"kind\":1024,\"name\":\"RDFIName\",\"url\":\"interfaces/api.Addenda14.html#RDFIName\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda14\"},{\"id\":87,\"kind\":1024,\"name\":\"RDFIIDNumberQualifier\",\"url\":\"interfaces/api.Addenda14.html#RDFIIDNumberQualifier\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda14\"},{\"id\":88,\"kind\":1024,\"name\":\"RDFIIdentification\",\"url\":\"interfaces/api.Addenda14.html#RDFIIdentification\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda14\"},{\"id\":89,\"kind\":1024,\"name\":\"RDFIBranchCountryCode\",\"url\":\"interfaces/api.Addenda14.html#RDFIBranchCountryCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda14\"},{\"id\":90,\"kind\":1024,\"name\":\"entryDetailSequenceNumber\",\"url\":\"interfaces/api.Addenda14.html#entryDetailSequenceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda14\"},{\"id\":91,\"kind\":256,\"name\":\"Addenda15\",\"url\":\"interfaces/api.Addenda15.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":92,\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/api.Addenda15.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda15\"},{\"id\":93,\"kind\":1024,\"name\":\"typeCode\",\"url\":\"interfaces/api.Addenda15.html#typeCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda15\"},{\"id\":94,\"kind\":1024,\"name\":\"receiverIDNumber\",\"url\":\"interfaces/api.Addenda15.html#receiverIDNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda15\"},{\"id\":95,\"kind\":1024,\"name\":\"receiverStreetAddress\",\"url\":\"interfaces/api.Addenda15.html#receiverStreetAddress\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda15\"},{\"id\":96,\"kind\":1024,\"name\":\"entryDetailSequenceNumber\",\"url\":\"interfaces/api.Addenda15.html#entryDetailSequenceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda15\"},{\"id\":97,\"kind\":256,\"name\":\"Addenda16\",\"url\":\"interfaces/api.Addenda16.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":98,\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/api.Addenda16.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda16\"},{\"id\":99,\"kind\":1024,\"name\":\"typeCode\",\"url\":\"interfaces/api.Addenda16.html#typeCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda16\"},{\"id\":100,\"kind\":1024,\"name\":\"receiverCityStateProvince\",\"url\":\"interfaces/api.Addenda16.html#receiverCityStateProvince\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda16\"},{\"id\":101,\"kind\":1024,\"name\":\"receiverCountryPostalCode\",\"url\":\"interfaces/api.Addenda16.html#receiverCountryPostalCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda16\"},{\"id\":102,\"kind\":1024,\"name\":\"entryDetailSequenceNumber\",\"url\":\"interfaces/api.Addenda16.html#entryDetailSequenceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda16\"},{\"id\":103,\"kind\":256,\"name\":\"Addenda17\",\"url\":\"interfaces/api.Addenda17.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":104,\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/api.Addenda17.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda17\"},{\"id\":105,\"kind\":1024,\"name\":\"typeCode\",\"url\":\"interfaces/api.Addenda17.html#typeCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda17\"},{\"id\":106,\"kind\":1024,\"name\":\"paymentRelatedInformation\",\"url\":\"interfaces/api.Addenda17.html#paymentRelatedInformation\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda17\"},{\"id\":107,\"kind\":1024,\"name\":\"sequenceNumber\",\"url\":\"interfaces/api.Addenda17.html#sequenceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda17\"},{\"id\":108,\"kind\":1024,\"name\":\"entryDetailSequenceNumber\",\"url\":\"interfaces/api.Addenda17.html#entryDetailSequenceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda17\"},{\"id\":109,\"kind\":256,\"name\":\"Addenda18\",\"url\":\"interfaces/api.Addenda18.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":110,\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/api.Addenda18.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda18\"},{\"id\":111,\"kind\":1024,\"name\":\"typeCode\",\"url\":\"interfaces/api.Addenda18.html#typeCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda18\"},{\"id\":112,\"kind\":1024,\"name\":\"foreignCorrespondentBankName\",\"url\":\"interfaces/api.Addenda18.html#foreignCorrespondentBankName\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda18\"},{\"id\":113,\"kind\":1024,\"name\":\"foreignCorrespondentBankIDNumberQualifier\",\"url\":\"interfaces/api.Addenda18.html#foreignCorrespondentBankIDNumberQualifier\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda18\"},{\"id\":114,\"kind\":1024,\"name\":\"foreignCorrespondentBankIDNumber\",\"url\":\"interfaces/api.Addenda18.html#foreignCorrespondentBankIDNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda18\"},{\"id\":115,\"kind\":1024,\"name\":\"foreignCorrespondentBankBranchCountryCode\",\"url\":\"interfaces/api.Addenda18.html#foreignCorrespondentBankBranchCountryCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda18\"},{\"id\":116,\"kind\":1024,\"name\":\"sequenceNumber\",\"url\":\"interfaces/api.Addenda18.html#sequenceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda18\"},{\"id\":117,\"kind\":1024,\"name\":\"entryDetailSequenceNumber\",\"url\":\"interfaces/api.Addenda18.html#entryDetailSequenceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda18\"},{\"id\":118,\"kind\":256,\"name\":\"Addenda98\",\"url\":\"interfaces/api.Addenda98.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":119,\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/api.Addenda98.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda98\"},{\"id\":120,\"kind\":1024,\"name\":\"typeCode\",\"url\":\"interfaces/api.Addenda98.html#typeCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda98\"},{\"id\":121,\"kind\":1024,\"name\":\"changeCode\",\"url\":\"interfaces/api.Addenda98.html#changeCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda98\"},{\"id\":122,\"kind\":1024,\"name\":\"originalTrace\",\"url\":\"interfaces/api.Addenda98.html#originalTrace\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda98\"},{\"id\":123,\"kind\":1024,\"name\":\"originalDFI\",\"url\":\"interfaces/api.Addenda98.html#originalDFI\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda98\"},{\"id\":124,\"kind\":1024,\"name\":\"correctedData\",\"url\":\"interfaces/api.Addenda98.html#correctedData\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda98\"},{\"id\":125,\"kind\":1024,\"name\":\"traceNumber\",\"url\":\"interfaces/api.Addenda98.html#traceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda98\"},{\"id\":126,\"kind\":256,\"name\":\"Addenda99\",\"url\":\"interfaces/api.Addenda99.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":127,\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/api.Addenda99.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99\"},{\"id\":128,\"kind\":1024,\"name\":\"typeCode\",\"url\":\"interfaces/api.Addenda99.html#typeCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99\"},{\"id\":129,\"kind\":1024,\"name\":\"returnCode\",\"url\":\"interfaces/api.Addenda99.html#returnCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99\"},{\"id\":130,\"kind\":1024,\"name\":\"originalTrace\",\"url\":\"interfaces/api.Addenda99.html#originalTrace\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99\"},{\"id\":131,\"kind\":1024,\"name\":\"dateOfDeath\",\"url\":\"interfaces/api.Addenda99.html#dateOfDeath\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99\"},{\"id\":132,\"kind\":1024,\"name\":\"originalDFI\",\"url\":\"interfaces/api.Addenda99.html#originalDFI\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99\"},{\"id\":133,\"kind\":1024,\"name\":\"addendaInformation\",\"url\":\"interfaces/api.Addenda99.html#addendaInformation\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99\"},{\"id\":134,\"kind\":1024,\"name\":\"traceNumber\",\"url\":\"interfaces/api.Addenda99.html#traceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99\"},{\"id\":135,\"kind\":256,\"name\":\"Addenda99Contested\",\"url\":\"interfaces/api.Addenda99Contested.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":136,\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/api.Addenda99Contested.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Contested\"},{\"id\":137,\"kind\":1024,\"name\":\"typeCode\",\"url\":\"interfaces/api.Addenda99Contested.html#typeCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Contested\"},{\"id\":138,\"kind\":1024,\"name\":\"dishonoredReturnReasonCode\",\"url\":\"interfaces/api.Addenda99Contested.html#dishonoredReturnReasonCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Contested\"},{\"id\":139,\"kind\":1024,\"name\":\"originalEntryTraceNumber\",\"url\":\"interfaces/api.Addenda99Contested.html#originalEntryTraceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Contested\"},{\"id\":140,\"kind\":1024,\"name\":\"originalReceivingDFIIdentification\",\"url\":\"interfaces/api.Addenda99Contested.html#originalReceivingDFIIdentification\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Contested\"},{\"id\":141,\"kind\":1024,\"name\":\"returnTraceNumber\",\"url\":\"interfaces/api.Addenda99Contested.html#returnTraceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Contested\"},{\"id\":142,\"kind\":1024,\"name\":\"returnSettlementDate\",\"url\":\"interfaces/api.Addenda99Contested.html#returnSettlementDate\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Contested\"},{\"id\":143,\"kind\":1024,\"name\":\"returnReasonCode\",\"url\":\"interfaces/api.Addenda99Contested.html#returnReasonCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Contested\"},{\"id\":144,\"kind\":1024,\"name\":\"addendaInformation\",\"url\":\"interfaces/api.Addenda99Contested.html#addendaInformation\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Contested\"},{\"id\":145,\"kind\":1024,\"name\":\"traceNumber\",\"url\":\"interfaces/api.Addenda99Contested.html#traceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Contested\"},{\"id\":146,\"kind\":256,\"name\":\"Addenda99Dishonored\",\"url\":\"interfaces/api.Addenda99Dishonored.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":147,\"kind\":1024,\"name\":\"id\",\"url\":\"interfaces/api.Addenda99Dishonored.html#id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Dishonored\"},{\"id\":148,\"kind\":1024,\"name\":\"typeCode\",\"url\":\"interfaces/api.Addenda99Dishonored.html#typeCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Dishonored\"},{\"id\":149,\"kind\":1024,\"name\":\"contestedReturnCode\",\"url\":\"interfaces/api.Addenda99Dishonored.html#contestedReturnCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Dishonored\"},{\"id\":150,\"kind\":1024,\"name\":\"originalEntryTraceNumber\",\"url\":\"interfaces/api.Addenda99Dishonored.html#originalEntryTraceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Dishonored\"},{\"id\":151,\"kind\":1024,\"name\":\"dateOriginalEntryReturned\",\"url\":\"interfaces/api.Addenda99Dishonored.html#dateOriginalEntryReturned\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Dishonored\"},{\"id\":152,\"kind\":1024,\"name\":\"originalReceivingDFIIdentification\",\"url\":\"interfaces/api.Addenda99Dishonored.html#originalReceivingDFIIdentification\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Dishonored\"},{\"id\":153,\"kind\":1024,\"name\":\"originalSettlementDate\",\"url\":\"interfaces/api.Addenda99Dishonored.html#originalSettlementDate\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Dishonored\"},{\"id\":154,\"kind\":1024,\"name\":\"returnTraceNumber\",\"url\":\"interfaces/api.Addenda99Dishonored.html#returnTraceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Dishonored\"},{\"id\":155,\"kind\":1024,\"name\":\"returnSettlementDate\",\"url\":\"interfaces/api.Addenda99Dishonored.html#returnSettlementDate\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Dishonored\"},{\"id\":156,\"kind\":1024,\"name\":\"returnReasonCode\",\"url\":\"interfaces/api.Addenda99Dishonored.html#returnReasonCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Dishonored\"},{\"id\":157,\"kind\":1024,\"name\":\"dishonoredReturnTraceNumber\",\"url\":\"interfaces/api.Addenda99Dishonored.html#dishonoredReturnTraceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Dishonored\"},{\"id\":158,\"kind\":1024,\"name\":\"dishonoredReturnSettlementDate\",\"url\":\"interfaces/api.Addenda99Dishonored.html#dishonoredReturnSettlementDate\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Dishonored\"},{\"id\":159,\"kind\":1024,\"name\":\"dishonoredReturnReasonCode\",\"url\":\"interfaces/api.Addenda99Dishonored.html#dishonoredReturnReasonCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Dishonored\"},{\"id\":160,\"kind\":1024,\"name\":\"traceNumber\",\"url\":\"interfaces/api.Addenda99Dishonored.html#traceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Addenda99Dishonored\"},{\"id\":161,\"kind\":256,\"name\":\"Batch\",\"url\":\"interfaces/api.Batch.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":162,\"kind\":1024,\"name\":\"batchHeader\",\"url\":\"interfaces/api.Batch.html#batchHeader\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Batch\"},{\"id\":163,\"kind\":1024,\"name\":\"entryDetails\",\"url\":\"interfaces/api.Batch.html#entryDetails\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Batch\"},{\"id\":164,\"kind\":1024,\"name\":\"batchControl\",\"url\":\"interfaces/api.Batch.html#batchControl\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Batch\"},{\"id\":165,\"kind\":1024,\"name\":\"offset\",\"url\":\"interfaces/api.Batch.html#offset\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Batch\"},{\"id\":166,\"kind\":256,\"name\":\"BatchControl\",\"url\":\"interfaces/api.BatchControl.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":167,\"kind\":1024,\"name\":\"ID\",\"url\":\"interfaces/api.BatchControl.html#ID\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchControl\"},{\"id\":168,\"kind\":1024,\"name\":\"serviceClassCode\",\"url\":\"interfaces/api.BatchControl.html#serviceClassCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchControl\"},{\"id\":169,\"kind\":1024,\"name\":\"entryAddendaCount\",\"url\":\"interfaces/api.BatchControl.html#entryAddendaCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchControl\"},{\"id\":170,\"kind\":1024,\"name\":\"entryHash\",\"url\":\"interfaces/api.BatchControl.html#entryHash\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchControl\"},{\"id\":171,\"kind\":1024,\"name\":\"totalDebit\",\"url\":\"interfaces/api.BatchControl.html#totalDebit\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchControl\"},{\"id\":172,\"kind\":1024,\"name\":\"totalCredit\",\"url\":\"interfaces/api.BatchControl.html#totalCredit\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchControl\"},{\"id\":173,\"kind\":1024,\"name\":\"companyIdentification\",\"url\":\"interfaces/api.BatchControl.html#companyIdentification\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchControl\"},{\"id\":174,\"kind\":1024,\"name\":\"messageAuthentication\",\"url\":\"interfaces/api.BatchControl.html#messageAuthentication\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchControl\"},{\"id\":175,\"kind\":1024,\"name\":\"ODFIIdentification\",\"url\":\"interfaces/api.BatchControl.html#ODFIIdentification\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchControl\"},{\"id\":176,\"kind\":1024,\"name\":\"batchNumber\",\"url\":\"interfaces/api.BatchControl.html#batchNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchControl\"},{\"id\":177,\"kind\":256,\"name\":\"BatchHeader\",\"url\":\"interfaces/api.BatchHeader.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":178,\"kind\":1024,\"name\":\"ID\",\"url\":\"interfaces/api.BatchHeader.html#ID\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchHeader\"},{\"id\":179,\"kind\":1024,\"name\":\"serviceClassCode\",\"url\":\"interfaces/api.BatchHeader.html#serviceClassCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchHeader\"},{\"id\":180,\"kind\":1024,\"name\":\"companyName\",\"url\":\"interfaces/api.BatchHeader.html#companyName\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchHeader\"},{\"id\":181,\"kind\":1024,\"name\":\"companyDiscretionaryData\",\"url\":\"interfaces/api.BatchHeader.html#companyDiscretionaryData\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchHeader\"},{\"id\":182,\"kind\":1024,\"name\":\"companyIdentification\",\"url\":\"interfaces/api.BatchHeader.html#companyIdentification\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchHeader\"},{\"id\":183,\"kind\":1024,\"name\":\"standardEntryClassCode\",\"url\":\"interfaces/api.BatchHeader.html#standardEntryClassCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchHeader\"},{\"id\":184,\"kind\":1024,\"name\":\"companyEntryDescription\",\"url\":\"interfaces/api.BatchHeader.html#companyEntryDescription\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchHeader\"},{\"id\":185,\"kind\":1024,\"name\":\"companyDescriptiveDate\",\"url\":\"interfaces/api.BatchHeader.html#companyDescriptiveDate\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchHeader\"},{\"id\":186,\"kind\":1024,\"name\":\"effectiveEntryDate\",\"url\":\"interfaces/api.BatchHeader.html#effectiveEntryDate\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchHeader\"},{\"id\":187,\"kind\":1024,\"name\":\"originatorStatusCode\",\"url\":\"interfaces/api.BatchHeader.html#originatorStatusCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchHeader\"},{\"id\":188,\"kind\":1024,\"name\":\"ODFIIdentification\",\"url\":\"interfaces/api.BatchHeader.html#ODFIIdentification\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchHeader\"},{\"id\":189,\"kind\":1024,\"name\":\"batchNumber\",\"url\":\"interfaces/api.BatchHeader.html#batchNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.BatchHeader\"},{\"id\":190,\"kind\":256,\"name\":\"CreateFile\",\"url\":\"interfaces/api.CreateFile.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":191,\"kind\":1024,\"name\":\"ID\",\"url\":\"interfaces/api.CreateFile.html#ID\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.CreateFile\"},{\"id\":192,\"kind\":1024,\"name\":\"fileHeader\",\"url\":\"interfaces/api.CreateFile.html#fileHeader\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.CreateFile\"},{\"id\":193,\"kind\":1024,\"name\":\"batches\",\"url\":\"interfaces/api.CreateFile.html#batches\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.CreateFile\"},{\"id\":194,\"kind\":1024,\"name\":\"IATBatches\",\"url\":\"interfaces/api.CreateFile.html#IATBatches\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.CreateFile\"},{\"id\":195,\"kind\":1024,\"name\":\"fileControl\",\"url\":\"interfaces/api.CreateFile.html#fileControl\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.CreateFile\"},{\"id\":196,\"kind\":1024,\"name\":\"advEntryDetails\",\"url\":\"interfaces/api.CreateFile.html#advEntryDetails\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.CreateFile\"},{\"id\":197,\"kind\":1024,\"name\":\"advBatchControl\",\"url\":\"interfaces/api.CreateFile.html#advBatchControl\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.CreateFile\"},{\"id\":198,\"kind\":256,\"name\":\"EntryDetail\",\"url\":\"interfaces/api.EntryDetail.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":199,\"kind\":1024,\"name\":\"ID\",\"url\":\"interfaces/api.EntryDetail.html#ID\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.EntryDetail\"},{\"id\":200,\"kind\":1024,\"name\":\"transactionCode\",\"url\":\"interfaces/api.EntryDetail.html#transactionCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.EntryDetail\"},{\"id\":201,\"kind\":1024,\"name\":\"RDFIIdentification\",\"url\":\"interfaces/api.EntryDetail.html#RDFIIdentification\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.EntryDetail\"},{\"id\":202,\"kind\":1024,\"name\":\"checkDigit\",\"url\":\"interfaces/api.EntryDetail.html#checkDigit\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.EntryDetail\"},{\"id\":203,\"kind\":1024,\"name\":\"DFIAccountNumber\",\"url\":\"interfaces/api.EntryDetail.html#DFIAccountNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.EntryDetail\"},{\"id\":204,\"kind\":1024,\"name\":\"amount\",\"url\":\"interfaces/api.EntryDetail.html#amount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.EntryDetail\"},{\"id\":205,\"kind\":1024,\"name\":\"identificationNumber\",\"url\":\"interfaces/api.EntryDetail.html#identificationNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.EntryDetail\"},{\"id\":206,\"kind\":1024,\"name\":\"individualName\",\"url\":\"interfaces/api.EntryDetail.html#individualName\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.EntryDetail\"},{\"id\":207,\"kind\":1024,\"name\":\"discretionaryData\",\"url\":\"interfaces/api.EntryDetail.html#discretionaryData\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.EntryDetail\"},{\"id\":208,\"kind\":1024,\"name\":\"addendaRecordIndicator\",\"url\":\"interfaces/api.EntryDetail.html#addendaRecordIndicator\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.EntryDetail\"},{\"id\":209,\"kind\":1024,\"name\":\"traceNumber\",\"url\":\"interfaces/api.EntryDetail.html#traceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.EntryDetail\"},{\"id\":210,\"kind\":1024,\"name\":\"addenda02\",\"url\":\"interfaces/api.EntryDetail.html#addenda02\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.EntryDetail\"},{\"id\":211,\"kind\":1024,\"name\":\"addenda05\",\"url\":\"interfaces/api.EntryDetail.html#addenda05\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.EntryDetail\"},{\"id\":212,\"kind\":1024,\"name\":\"addenda98\",\"url\":\"interfaces/api.EntryDetail.html#addenda98\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.EntryDetail\"},{\"id\":213,\"kind\":1024,\"name\":\"addenda99\",\"url\":\"interfaces/api.EntryDetail.html#addenda99\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.EntryDetail\"},{\"id\":214,\"kind\":1024,\"name\":\"addenda99Dishonored\",\"url\":\"interfaces/api.EntryDetail.html#addenda99Dishonored\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.EntryDetail\"},{\"id\":215,\"kind\":1024,\"name\":\"addenda99Contested\",\"url\":\"interfaces/api.EntryDetail.html#addenda99Contested\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.EntryDetail\"},{\"id\":216,\"kind\":1024,\"name\":\"category\",\"url\":\"interfaces/api.EntryDetail.html#category\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.EntryDetail\"},{\"id\":217,\"kind\":256,\"name\":\"FileControl\",\"url\":\"interfaces/api.FileControl.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":218,\"kind\":1024,\"name\":\"ID\",\"url\":\"interfaces/api.FileControl.html#ID\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.FileControl\"},{\"id\":219,\"kind\":1024,\"name\":\"batchCount\",\"url\":\"interfaces/api.FileControl.html#batchCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.FileControl\"},{\"id\":220,\"kind\":1024,\"name\":\"blockCount\",\"url\":\"interfaces/api.FileControl.html#blockCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.FileControl\"},{\"id\":221,\"kind\":1024,\"name\":\"entryAddendaCount\",\"url\":\"interfaces/api.FileControl.html#entryAddendaCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.FileControl\"},{\"id\":222,\"kind\":1024,\"name\":\"entryHash\",\"url\":\"interfaces/api.FileControl.html#entryHash\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.FileControl\"},{\"id\":223,\"kind\":1024,\"name\":\"totalDebit\",\"url\":\"interfaces/api.FileControl.html#totalDebit\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.FileControl\"},{\"id\":224,\"kind\":1024,\"name\":\"totalCredit\",\"url\":\"interfaces/api.FileControl.html#totalCredit\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.FileControl\"},{\"id\":225,\"kind\":256,\"name\":\"FileHeader\",\"url\":\"interfaces/api.FileHeader.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":226,\"kind\":1024,\"name\":\"ID\",\"url\":\"interfaces/api.FileHeader.html#ID\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.FileHeader\"},{\"id\":227,\"kind\":1024,\"name\":\"immediateOrigin\",\"url\":\"interfaces/api.FileHeader.html#immediateOrigin\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.FileHeader\"},{\"id\":228,\"kind\":1024,\"name\":\"immediateOriginName\",\"url\":\"interfaces/api.FileHeader.html#immediateOriginName\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.FileHeader\"},{\"id\":229,\"kind\":1024,\"name\":\"immediateDestination\",\"url\":\"interfaces/api.FileHeader.html#immediateDestination\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.FileHeader\"},{\"id\":230,\"kind\":1024,\"name\":\"immediateDestinationName\",\"url\":\"interfaces/api.FileHeader.html#immediateDestinationName\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.FileHeader\"},{\"id\":231,\"kind\":1024,\"name\":\"fileCreationTime\",\"url\":\"interfaces/api.FileHeader.html#fileCreationTime\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.FileHeader\"},{\"id\":232,\"kind\":1024,\"name\":\"fileCreationDate\",\"url\":\"interfaces/api.FileHeader.html#fileCreationDate\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.FileHeader\"},{\"id\":233,\"kind\":1024,\"name\":\"fileIDModifier\",\"url\":\"interfaces/api.FileHeader.html#fileIDModifier\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.FileHeader\"},{\"id\":234,\"kind\":1024,\"name\":\"referenceCode\",\"url\":\"interfaces/api.FileHeader.html#referenceCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.FileHeader\"},{\"id\":235,\"kind\":256,\"name\":\"FileID\",\"url\":\"interfaces/api.FileID.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":236,\"kind\":1024,\"name\":\"ID\",\"url\":\"interfaces/api.FileID.html#ID\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.FileID\"},{\"id\":237,\"kind\":1024,\"name\":\"error\",\"url\":\"interfaces/api.FileID.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.FileID\"},{\"id\":238,\"kind\":256,\"name\":\"IATBatch\",\"url\":\"interfaces/api.IATBatch.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":239,\"kind\":1024,\"name\":\"ID\",\"url\":\"interfaces/api.IATBatch.html#ID\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatch\"},{\"id\":240,\"kind\":1024,\"name\":\"IATBatchHeader\",\"url\":\"interfaces/api.IATBatch.html#IATBatchHeader\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatch\"},{\"id\":241,\"kind\":1024,\"name\":\"IATEntryDetails\",\"url\":\"interfaces/api.IATBatch.html#IATEntryDetails\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatch\"},{\"id\":242,\"kind\":1024,\"name\":\"batchControl\",\"url\":\"interfaces/api.IATBatch.html#batchControl\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatch\"},{\"id\":243,\"kind\":256,\"name\":\"IATBatchHeader\",\"url\":\"interfaces/api.IATBatchHeader.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":244,\"kind\":1024,\"name\":\"ID\",\"url\":\"interfaces/api.IATBatchHeader.html#ID\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatchHeader\"},{\"id\":245,\"kind\":1024,\"name\":\"serviceClassCode\",\"url\":\"interfaces/api.IATBatchHeader.html#serviceClassCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatchHeader\"},{\"id\":246,\"kind\":1024,\"name\":\"IATIndicator\",\"url\":\"interfaces/api.IATBatchHeader.html#IATIndicator\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatchHeader\"},{\"id\":247,\"kind\":1024,\"name\":\"foreignExchangeIndicator\",\"url\":\"interfaces/api.IATBatchHeader.html#foreignExchangeIndicator\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatchHeader\"},{\"id\":248,\"kind\":1024,\"name\":\"foreignExchangeReferenceIndicator\",\"url\":\"interfaces/api.IATBatchHeader.html#foreignExchangeReferenceIndicator\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatchHeader\"},{\"id\":249,\"kind\":1024,\"name\":\"foreignExchangeReference\",\"url\":\"interfaces/api.IATBatchHeader.html#foreignExchangeReference\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatchHeader\"},{\"id\":250,\"kind\":1024,\"name\":\"ISODestinationCountryCode\",\"url\":\"interfaces/api.IATBatchHeader.html#ISODestinationCountryCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatchHeader\"},{\"id\":251,\"kind\":1024,\"name\":\"originatorIdentification\",\"url\":\"interfaces/api.IATBatchHeader.html#originatorIdentification\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatchHeader\"},{\"id\":252,\"kind\":1024,\"name\":\"standardEntryClassCode\",\"url\":\"interfaces/api.IATBatchHeader.html#standardEntryClassCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatchHeader\"},{\"id\":253,\"kind\":1024,\"name\":\"companyEntryDescription\",\"url\":\"interfaces/api.IATBatchHeader.html#companyEntryDescription\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatchHeader\"},{\"id\":254,\"kind\":1024,\"name\":\"ISOOriginatingCurrencyCode\",\"url\":\"interfaces/api.IATBatchHeader.html#ISOOriginatingCurrencyCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatchHeader\"},{\"id\":255,\"kind\":1024,\"name\":\"ISODestinationCurrencyCode\",\"url\":\"interfaces/api.IATBatchHeader.html#ISODestinationCurrencyCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatchHeader\"},{\"id\":256,\"kind\":1024,\"name\":\"effectiveEntryDate\",\"url\":\"interfaces/api.IATBatchHeader.html#effectiveEntryDate\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatchHeader\"},{\"id\":257,\"kind\":1024,\"name\":\"originatorStatusCode\",\"url\":\"interfaces/api.IATBatchHeader.html#originatorStatusCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatchHeader\"},{\"id\":258,\"kind\":1024,\"name\":\"ODFIIdentification\",\"url\":\"interfaces/api.IATBatchHeader.html#ODFIIdentification\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatchHeader\"},{\"id\":259,\"kind\":1024,\"name\":\"batchNumber\",\"url\":\"interfaces/api.IATBatchHeader.html#batchNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATBatchHeader\"},{\"id\":260,\"kind\":256,\"name\":\"IATEntryDetail\",\"url\":\"interfaces/api.IATEntryDetail.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":261,\"kind\":1024,\"name\":\"ID\",\"url\":\"interfaces/api.IATEntryDetail.html#ID\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":262,\"kind\":1024,\"name\":\"transactionCode\",\"url\":\"interfaces/api.IATEntryDetail.html#transactionCode\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":263,\"kind\":1024,\"name\":\"RDFIIdentification\",\"url\":\"interfaces/api.IATEntryDetail.html#RDFIIdentification\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":264,\"kind\":1024,\"name\":\"checkDigit\",\"url\":\"interfaces/api.IATEntryDetail.html#checkDigit\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":265,\"kind\":1024,\"name\":\"addendaRecords\",\"url\":\"interfaces/api.IATEntryDetail.html#addendaRecords\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":266,\"kind\":1024,\"name\":\"amount\",\"url\":\"interfaces/api.IATEntryDetail.html#amount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":267,\"kind\":1024,\"name\":\"DFIAccountNumber\",\"url\":\"interfaces/api.IATEntryDetail.html#DFIAccountNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":268,\"kind\":1024,\"name\":\"OFACScreeningIndicator\",\"url\":\"interfaces/api.IATEntryDetail.html#OFACScreeningIndicator\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":269,\"kind\":1024,\"name\":\"secondaryOFACScreeningIndicator\",\"url\":\"interfaces/api.IATEntryDetail.html#secondaryOFACScreeningIndicator\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":270,\"kind\":1024,\"name\":\"addendaRecordIndicator\",\"url\":\"interfaces/api.IATEntryDetail.html#addendaRecordIndicator\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":271,\"kind\":1024,\"name\":\"traceNumber\",\"url\":\"interfaces/api.IATEntryDetail.html#traceNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":272,\"kind\":1024,\"name\":\"addenda10\",\"url\":\"interfaces/api.IATEntryDetail.html#addenda10\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":273,\"kind\":1024,\"name\":\"addenda11\",\"url\":\"interfaces/api.IATEntryDetail.html#addenda11\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":274,\"kind\":1024,\"name\":\"addenda12\",\"url\":\"interfaces/api.IATEntryDetail.html#addenda12\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":275,\"kind\":1024,\"name\":\"addenda13\",\"url\":\"interfaces/api.IATEntryDetail.html#addenda13\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":276,\"kind\":1024,\"name\":\"addenda14\",\"url\":\"interfaces/api.IATEntryDetail.html#addenda14\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":277,\"kind\":1024,\"name\":\"addenda15\",\"url\":\"interfaces/api.IATEntryDetail.html#addenda15\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":278,\"kind\":1024,\"name\":\"addenda16\",\"url\":\"interfaces/api.IATEntryDetail.html#addenda16\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":279,\"kind\":1024,\"name\":\"addenda17\",\"url\":\"interfaces/api.IATEntryDetail.html#addenda17\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":280,\"kind\":1024,\"name\":\"addenda18\",\"url\":\"interfaces/api.IATEntryDetail.html#addenda18\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":281,\"kind\":1024,\"name\":\"addenda98\",\"url\":\"interfaces/api.IATEntryDetail.html#addenda98\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":282,\"kind\":1024,\"name\":\"addenda99\",\"url\":\"interfaces/api.IATEntryDetail.html#addenda99\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":283,\"kind\":1024,\"name\":\"category\",\"url\":\"interfaces/api.IATEntryDetail.html#category\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.IATEntryDetail\"},{\"id\":284,\"kind\":256,\"name\":\"ModelError\",\"url\":\"interfaces/api.ModelError.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":285,\"kind\":1024,\"name\":\"error\",\"url\":\"interfaces/api.ModelError.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ModelError\"},{\"id\":286,\"kind\":256,\"name\":\"ModelFile\",\"url\":\"interfaces/api.ModelFile.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":287,\"kind\":1024,\"name\":\"ID\",\"url\":\"interfaces/api.ModelFile.html#ID\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ModelFile\"},{\"id\":288,\"kind\":1024,\"name\":\"fileHeader\",\"url\":\"interfaces/api.ModelFile.html#fileHeader\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ModelFile\"},{\"id\":289,\"kind\":1024,\"name\":\"batches\",\"url\":\"interfaces/api.ModelFile.html#batches\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ModelFile\"},{\"id\":290,\"kind\":1024,\"name\":\"IATBatches\",\"url\":\"interfaces/api.ModelFile.html#IATBatches\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ModelFile\"},{\"id\":291,\"kind\":1024,\"name\":\"fileControl\",\"url\":\"interfaces/api.ModelFile.html#fileControl\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ModelFile\"},{\"id\":292,\"kind\":1024,\"name\":\"NotificationOfChange\",\"url\":\"interfaces/api.ModelFile.html#NotificationOfChange\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ModelFile\"},{\"id\":293,\"kind\":1024,\"name\":\"ReturnEntries\",\"url\":\"interfaces/api.ModelFile.html#ReturnEntries\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ModelFile\"},{\"id\":294,\"kind\":1024,\"name\":\"fileADVControl\",\"url\":\"interfaces/api.ModelFile.html#fileADVControl\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ModelFile\"},{\"id\":295,\"kind\":256,\"name\":\"Offset\",\"url\":\"interfaces/api.Offset.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":296,\"kind\":1024,\"name\":\"routingNumber\",\"url\":\"interfaces/api.Offset.html#routingNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Offset\"},{\"id\":297,\"kind\":1024,\"name\":\"accountNumber\",\"url\":\"interfaces/api.Offset.html#accountNumber\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Offset\"},{\"id\":298,\"kind\":1024,\"name\":\"accountType\",\"url\":\"interfaces/api.Offset.html#accountType\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Offset\"},{\"id\":299,\"kind\":1024,\"name\":\"description\",\"url\":\"interfaces/api.Offset.html#description\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.Offset\"},{\"id\":300,\"kind\":32,\"name\":\"OffsetAccountTypeEnum\",\"url\":\"modules/api.html#OffsetAccountTypeEnum-1\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":301,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/api.html#OffsetAccountTypeEnum-1.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"parent\":\"api.OffsetAccountTypeEnum\"},{\"id\":302,\"kind\":1024,\"name\":\"Checking\",\"url\":\"modules/api.html#OffsetAccountTypeEnum-1.__type.Checking\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"api.OffsetAccountTypeEnum.__type\"},{\"id\":303,\"kind\":1024,\"name\":\"Savings\",\"url\":\"modules/api.html#OffsetAccountTypeEnum-1.__type.Savings\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"api.OffsetAccountTypeEnum.__type\"},{\"id\":304,\"kind\":4194304,\"name\":\"OffsetAccountTypeEnum\",\"url\":\"modules/api.html#OffsetAccountTypeEnum\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":305,\"kind\":256,\"name\":\"SegmentedFiles\",\"url\":\"interfaces/api.SegmentedFiles.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":306,\"kind\":1024,\"name\":\"creditFileID\",\"url\":\"interfaces/api.SegmentedFiles.html#creditFileID\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.SegmentedFiles\"},{\"id\":307,\"kind\":1024,\"name\":\"debitFileID\",\"url\":\"interfaces/api.SegmentedFiles.html#debitFileID\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.SegmentedFiles\"},{\"id\":308,\"kind\":256,\"name\":\"ValidateOpts\",\"url\":\"interfaces/api.ValidateOpts.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":309,\"kind\":1024,\"name\":\"requireABAOrigin\",\"url\":\"interfaces/api.ValidateOpts.html#requireABAOrigin\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ValidateOpts\"},{\"id\":310,\"kind\":1024,\"name\":\"bypassOriginValidation\",\"url\":\"interfaces/api.ValidateOpts.html#bypassOriginValidation\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ValidateOpts\"},{\"id\":311,\"kind\":1024,\"name\":\"bypassDestinationValidation\",\"url\":\"interfaces/api.ValidateOpts.html#bypassDestinationValidation\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"api.ValidateOpts\"},{\"id\":312,\"kind\":64,\"name\":\"ACHFilesApiAxiosParamCreator\",\"url\":\"modules/api.html#ACHFilesApiAxiosParamCreator\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":313,\"kind\":64,\"name\":\"ACHFilesApiFp\",\"url\":\"modules/api.html#ACHFilesApiFp\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":314,\"kind\":64,\"name\":\"ACHFilesApiFactory\",\"url\":\"modules/api.html#ACHFilesApiFactory\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":315,\"kind\":128,\"name\":\"ACHFilesApi\",\"url\":\"classes/api.ACHFilesApi.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"api\"},{\"id\":316,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/api.ACHFilesApi.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"api.ACHFilesApi\"},{\"id\":317,\"kind\":2048,\"name\":\"addBatchToFile\",\"url\":\"classes/api.ACHFilesApi.html#addBatchToFile\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"api.ACHFilesApi\"},{\"id\":318,\"kind\":2048,\"name\":\"buildFile\",\"url\":\"classes/api.ACHFilesApi.html#buildFile\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"api.ACHFilesApi\"},{\"id\":319,\"kind\":2048,\"name\":\"checkFile\",\"url\":\"classes/api.ACHFilesApi.html#checkFile\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"api.ACHFilesApi\"},{\"id\":320,\"kind\":2048,\"name\":\"createFile\",\"url\":\"classes/api.ACHFilesApi.html#createFile\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"api.ACHFilesApi\"},{\"id\":321,\"kind\":2048,\"name\":\"deleteACHFile\",\"url\":\"classes/api.ACHFilesApi.html#deleteACHFile\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"api.ACHFilesApi\"},{\"id\":322,\"kind\":2048,\"name\":\"deleteFileBatch\",\"url\":\"classes/api.ACHFilesApi.html#deleteFileBatch\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"api.ACHFilesApi\"},{\"id\":323,\"kind\":2048,\"name\":\"flattenFile\",\"url\":\"classes/api.ACHFilesApi.html#flattenFile\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"api.ACHFilesApi\"},{\"id\":324,\"kind\":2048,\"name\":\"getFileBatch\",\"url\":\"classes/api.ACHFilesApi.html#getFileBatch\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"api.ACHFilesApi\"},{\"id\":325,\"kind\":2048,\"name\":\"getFileBatches\",\"url\":\"classes/api.ACHFilesApi.html#getFileBatches\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"api.ACHFilesApi\"},{\"id\":326,\"kind\":2048,\"name\":\"getFileByID\",\"url\":\"classes/api.ACHFilesApi.html#getFileByID\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"api.ACHFilesApi\"},{\"id\":327,\"kind\":2048,\"name\":\"getFileContents\",\"url\":\"classes/api.ACHFilesApi.html#getFileContents\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"api.ACHFilesApi\"},{\"id\":328,\"kind\":2048,\"name\":\"getFiles\",\"url\":\"classes/api.ACHFilesApi.html#getFiles\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"api.ACHFilesApi\"},{\"id\":329,\"kind\":2048,\"name\":\"ping\",\"url\":\"classes/api.ACHFilesApi.html#ping\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"api.ACHFilesApi\"},{\"id\":330,\"kind\":2048,\"name\":\"segmentFile\",\"url\":\"classes/api.ACHFilesApi.html#segmentFile\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"api.ACHFilesApi\"},{\"id\":331,\"kind\":2048,\"name\":\"validateFile\",\"url\":\"classes/api.ACHFilesApi.html#validateFile\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"api.ACHFilesApi\"},{\"id\":332,\"kind\":1024,\"name\":\"configuration\",\"url\":\"classes/api.ACHFilesApi.html#configuration\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected\",\"parent\":\"api.ACHFilesApi\"},{\"id\":333,\"kind\":1024,\"name\":\"basePath\",\"url\":\"classes/api.ACHFilesApi.html#basePath\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected\",\"parent\":\"api.ACHFilesApi\"},{\"id\":334,\"kind\":1024,\"name\":\"axios\",\"url\":\"classes/api.ACHFilesApi.html#axios\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected\",\"parent\":\"api.ACHFilesApi\"},{\"id\":335,\"kind\":2,\"name\":\"base\",\"url\":\"modules/base.html\",\"classes\":\"tsd-kind-module\"},{\"id\":336,\"kind\":32,\"name\":\"BASE_PATH\",\"url\":\"modules/base.html#BASE_PATH\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"base\"},{\"id\":337,\"kind\":32,\"name\":\"COLLECTION_FORMATS\",\"url\":\"modules/base.html#COLLECTION_FORMATS\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"base\"},{\"id\":338,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules/base.html#COLLECTION_FORMATS.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"parent\":\"base.COLLECTION_FORMATS\"},{\"id\":339,\"kind\":1024,\"name\":\"csv\",\"url\":\"modules/base.html#COLLECTION_FORMATS.__type.csv\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"base.COLLECTION_FORMATS.__type\"},{\"id\":340,\"kind\":1024,\"name\":\"ssv\",\"url\":\"modules/base.html#COLLECTION_FORMATS.__type.ssv\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"base.COLLECTION_FORMATS.__type\"},{\"id\":341,\"kind\":1024,\"name\":\"tsv\",\"url\":\"modules/base.html#COLLECTION_FORMATS.__type.tsv\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"base.COLLECTION_FORMATS.__type\"},{\"id\":342,\"kind\":1024,\"name\":\"pipes\",\"url\":\"modules/base.html#COLLECTION_FORMATS.__type.pipes\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"base.COLLECTION_FORMATS.__type\"},{\"id\":343,\"kind\":256,\"name\":\"RequestArgs\",\"url\":\"interfaces/base.RequestArgs.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"base\"},{\"id\":344,\"kind\":1024,\"name\":\"url\",\"url\":\"interfaces/base.RequestArgs.html#url\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"base.RequestArgs\"},{\"id\":345,\"kind\":1024,\"name\":\"options\",\"url\":\"interfaces/base.RequestArgs.html#options\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"base.RequestArgs\"},{\"id\":346,\"kind\":128,\"name\":\"BaseAPI\",\"url\":\"classes/base.BaseAPI.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"base\"},{\"id\":347,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/base.BaseAPI.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"base.BaseAPI\"},{\"id\":348,\"kind\":1024,\"name\":\"configuration\",\"url\":\"classes/base.BaseAPI.html#configuration\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"base.BaseAPI\"},{\"id\":349,\"kind\":1024,\"name\":\"basePath\",\"url\":\"classes/base.BaseAPI.html#basePath\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"base.BaseAPI\"},{\"id\":350,\"kind\":1024,\"name\":\"axios\",\"url\":\"classes/base.BaseAPI.html#axios\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"base.BaseAPI\"},{\"id\":351,\"kind\":128,\"name\":\"RequiredError\",\"url\":\"classes/base.RequiredError.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"base\"},{\"id\":352,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/base.RequiredError.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite\",\"parent\":\"base.RequiredError\"},{\"id\":353,\"kind\":1024,\"name\":\"name\",\"url\":\"classes/base.RequiredError.html#name\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite\",\"parent\":\"base.RequiredError\"},{\"id\":354,\"kind\":1024,\"name\":\"field\",\"url\":\"classes/base.RequiredError.html#field\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"base.RequiredError\"},{\"id\":355,\"kind\":2,\"name\":\"common\",\"url\":\"modules/common.html\",\"classes\":\"tsd-kind-module\"},{\"id\":356,\"kind\":32,\"name\":\"DUMMY_BASE_URL\",\"url\":\"modules/common.html#DUMMY_BASE_URL\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":357,\"kind\":64,\"name\":\"assertParamExists\",\"url\":\"modules/common.html#assertParamExists\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":358,\"kind\":64,\"name\":\"setApiKeyToObject\",\"url\":\"modules/common.html#setApiKeyToObject\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":359,\"kind\":64,\"name\":\"setBasicAuthToObject\",\"url\":\"modules/common.html#setBasicAuthToObject\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":360,\"kind\":64,\"name\":\"setBearerAuthToObject\",\"url\":\"modules/common.html#setBearerAuthToObject\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":361,\"kind\":64,\"name\":\"setOAuthToObject\",\"url\":\"modules/common.html#setOAuthToObject\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":362,\"kind\":64,\"name\":\"setSearchParams\",\"url\":\"modules/common.html#setSearchParams\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":363,\"kind\":64,\"name\":\"serializeDataIfNeeded\",\"url\":\"modules/common.html#serializeDataIfNeeded\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":364,\"kind\":64,\"name\":\"toPathString\",\"url\":\"modules/common.html#toPathString\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":365,\"kind\":64,\"name\":\"createRequestFunction\",\"url\":\"modules/common.html#createRequestFunction\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"common\"},{\"id\":366,\"kind\":2,\"name\":\"configuration\",\"url\":\"modules/configuration.html\",\"classes\":\"tsd-kind-module\"},{\"id\":367,\"kind\":256,\"name\":\"ConfigurationParameters\",\"url\":\"interfaces/configuration.ConfigurationParameters.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"configuration\"},{\"id\":368,\"kind\":1024,\"name\":\"apiKey\",\"url\":\"interfaces/configuration.ConfigurationParameters.html#apiKey\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"configuration.ConfigurationParameters\"},{\"id\":369,\"kind\":1024,\"name\":\"username\",\"url\":\"interfaces/configuration.ConfigurationParameters.html#username\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"configuration.ConfigurationParameters\"},{\"id\":370,\"kind\":1024,\"name\":\"password\",\"url\":\"interfaces/configuration.ConfigurationParameters.html#password\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"configuration.ConfigurationParameters\"},{\"id\":371,\"kind\":1024,\"name\":\"accessToken\",\"url\":\"interfaces/configuration.ConfigurationParameters.html#accessToken\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"configuration.ConfigurationParameters\"},{\"id\":372,\"kind\":1024,\"name\":\"basePath\",\"url\":\"interfaces/configuration.ConfigurationParameters.html#basePath\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"configuration.ConfigurationParameters\"},{\"id\":373,\"kind\":1024,\"name\":\"baseOptions\",\"url\":\"interfaces/configuration.ConfigurationParameters.html#baseOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"configuration.ConfigurationParameters\"},{\"id\":374,\"kind\":1024,\"name\":\"formDataCtor\",\"url\":\"interfaces/configuration.ConfigurationParameters.html#formDataCtor\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"configuration.ConfigurationParameters\"},{\"id\":375,\"kind\":512,\"name\":\"__type\",\"url\":\"interfaces/configuration.ConfigurationParameters.html#__type\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-interface\",\"parent\":\"configuration.ConfigurationParameters\"},{\"id\":376,\"kind\":128,\"name\":\"Configuration\",\"url\":\"classes/configuration.Configuration.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"configuration\"},{\"id\":377,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/configuration.Configuration.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"configuration.Configuration\"},{\"id\":378,\"kind\":1024,\"name\":\"apiKey\",\"url\":\"classes/configuration.Configuration.html#apiKey\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"configuration.Configuration\"},{\"id\":379,\"kind\":1024,\"name\":\"username\",\"url\":\"classes/configuration.Configuration.html#username\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"configuration.Configuration\"},{\"id\":380,\"kind\":1024,\"name\":\"password\",\"url\":\"classes/configuration.Configuration.html#password\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"configuration.Configuration\"},{\"id\":381,\"kind\":1024,\"name\":\"accessToken\",\"url\":\"classes/configuration.Configuration.html#accessToken\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"configuration.Configuration\"},{\"id\":382,\"kind\":1024,\"name\":\"basePath\",\"url\":\"classes/configuration.Configuration.html#basePath\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"configuration.Configuration\"},{\"id\":383,\"kind\":1024,\"name\":\"baseOptions\",\"url\":\"classes/configuration.Configuration.html#baseOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"configuration.Configuration\"},{\"id\":384,\"kind\":1024,\"name\":\"formDataCtor\",\"url\":\"classes/configuration.Configuration.html#formDataCtor\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"configuration.Configuration\"},{\"id\":385,\"kind\":512,\"name\":\"__type\",\"url\":\"classes/configuration.Configuration.html#__type\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"configuration.Configuration\"},{\"id\":386,\"kind\":2048,\"name\":\"isJsonMime\",\"url\":\"classes/configuration.Configuration.html#isJsonMime\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"configuration.Configuration\"},{\"id\":387,\"kind\":2,\"name\":\"index\",\"url\":\"modules/index.html\",\"classes\":\"tsd-kind-module\"},{\"id\":388,\"kind\":2,\"name\":\"url\",\"url\":\"modules/url.html\",\"classes\":\"tsd-kind-module\"},{\"id\":389,\"kind\":64,\"name\":\"parse\",\"url\":\"modules/url.html#parse\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"url\"},{\"id\":390,\"kind\":64,\"name\":\"format\",\"url\":\"modules/url.html#format\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"url\"},{\"id\":391,\"kind\":256,\"name\":\"Url\",\"url\":\"interfaces/url.Url.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"url\"},{\"id\":392,\"kind\":1024,\"name\":\"protocol\",\"url\":\"interfaces/url.Url.html#protocol\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"url.Url\"},{\"id\":393,\"kind\":1024,\"name\":\"hostname\",\"url\":\"interfaces/url.Url.html#hostname\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"url.Url\"},{\"id\":394,\"kind\":1024,\"name\":\"pathname\",\"url\":\"interfaces/url.Url.html#pathname\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"url.Url\"},{\"id\":395,\"kind\":1024,\"name\":\"query\",\"url\":\"interfaces/url.Url.html#query\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"url.Url\"},{\"id\":396,\"kind\":1024,\"name\":\"search\",\"url\":\"interfaces/url.Url.html#search\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"url.Url\"},{\"id\":397,\"kind\":16777216,\"name\":\"ADVBatchControl\",\"url\":\"modules/index.html#ADVBatchControl\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":398,\"kind\":16777216,\"name\":\"ADVEntryDetail\",\"url\":\"modules/index.html#ADVEntryDetail\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":399,\"kind\":16777216,\"name\":\"ADVFileControl\",\"url\":\"modules/index.html#ADVFileControl\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":400,\"kind\":16777216,\"name\":\"Addenda02\",\"url\":\"modules/index.html#Addenda02\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":401,\"kind\":16777216,\"name\":\"Addenda05\",\"url\":\"modules/index.html#Addenda05\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":402,\"kind\":16777216,\"name\":\"Addenda10\",\"url\":\"modules/index.html#Addenda10\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":403,\"kind\":16777216,\"name\":\"Addenda11\",\"url\":\"modules/index.html#Addenda11\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":404,\"kind\":16777216,\"name\":\"Addenda12\",\"url\":\"modules/index.html#Addenda12\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":405,\"kind\":16777216,\"name\":\"Addenda13\",\"url\":\"modules/index.html#Addenda13\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":406,\"kind\":16777216,\"name\":\"Addenda14\",\"url\":\"modules/index.html#Addenda14\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":407,\"kind\":16777216,\"name\":\"Addenda15\",\"url\":\"modules/index.html#Addenda15\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":408,\"kind\":16777216,\"name\":\"Addenda16\",\"url\":\"modules/index.html#Addenda16\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":409,\"kind\":16777216,\"name\":\"Addenda17\",\"url\":\"modules/index.html#Addenda17\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":410,\"kind\":16777216,\"name\":\"Addenda18\",\"url\":\"modules/index.html#Addenda18\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":411,\"kind\":16777216,\"name\":\"Addenda98\",\"url\":\"modules/index.html#Addenda98\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":412,\"kind\":16777216,\"name\":\"Addenda99\",\"url\":\"modules/index.html#Addenda99\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":413,\"kind\":16777216,\"name\":\"Addenda99Contested\",\"url\":\"modules/index.html#Addenda99Contested\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":414,\"kind\":16777216,\"name\":\"Addenda99Dishonored\",\"url\":\"modules/index.html#Addenda99Dishonored\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":415,\"kind\":16777216,\"name\":\"Batch\",\"url\":\"modules/index.html#Batch\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":416,\"kind\":16777216,\"name\":\"BatchControl\",\"url\":\"modules/index.html#BatchControl\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":417,\"kind\":16777216,\"name\":\"BatchHeader\",\"url\":\"modules/index.html#BatchHeader\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":418,\"kind\":16777216,\"name\":\"CreateFile\",\"url\":\"modules/index.html#CreateFile\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":419,\"kind\":16777216,\"name\":\"EntryDetail\",\"url\":\"modules/index.html#EntryDetail\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":420,\"kind\":16777216,\"name\":\"FileControl\",\"url\":\"modules/index.html#FileControl\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":421,\"kind\":16777216,\"name\":\"FileHeader\",\"url\":\"modules/index.html#FileHeader\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":422,\"kind\":16777216,\"name\":\"FileID\",\"url\":\"modules/index.html#FileID\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":423,\"kind\":16777216,\"name\":\"IATBatch\",\"url\":\"modules/index.html#IATBatch\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":424,\"kind\":16777216,\"name\":\"IATBatchHeader\",\"url\":\"modules/index.html#IATBatchHeader\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":425,\"kind\":16777216,\"name\":\"IATEntryDetail\",\"url\":\"modules/index.html#IATEntryDetail\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":426,\"kind\":16777216,\"name\":\"ModelError\",\"url\":\"modules/index.html#ModelError\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":427,\"kind\":16777216,\"name\":\"ModelFile\",\"url\":\"modules/index.html#ModelFile\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":428,\"kind\":16777216,\"name\":\"Offset\",\"url\":\"modules/index.html#Offset\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":429,\"kind\":16777216,\"name\":\"OffsetAccountTypeEnum\",\"url\":\"modules/index.html#OffsetAccountTypeEnum\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":430,\"kind\":16777216,\"name\":\"SegmentedFiles\",\"url\":\"modules/index.html#SegmentedFiles\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":431,\"kind\":16777216,\"name\":\"ValidateOpts\",\"url\":\"modules/index.html#ValidateOpts\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":432,\"kind\":16777216,\"name\":\"ACHFilesApiAxiosParamCreator\",\"url\":\"modules/index.html#ACHFilesApiAxiosParamCreator\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":433,\"kind\":16777216,\"name\":\"ACHFilesApiFp\",\"url\":\"modules/index.html#ACHFilesApiFp\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":434,\"kind\":16777216,\"name\":\"ACHFilesApiFactory\",\"url\":\"modules/index.html#ACHFilesApiFactory\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":435,\"kind\":16777216,\"name\":\"ACHFilesApi\",\"url\":\"modules/index.html#ACHFilesApi\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":436,\"kind\":16777216,\"name\":\"ConfigurationParameters\",\"url\":\"modules/index.html#ConfigurationParameters\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"},{\"id\":437,\"kind\":16777216,\"name\":\"Configuration\",\"url\":\"modules/index.html#Configuration\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"index\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"parent\"],\"fieldVectors\":[[\"name/0\",[0,23.588]],[\"parent/0\",[]],[\"name/1\",[1,48.317]],[\"parent/1\",[0,2.345]],[\"name/2\",[2,27.001]],[\"parent/2\",[3,3.812]],[\"name/3\",[4,45.804]],[\"parent/3\",[3,3.812]],[\"name/4\",[5,45.804]],[\"parent/4\",[3,3.812]],[\"name/5\",[6,45.804]],[\"parent/5\",[3,3.812]],[\"name/6\",[7,45.804]],[\"parent/6\",[3,3.812]],[\"name/7\",[8,45.804]],[\"parent/7\",[3,3.812]],[\"name/8\",[9,51.682]],[\"parent/8\",[3,3.812]],[\"name/9\",[10,45.804]],[\"parent/9\",[3,3.812]],[\"name/10\",[11,45.804]],[\"parent/10\",[3,3.812]],[\"name/11\",[12,51.682]],[\"parent/11\",[0,2.345]],[\"name/12\",[2,27.001]],[\"parent/12\",[13,3.204]],[\"name/13\",[14,48.317]],[\"parent/13\",[13,3.204]],[\"name/14\",[15,45.804]],[\"parent/14\",[13,3.204]],[\"name/15\",[16,48.317]],[\"parent/15\",[13,3.204]],[\"name/16\",[17,48.317]],[\"parent/16\",[13,3.204]],[\"name/17\",[18,48.317]],[\"parent/17\",[13,3.204]],[\"name/18\",[19,56.79]],[\"parent/18\",[13,3.204]],[\"name/19\",[20,56.79]],[\"parent/19\",[13,3.204]],[\"name/20\",[9,51.682]],[\"parent/20\",[13,3.204]],[\"name/21\",[21,51.682]],[\"parent/21\",[13,3.204]],[\"name/22\",[22,51.682]],[\"parent/22\",[13,3.204]],[\"name/23\",[23,48.317]],[\"parent/23\",[13,3.204]],[\"name/24\",[24,56.79]],[\"parent/24\",[13,3.204]],[\"name/25\",[25,56.79]],[\"parent/25\",[13,3.204]],[\"name/26\",[26,45.804]],[\"parent/26\",[13,3.204]],[\"name/27\",[27,43.798]],[\"parent/27\",[13,3.204]],[\"name/28\",[28,48.317]],[\"parent/28\",[13,3.204]],[\"name/29\",[29,51.682]],[\"parent/29\",[0,2.345]],[\"name/30\",[2,27.001]],[\"parent/30\",[30,4.047]],[\"name/31\",[31,51.682]],[\"parent/31\",[30,4.047]],[\"name/32\",[32,51.682]],[\"parent/32\",[30,4.047]],[\"name/33\",[5,45.804]],[\"parent/33\",[30,4.047]],[\"name/34\",[6,45.804]],[\"parent/34\",[30,4.047]],[\"name/35\",[7,45.804]],[\"parent/35\",[30,4.047]],[\"name/36\",[8,45.804]],[\"parent/36\",[30,4.047]],[\"name/37\",[33,48.317]],[\"parent/37\",[0,2.345]],[\"name/38\",[2,27.001]],[\"parent/38\",[34,3.539]],[\"name/39\",[35,33.437]],[\"parent/39\",[34,3.539]],[\"name/40\",[36,56.79]],[\"parent/40\",[34,3.539]],[\"name/41\",[37,56.79]],[\"parent/41\",[34,3.539]],[\"name/42\",[38,56.79]],[\"parent/42\",[34,3.539]],[\"name/43\",[39,56.79]],[\"parent/43\",[34,3.539]],[\"name/44\",[40,56.79]],[\"parent/44\",[34,3.539]],[\"name/45\",[41,56.79]],[\"parent/45\",[34,3.539]],[\"name/46\",[42,56.79]],[\"parent/46\",[34,3.539]],[\"name/47\",[43,56.79]],[\"parent/47\",[34,3.539]],[\"name/48\",[44,56.79]],[\"parent/48\",[34,3.539]],[\"name/49\",[45,40.696]],[\"parent/49\",[34,3.539]],[\"name/50\",[46,48.317]],[\"parent/50\",[0,2.345]],[\"name/51\",[2,27.001]],[\"parent/51\",[47,4.355]],[\"name/52\",[35,33.437]],[\"parent/52\",[47,4.355]],[\"name/53\",[48,51.682]],[\"parent/53\",[47,4.355]],[\"name/54\",[26,45.804]],[\"parent/54\",[47,4.355]],[\"name/55\",[49,37.331]],[\"parent/55\",[47,4.355]],[\"name/56\",[50,48.317]],[\"parent/56\",[0,2.345]],[\"name/57\",[2,27.001]],[\"parent/57\",[51,4.047]],[\"name/58\",[35,33.437]],[\"parent/58\",[51,4.047]],[\"name/59\",[52,56.79]],[\"parent/59\",[51,4.047]],[\"name/60\",[53,56.79]],[\"parent/60\",[51,4.047]],[\"name/61\",[54,56.79]],[\"parent/61\",[51,4.047]],[\"name/62\",[55,51.682]],[\"parent/62\",[51,4.047]],[\"name/63\",[49,37.331]],[\"parent/63\",[51,4.047]],[\"name/64\",[56,48.317]],[\"parent/64\",[0,2.345]],[\"name/65\",[2,27.001]],[\"parent/65\",[57,4.355]],[\"name/66\",[35,33.437]],[\"parent/66\",[57,4.355]],[\"name/67\",[58,56.79]],[\"parent/67\",[57,4.355]],[\"name/68\",[59,56.79]],[\"parent/68\",[57,4.355]],[\"name/69\",[49,37.331]],[\"parent/69\",[57,4.355]],[\"name/70\",[60,48.317]],[\"parent/70\",[0,2.345]],[\"name/71\",[2,27.001]],[\"parent/71\",[61,4.355]],[\"name/72\",[35,33.437]],[\"parent/72\",[61,4.355]],[\"name/73\",[62,56.79]],[\"parent/73\",[61,4.355]],[\"name/74\",[63,56.79]],[\"parent/74\",[61,4.355]],[\"name/75\",[49,37.331]],[\"parent/75\",[61,4.355]],[\"name/76\",[64,48.317]],[\"parent/76\",[0,2.345]],[\"name/77\",[2,27.001]],[\"parent/77\",[65,4.189]],[\"name/78\",[35,33.437]],[\"parent/78\",[65,4.189]],[\"name/79\",[66,56.79]],[\"parent/79\",[65,4.189]],[\"name/80\",[67,56.79]],[\"parent/80\",[65,4.189]],[\"name/81\",[68,56.79]],[\"parent/81\",[65,4.189]],[\"name/82\",[49,37.331]],[\"parent/82\",[65,4.189]],[\"name/83\",[69,48.317]],[\"parent/83\",[0,2.345]],[\"name/84\",[2,27.001]],[\"parent/84\",[70,4.047]],[\"name/85\",[35,33.437]],[\"parent/85\",[70,4.047]],[\"name/86\",[71,56.79]],[\"parent/86\",[70,4.047]],[\"name/87\",[72,56.79]],[\"parent/87\",[70,4.047]],[\"name/88\",[15,45.804]],[\"parent/88\",[70,4.047]],[\"name/89\",[73,56.79]],[\"parent/89\",[70,4.047]],[\"name/90\",[49,37.331]],[\"parent/90\",[70,4.047]],[\"name/91\",[74,48.317]],[\"parent/91\",[0,2.345]],[\"name/92\",[2,27.001]],[\"parent/92\",[75,4.355]],[\"name/93\",[35,33.437]],[\"parent/93\",[75,4.355]],[\"name/94\",[76,56.79]],[\"parent/94\",[75,4.355]],[\"name/95\",[77,56.79]],[\"parent/95\",[75,4.355]],[\"name/96\",[49,37.331]],[\"parent/96\",[75,4.355]],[\"name/97\",[78,48.317]],[\"parent/97\",[0,2.345]],[\"name/98\",[2,27.001]],[\"parent/98\",[79,4.355]],[\"name/99\",[35,33.437]],[\"parent/99\",[79,4.355]],[\"name/100\",[80,56.79]],[\"parent/100\",[79,4.355]],[\"name/101\",[81,56.79]],[\"parent/101\",[79,4.355]],[\"name/102\",[49,37.331]],[\"parent/102\",[79,4.355]],[\"name/103\",[82,48.317]],[\"parent/103\",[0,2.345]],[\"name/104\",[2,27.001]],[\"parent/104\",[83,4.355]],[\"name/105\",[35,33.437]],[\"parent/105\",[83,4.355]],[\"name/106\",[48,51.682]],[\"parent/106\",[83,4.355]],[\"name/107\",[26,45.804]],[\"parent/107\",[83,4.355]],[\"name/108\",[49,37.331]],[\"parent/108\",[83,4.355]],[\"name/109\",[84,48.317]],[\"parent/109\",[0,2.345]],[\"name/110\",[2,27.001]],[\"parent/110\",[85,3.922]],[\"name/111\",[35,33.437]],[\"parent/111\",[85,3.922]],[\"name/112\",[86,56.79]],[\"parent/112\",[85,3.922]],[\"name/113\",[87,56.79]],[\"parent/113\",[85,3.922]],[\"name/114\",[88,56.79]],[\"parent/114\",[85,3.922]],[\"name/115\",[89,56.79]],[\"parent/115\",[85,3.922]],[\"name/116\",[26,45.804]],[\"parent/116\",[85,3.922]],[\"name/117\",[49,37.331]],[\"parent/117\",[85,3.922]],[\"name/118\",[90,45.804]],[\"parent/118\",[0,2.345]],[\"name/119\",[2,27.001]],[\"parent/119\",[91,4.047]],[\"name/120\",[35,33.437]],[\"parent/120\",[91,4.047]],[\"name/121\",[92,56.79]],[\"parent/121\",[91,4.047]],[\"name/122\",[93,51.682]],[\"parent/122\",[91,4.047]],[\"name/123\",[94,51.682]],[\"parent/123\",[91,4.047]],[\"name/124\",[95,56.79]],[\"parent/124\",[91,4.047]],[\"name/125\",[45,40.696]],[\"parent/125\",[91,4.047]],[\"name/126\",[27,43.798]],[\"parent/126\",[0,2.345]],[\"name/127\",[2,27.001]],[\"parent/127\",[96,3.922]],[\"name/128\",[35,33.437]],[\"parent/128\",[96,3.922]],[\"name/129\",[97,56.79]],[\"parent/129\",[96,3.922]],[\"name/130\",[93,51.682]],[\"parent/130\",[96,3.922]],[\"name/131\",[98,56.79]],[\"parent/131\",[96,3.922]],[\"name/132\",[94,51.682]],[\"parent/132\",[96,3.922]],[\"name/133\",[99,51.682]],[\"parent/133\",[96,3.922]],[\"name/134\",[45,40.696]],[\"parent/134\",[96,3.922]],[\"name/135\",[100,48.317]],[\"parent/135\",[0,2.345]],[\"name/136\",[2,27.001]],[\"parent/136\",[101,3.712]],[\"name/137\",[35,33.437]],[\"parent/137\",[101,3.712]],[\"name/138\",[102,51.682]],[\"parent/138\",[101,3.712]],[\"name/139\",[103,51.682]],[\"parent/139\",[101,3.712]],[\"name/140\",[104,51.682]],[\"parent/140\",[101,3.712]],[\"name/141\",[105,51.682]],[\"parent/141\",[101,3.712]],[\"name/142\",[106,51.682]],[\"parent/142\",[101,3.712]],[\"name/143\",[107,51.682]],[\"parent/143\",[101,3.712]],[\"name/144\",[99,51.682]],[\"parent/144\",[101,3.712]],[\"name/145\",[45,40.696]],[\"parent/145\",[101,3.712]],[\"name/146\",[108,48.317]],[\"parent/146\",[0,2.345]],[\"name/147\",[2,27.001]],[\"parent/147\",[109,3.391]],[\"name/148\",[35,33.437]],[\"parent/148\",[109,3.391]],[\"name/149\",[110,56.79]],[\"parent/149\",[109,3.391]],[\"name/150\",[103,51.682]],[\"parent/150\",[109,3.391]],[\"name/151\",[111,56.79]],[\"parent/151\",[109,3.391]],[\"name/152\",[104,51.682]],[\"parent/152\",[109,3.391]],[\"name/153\",[112,56.79]],[\"parent/153\",[109,3.391]],[\"name/154\",[105,51.682]],[\"parent/154\",[109,3.391]],[\"name/155\",[106,51.682]],[\"parent/155\",[109,3.391]],[\"name/156\",[107,51.682]],[\"parent/156\",[109,3.391]],[\"name/157\",[113,56.79]],[\"parent/157\",[109,3.391]],[\"name/158\",[114,56.79]],[\"parent/158\",[109,3.391]],[\"name/159\",[102,51.682]],[\"parent/159\",[109,3.391]],[\"name/160\",[45,40.696]],[\"parent/160\",[109,3.391]],[\"name/161\",[115,51.682]],[\"parent/161\",[0,2.345]],[\"name/162\",[116,48.317]],[\"parent/162\",[117,4.555]],[\"name/163\",[118,56.79]],[\"parent/163\",[117,4.555]],[\"name/164\",[119,45.804]],[\"parent/164\",[117,4.555]],[\"name/165\",[120,48.317]],[\"parent/165\",[117,4.555]],[\"name/166\",[119,45.804]],[\"parent/166\",[0,2.345]],[\"name/167\",[2,27.001]],[\"parent/167\",[121,3.712]],[\"name/168\",[4,45.804]],[\"parent/168\",[121,3.712]],[\"name/169\",[5,45.804]],[\"parent/169\",[121,3.712]],[\"name/170\",[6,45.804]],[\"parent/170\",[121,3.712]],[\"name/171\",[7,45.804]],[\"parent/171\",[121,3.712]],[\"name/172\",[8,45.804]],[\"parent/172\",[121,3.712]],[\"name/173\",[122,51.682]],[\"parent/173\",[121,3.712]],[\"name/174\",[123,56.79]],[\"parent/174\",[121,3.712]],[\"name/175\",[10,45.804]],[\"parent/175\",[121,3.712]],[\"name/176\",[11,45.804]],[\"parent/176\",[121,3.712]],[\"name/177\",[116,48.317]],[\"parent/177\",[0,2.345]],[\"name/178\",[2,27.001]],[\"parent/178\",[124,3.539]],[\"name/179\",[4,45.804]],[\"parent/179\",[124,3.539]],[\"name/180\",[125,56.79]],[\"parent/180\",[124,3.539]],[\"name/181\",[126,56.79]],[\"parent/181\",[124,3.539]],[\"name/182\",[122,51.682]],[\"parent/182\",[124,3.539]],[\"name/183\",[127,51.682]],[\"parent/183\",[124,3.539]],[\"name/184\",[128,51.682]],[\"parent/184\",[124,3.539]],[\"name/185\",[129,56.79]],[\"parent/185\",[124,3.539]],[\"name/186\",[130,51.682]],[\"parent/186\",[124,3.539]],[\"name/187\",[131,51.682]],[\"parent/187\",[124,3.539]],[\"name/188\",[10,45.804]],[\"parent/188\",[124,3.539]],[\"name/189\",[11,45.804]],[\"parent/189\",[124,3.539]],[\"name/190\",[132,48.317]],[\"parent/190\",[0,2.345]],[\"name/191\",[2,27.001]],[\"parent/191\",[133,4.047]],[\"name/192\",[134,45.804]],[\"parent/192\",[133,4.047]],[\"name/193\",[135,51.682]],[\"parent/193\",[133,4.047]],[\"name/194\",[136,51.682]],[\"parent/194\",[133,4.047]],[\"name/195\",[137,45.804]],[\"parent/195\",[133,4.047]],[\"name/196\",[138,56.79]],[\"parent/196\",[133,4.047]],[\"name/197\",[1,48.317]],[\"parent/197\",[133,4.047]],[\"name/198\",[139,51.682]],[\"parent/198\",[0,2.345]],[\"name/199\",[2,27.001]],[\"parent/199\",[140,3.149]],[\"name/200\",[14,48.317]],[\"parent/200\",[140,3.149]],[\"name/201\",[15,45.804]],[\"parent/201\",[140,3.149]],[\"name/202\",[16,48.317]],[\"parent/202\",[140,3.149]],[\"name/203\",[17,48.317]],[\"parent/203\",[140,3.149]],[\"name/204\",[18,48.317]],[\"parent/204\",[140,3.149]],[\"name/205\",[141,56.79]],[\"parent/205\",[140,3.149]],[\"name/206\",[21,51.682]],[\"parent/206\",[140,3.149]],[\"name/207\",[22,51.682]],[\"parent/207\",[140,3.149]],[\"name/208\",[23,48.317]],[\"parent/208\",[140,3.149]],[\"name/209\",[45,40.696]],[\"parent/209\",[140,3.149]],[\"name/210\",[33,48.317]],[\"parent/210\",[140,3.149]],[\"name/211\",[46,48.317]],[\"parent/211\",[140,3.149]],[\"name/212\",[90,45.804]],[\"parent/212\",[140,3.149]],[\"name/213\",[27,43.798]],[\"parent/213\",[140,3.149]],[\"name/214\",[108,48.317]],[\"parent/214\",[140,3.149]],[\"name/215\",[100,48.317]],[\"parent/215\",[140,3.149]],[\"name/216\",[28,48.317]],[\"parent/216\",[140,3.149]],[\"name/217\",[137,45.804]],[\"parent/217\",[0,2.345]],[\"name/218\",[2,27.001]],[\"parent/218\",[142,4.047]],[\"name/219\",[31,51.682]],[\"parent/219\",[142,4.047]],[\"name/220\",[32,51.682]],[\"parent/220\",[142,4.047]],[\"name/221\",[5,45.804]],[\"parent/221\",[142,4.047]],[\"name/222\",[6,45.804]],[\"parent/222\",[142,4.047]],[\"name/223\",[7,45.804]],[\"parent/223\",[142,4.047]],[\"name/224\",[8,45.804]],[\"parent/224\",[142,4.047]],[\"name/225\",[134,45.804]],[\"parent/225\",[0,2.345]],[\"name/226\",[2,27.001]],[\"parent/226\",[143,3.812]],[\"name/227\",[144,56.79]],[\"parent/227\",[143,3.812]],[\"name/228\",[145,56.79]],[\"parent/228\",[143,3.812]],[\"name/229\",[146,56.79]],[\"parent/229\",[143,3.812]],[\"name/230\",[147,56.79]],[\"parent/230\",[143,3.812]],[\"name/231\",[148,56.79]],[\"parent/231\",[143,3.812]],[\"name/232\",[149,56.79]],[\"parent/232\",[143,3.812]],[\"name/233\",[150,56.79]],[\"parent/233\",[143,3.812]],[\"name/234\",[151,56.79]],[\"parent/234\",[143,3.812]],[\"name/235\",[152,51.682]],[\"parent/235\",[0,2.345]],[\"name/236\",[2,27.001]],[\"parent/236\",[153,5.139]],[\"name/237\",[154,51.682]],[\"parent/237\",[153,5.139]],[\"name/238\",[155,51.682]],[\"parent/238\",[0,2.345]],[\"name/239\",[2,27.001]],[\"parent/239\",[156,4.555]],[\"name/240\",[157,48.317]],[\"parent/240\",[156,4.555]],[\"name/241\",[158,56.79]],[\"parent/241\",[156,4.555]],[\"name/242\",[119,45.804]],[\"parent/242\",[156,4.555]],[\"name/243\",[157,48.317]],[\"parent/243\",[0,2.345]],[\"name/244\",[2,27.001]],[\"parent/244\",[159,3.263]],[\"name/245\",[4,45.804]],[\"parent/245\",[159,3.263]],[\"name/246\",[160,56.79]],[\"parent/246\",[159,3.263]],[\"name/247\",[161,56.79]],[\"parent/247\",[159,3.263]],[\"name/248\",[162,56.79]],[\"parent/248\",[159,3.263]],[\"name/249\",[163,56.79]],[\"parent/249\",[159,3.263]],[\"name/250\",[164,56.79]],[\"parent/250\",[159,3.263]],[\"name/251\",[165,56.79]],[\"parent/251\",[159,3.263]],[\"name/252\",[127,51.682]],[\"parent/252\",[159,3.263]],[\"name/253\",[128,51.682]],[\"parent/253\",[159,3.263]],[\"name/254\",[166,56.79]],[\"parent/254\",[159,3.263]],[\"name/255\",[167,56.79]],[\"parent/255\",[159,3.263]],[\"name/256\",[130,51.682]],[\"parent/256\",[159,3.263]],[\"name/257\",[131,51.682]],[\"parent/257\",[159,3.263]],[\"name/258\",[10,45.804]],[\"parent/258\",[159,3.263]],[\"name/259\",[11,45.804]],[\"parent/259\",[159,3.263]],[\"name/260\",[168,51.682]],[\"parent/260\",[0,2.345]],[\"name/261\",[2,27.001]],[\"parent/261\",[169,2.911]],[\"name/262\",[14,48.317]],[\"parent/262\",[169,2.911]],[\"name/263\",[15,45.804]],[\"parent/263\",[169,2.911]],[\"name/264\",[16,48.317]],[\"parent/264\",[169,2.911]],[\"name/265\",[170,56.79]],[\"parent/265\",[169,2.911]],[\"name/266\",[18,48.317]],[\"parent/266\",[169,2.911]],[\"name/267\",[17,48.317]],[\"parent/267\",[169,2.911]],[\"name/268\",[171,56.79]],[\"parent/268\",[169,2.911]],[\"name/269\",[172,56.79]],[\"parent/269\",[169,2.911]],[\"name/270\",[23,48.317]],[\"parent/270\",[169,2.911]],[\"name/271\",[45,40.696]],[\"parent/271\",[169,2.911]],[\"name/272\",[50,48.317]],[\"parent/272\",[169,2.911]],[\"name/273\",[56,48.317]],[\"parent/273\",[169,2.911]],[\"name/274\",[60,48.317]],[\"parent/274\",[169,2.911]],[\"name/275\",[64,48.317]],[\"parent/275\",[169,2.911]],[\"name/276\",[69,48.317]],[\"parent/276\",[169,2.911]],[\"name/277\",[74,48.317]],[\"parent/277\",[169,2.911]],[\"name/278\",[78,48.317]],[\"parent/278\",[169,2.911]],[\"name/279\",[82,48.317]],[\"parent/279\",[169,2.911]],[\"name/280\",[84,48.317]],[\"parent/280\",[169,2.911]],[\"name/281\",[90,45.804]],[\"parent/281\",[169,2.911]],[\"name/282\",[27,43.798]],[\"parent/282\",[169,2.911]],[\"name/283\",[28,48.317]],[\"parent/283\",[169,2.911]],[\"name/284\",[173,51.682]],[\"parent/284\",[0,2.345]],[\"name/285\",[154,51.682]],[\"parent/285\",[174,5.647]],[\"name/286\",[175,51.682]],[\"parent/286\",[0,2.345]],[\"name/287\",[2,27.001]],[\"parent/287\",[176,3.922]],[\"name/288\",[134,45.804]],[\"parent/288\",[176,3.922]],[\"name/289\",[135,51.682]],[\"parent/289\",[176,3.922]],[\"name/290\",[136,51.682]],[\"parent/290\",[176,3.922]],[\"name/291\",[137,45.804]],[\"parent/291\",[176,3.922]],[\"name/292\",[177,56.79]],[\"parent/292\",[176,3.922]],[\"name/293\",[178,56.79]],[\"parent/293\",[176,3.922]],[\"name/294\",[179,56.79]],[\"parent/294\",[176,3.922]],[\"name/295\",[120,48.317]],[\"parent/295\",[0,2.345]],[\"name/296\",[180,56.79]],[\"parent/296\",[181,4.555]],[\"name/297\",[182,56.79]],[\"parent/297\",[181,4.555]],[\"name/298\",[183,56.79]],[\"parent/298\",[181,4.555]],[\"name/299\",[184,56.79]],[\"parent/299\",[181,4.555]],[\"name/300\",[185,48.317]],[\"parent/300\",[0,2.345]],[\"name/301\",[186,45.804]],[\"parent/301\",[187,5.647]],[\"name/302\",[188,56.79]],[\"parent/302\",[189,5.139]],[\"name/303\",[190,56.79]],[\"parent/303\",[189,5.139]],[\"name/304\",[185,48.317]],[\"parent/304\",[0,2.345]],[\"name/305\",[191,51.682]],[\"parent/305\",[0,2.345]],[\"name/306\",[192,56.79]],[\"parent/306\",[193,5.139]],[\"name/307\",[194,56.79]],[\"parent/307\",[193,5.139]],[\"name/308\",[195,51.682]],[\"parent/308\",[0,2.345]],[\"name/309\",[196,56.79]],[\"parent/309\",[197,4.804]],[\"name/310\",[198,56.79]],[\"parent/310\",[197,4.804]],[\"name/311\",[199,56.79]],[\"parent/311\",[197,4.804]],[\"name/312\",[200,51.682]],[\"parent/312\",[0,2.345]],[\"name/313\",[201,51.682]],[\"parent/313\",[0,2.345]],[\"name/314\",[202,51.682]],[\"parent/314\",[0,2.345]],[\"name/315\",[203,51.682]],[\"parent/315\",[0,2.345]],[\"name/316\",[204,45.804]],[\"parent/316\",[205,3.096]],[\"name/317\",[206,56.79]],[\"parent/317\",[205,3.096]],[\"name/318\",[207,56.79]],[\"parent/318\",[205,3.096]],[\"name/319\",[208,56.79]],[\"parent/319\",[205,3.096]],[\"name/320\",[132,48.317]],[\"parent/320\",[205,3.096]],[\"name/321\",[209,56.79]],[\"parent/321\",[205,3.096]],[\"name/322\",[210,56.79]],[\"parent/322\",[205,3.096]],[\"name/323\",[211,56.79]],[\"parent/323\",[205,3.096]],[\"name/324\",[212,56.79]],[\"parent/324\",[205,3.096]],[\"name/325\",[213,56.79]],[\"parent/325\",[205,3.096]],[\"name/326\",[214,56.79]],[\"parent/326\",[205,3.096]],[\"name/327\",[215,56.79]],[\"parent/327\",[205,3.096]],[\"name/328\",[216,56.79]],[\"parent/328\",[205,3.096]],[\"name/329\",[217,56.79]],[\"parent/329\",[205,3.096]],[\"name/330\",[218,56.79]],[\"parent/330\",[205,3.096]],[\"name/331\",[219,56.79]],[\"parent/331\",[205,3.096]],[\"name/332\",[220,40.696]],[\"parent/332\",[205,3.096]],[\"name/333\",[221,45.804]],[\"parent/333\",[205,3.096]],[\"name/334\",[222,51.682]],[\"parent/334\",[205,3.096]],[\"name/335\",[223,42.127]],[\"parent/335\",[]],[\"name/336\",[224,56.79]],[\"parent/336\",[223,4.189]],[\"name/337\",[225,56.79]],[\"parent/337\",[223,4.189]],[\"name/338\",[186,45.804]],[\"parent/338\",[226,5.647]],[\"name/339\",[227,56.79]],[\"parent/339\",[228,4.555]],[\"name/340\",[229,56.79]],[\"parent/340\",[228,4.555]],[\"name/341\",[230,56.79]],[\"parent/341\",[228,4.555]],[\"name/342\",[231,56.79]],[\"parent/342\",[228,4.555]],[\"name/343\",[232,56.79]],[\"parent/343\",[223,4.189]],[\"name/344\",[233,42.127]],[\"parent/344\",[234,5.139]],[\"name/345\",[235,56.79]],[\"parent/345\",[234,5.139]],[\"name/346\",[236,56.79]],[\"parent/346\",[223,4.189]],[\"name/347\",[204,45.804]],[\"parent/347\",[237,4.555]],[\"name/348\",[220,40.696]],[\"parent/348\",[237,4.555]],[\"name/349\",[221,45.804]],[\"parent/349\",[237,4.555]],[\"name/350\",[222,51.682]],[\"parent/350\",[237,4.555]],[\"name/351\",[238,56.79]],[\"parent/351\",[223,4.189]],[\"name/352\",[204,45.804]],[\"parent/352\",[239,4.804]],[\"name/353\",[55,51.682]],[\"parent/353\",[239,4.804]],[\"name/354\",[240,56.79]],[\"parent/354\",[239,4.804]],[\"name/355\",[241,36.422]],[\"parent/355\",[]],[\"name/356\",[242,56.79]],[\"parent/356\",[241,3.622]],[\"name/357\",[243,56.79]],[\"parent/357\",[241,3.622]],[\"name/358\",[244,56.79]],[\"parent/358\",[241,3.622]],[\"name/359\",[245,56.79]],[\"parent/359\",[241,3.622]],[\"name/360\",[246,56.79]],[\"parent/360\",[241,3.622]],[\"name/361\",[247,56.79]],[\"parent/361\",[241,3.622]],[\"name/362\",[248,56.79]],[\"parent/362\",[241,3.622]],[\"name/363\",[249,56.79]],[\"parent/363\",[241,3.622]],[\"name/364\",[250,56.79]],[\"parent/364\",[241,3.622]],[\"name/365\",[251,56.79]],[\"parent/365\",[241,3.622]],[\"name/366\",[220,40.696]],[\"parent/366\",[]],[\"name/367\",[252,51.682]],[\"parent/367\",[220,4.047]],[\"name/368\",[253,51.682]],[\"parent/368\",[254,3.922]],[\"name/369\",[255,51.682]],[\"parent/369\",[254,3.922]],[\"name/370\",[256,51.682]],[\"parent/370\",[254,3.922]],[\"name/371\",[257,51.682]],[\"parent/371\",[254,3.922]],[\"name/372\",[221,45.804]],[\"parent/372\",[254,3.922]],[\"name/373\",[258,51.682]],[\"parent/373\",[254,3.922]],[\"name/374\",[259,51.682]],[\"parent/374\",[254,3.922]],[\"name/375\",[186,45.804]],[\"parent/375\",[254,3.922]],[\"name/376\",[220,40.696]],[\"parent/376\",[220,4.047]],[\"name/377\",[204,45.804]],[\"parent/377\",[260,3.712]],[\"name/378\",[253,51.682]],[\"parent/378\",[260,3.712]],[\"name/379\",[255,51.682]],[\"parent/379\",[260,3.712]],[\"name/380\",[256,51.682]],[\"parent/380\",[260,3.712]],[\"name/381\",[257,51.682]],[\"parent/381\",[260,3.712]],[\"name/382\",[221,45.804]],[\"parent/382\",[260,3.712]],[\"name/383\",[258,51.682]],[\"parent/383\",[260,3.712]],[\"name/384\",[259,51.682]],[\"parent/384\",[260,3.712]],[\"name/385\",[186,45.804]],[\"parent/385\",[260,3.712]],[\"name/386\",[261,56.79]],[\"parent/386\",[260,3.712]],[\"name/387\",[262,23.35]],[\"parent/387\",[]],[\"name/388\",[233,42.127]],[\"parent/388\",[]],[\"name/389\",[263,56.79]],[\"parent/389\",[233,4.189]],[\"name/390\",[264,56.79]],[\"parent/390\",[233,4.189]],[\"name/391\",[233,42.127]],[\"parent/391\",[233,4.189]],[\"name/392\",[265,56.79]],[\"parent/392\",[266,4.355]],[\"name/393\",[267,56.79]],[\"parent/393\",[266,4.355]],[\"name/394\",[268,56.79]],[\"parent/394\",[266,4.355]],[\"name/395\",[269,56.79]],[\"parent/395\",[266,4.355]],[\"name/396\",[270,56.79]],[\"parent/396\",[266,4.355]],[\"name/397\",[1,48.317]],[\"parent/397\",[262,2.322]],[\"name/398\",[12,51.682]],[\"parent/398\",[262,2.322]],[\"name/399\",[29,51.682]],[\"parent/399\",[262,2.322]],[\"name/400\",[33,48.317]],[\"parent/400\",[262,2.322]],[\"name/401\",[46,48.317]],[\"parent/401\",[262,2.322]],[\"name/402\",[50,48.317]],[\"parent/402\",[262,2.322]],[\"name/403\",[56,48.317]],[\"parent/403\",[262,2.322]],[\"name/404\",[60,48.317]],[\"parent/404\",[262,2.322]],[\"name/405\",[64,48.317]],[\"parent/405\",[262,2.322]],[\"name/406\",[69,48.317]],[\"parent/406\",[262,2.322]],[\"name/407\",[74,48.317]],[\"parent/407\",[262,2.322]],[\"name/408\",[78,48.317]],[\"parent/408\",[262,2.322]],[\"name/409\",[82,48.317]],[\"parent/409\",[262,2.322]],[\"name/410\",[84,48.317]],[\"parent/410\",[262,2.322]],[\"name/411\",[90,45.804]],[\"parent/411\",[262,2.322]],[\"name/412\",[27,43.798]],[\"parent/412\",[262,2.322]],[\"name/413\",[100,48.317]],[\"parent/413\",[262,2.322]],[\"name/414\",[108,48.317]],[\"parent/414\",[262,2.322]],[\"name/415\",[115,51.682]],[\"parent/415\",[262,2.322]],[\"name/416\",[119,45.804]],[\"parent/416\",[262,2.322]],[\"name/417\",[116,48.317]],[\"parent/417\",[262,2.322]],[\"name/418\",[132,48.317]],[\"parent/418\",[262,2.322]],[\"name/419\",[139,51.682]],[\"parent/419\",[262,2.322]],[\"name/420\",[137,45.804]],[\"parent/420\",[262,2.322]],[\"name/421\",[134,45.804]],[\"parent/421\",[262,2.322]],[\"name/422\",[152,51.682]],[\"parent/422\",[262,2.322]],[\"name/423\",[155,51.682]],[\"parent/423\",[262,2.322]],[\"name/424\",[157,48.317]],[\"parent/424\",[262,2.322]],[\"name/425\",[168,51.682]],[\"parent/425\",[262,2.322]],[\"name/426\",[173,51.682]],[\"parent/426\",[262,2.322]],[\"name/427\",[175,51.682]],[\"parent/427\",[262,2.322]],[\"name/428\",[120,48.317]],[\"parent/428\",[262,2.322]],[\"name/429\",[185,48.317]],[\"parent/429\",[262,2.322]],[\"name/430\",[191,51.682]],[\"parent/430\",[262,2.322]],[\"name/431\",[195,51.682]],[\"parent/431\",[262,2.322]],[\"name/432\",[200,51.682]],[\"parent/432\",[262,2.322]],[\"name/433\",[201,51.682]],[\"parent/433\",[262,2.322]],[\"name/434\",[202,51.682]],[\"parent/434\",[262,2.322]],[\"name/435\",[203,51.682]],[\"parent/435\",[262,2.322]],[\"name/436\",[252,51.682]],[\"parent/436\",[262,2.322]],[\"name/437\",[220,40.696]],[\"parent/437\",[262,2.322]]],\"invertedIndex\":[[\"__type\",{\"_index\":186,\"name\":{\"301\":{},\"338\":{},\"375\":{},\"385\":{}},\"parent\":{}}],[\"accesstoken\",{\"_index\":257,\"name\":{\"371\":{},\"381\":{}},\"parent\":{}}],[\"accountnumber\",{\"_index\":182,\"name\":{\"297\":{}},\"parent\":{}}],[\"accounttype\",{\"_index\":183,\"name\":{\"298\":{}},\"parent\":{}}],[\"achfilesapi\",{\"_index\":203,\"name\":{\"315\":{},\"435\":{}},\"parent\":{}}],[\"achfilesapiaxiosparamcreator\",{\"_index\":200,\"name\":{\"312\":{},\"432\":{}},\"parent\":{}}],[\"achfilesapifactory\",{\"_index\":202,\"name\":{\"314\":{},\"434\":{}},\"parent\":{}}],[\"achfilesapifp\",{\"_index\":201,\"name\":{\"313\":{},\"433\":{}},\"parent\":{}}],[\"achoperatordata\",{\"_index\":9,\"name\":{\"8\":{},\"20\":{}},\"parent\":{}}],[\"achoperatorroutingnumber\",{\"_index\":24,\"name\":{\"24\":{}},\"parent\":{}}],[\"addbatchtofile\",{\"_index\":206,\"name\":{\"317\":{}},\"parent\":{}}],[\"addenda02\",{\"_index\":33,\"name\":{\"37\":{},\"210\":{},\"400\":{}},\"parent\":{}}],[\"addenda05\",{\"_index\":46,\"name\":{\"50\":{},\"211\":{},\"401\":{}},\"parent\":{}}],[\"addenda10\",{\"_index\":50,\"name\":{\"56\":{},\"272\":{},\"402\":{}},\"parent\":{}}],[\"addenda11\",{\"_index\":56,\"name\":{\"64\":{},\"273\":{},\"403\":{}},\"parent\":{}}],[\"addenda12\",{\"_index\":60,\"name\":{\"70\":{},\"274\":{},\"404\":{}},\"parent\":{}}],[\"addenda13\",{\"_index\":64,\"name\":{\"76\":{},\"275\":{},\"405\":{}},\"parent\":{}}],[\"addenda14\",{\"_index\":69,\"name\":{\"83\":{},\"276\":{},\"406\":{}},\"parent\":{}}],[\"addenda15\",{\"_index\":74,\"name\":{\"91\":{},\"277\":{},\"407\":{}},\"parent\":{}}],[\"addenda16\",{\"_index\":78,\"name\":{\"97\":{},\"278\":{},\"408\":{}},\"parent\":{}}],[\"addenda17\",{\"_index\":82,\"name\":{\"103\":{},\"279\":{},\"409\":{}},\"parent\":{}}],[\"addenda18\",{\"_index\":84,\"name\":{\"109\":{},\"280\":{},\"410\":{}},\"parent\":{}}],[\"addenda98\",{\"_index\":90,\"name\":{\"118\":{},\"212\":{},\"281\":{},\"411\":{}},\"parent\":{}}],[\"addenda99\",{\"_index\":27,\"name\":{\"27\":{},\"126\":{},\"213\":{},\"282\":{},\"412\":{}},\"parent\":{}}],[\"addenda99contested\",{\"_index\":100,\"name\":{\"135\":{},\"215\":{},\"413\":{}},\"parent\":{}}],[\"addenda99dishonored\",{\"_index\":108,\"name\":{\"146\":{},\"214\":{},\"414\":{}},\"parent\":{}}],[\"addendainformation\",{\"_index\":99,\"name\":{\"133\":{},\"144\":{}},\"parent\":{}}],[\"addendarecordindicator\",{\"_index\":23,\"name\":{\"23\":{},\"208\":{},\"270\":{}},\"parent\":{}}],[\"addendarecords\",{\"_index\":170,\"name\":{\"265\":{}},\"parent\":{}}],[\"advbatchcontrol\",{\"_index\":1,\"name\":{\"1\":{},\"197\":{},\"397\":{}},\"parent\":{}}],[\"adventrydetail\",{\"_index\":12,\"name\":{\"11\":{},\"398\":{}},\"parent\":{}}],[\"adventrydetails\",{\"_index\":138,\"name\":{\"196\":{}},\"parent\":{}}],[\"advfilecontrol\",{\"_index\":29,\"name\":{\"29\":{},\"399\":{}},\"parent\":{}}],[\"adviceroutingnumber\",{\"_index\":19,\"name\":{\"18\":{}},\"parent\":{}}],[\"amount\",{\"_index\":18,\"name\":{\"17\":{},\"204\":{},\"266\":{}},\"parent\":{}}],[\"api\",{\"_index\":0,\"name\":{\"0\":{}},\"parent\":{\"1\":{},\"11\":{},\"29\":{},\"37\":{},\"50\":{},\"56\":{},\"64\":{},\"70\":{},\"76\":{},\"83\":{},\"91\":{},\"97\":{},\"103\":{},\"109\":{},\"118\":{},\"126\":{},\"135\":{},\"146\":{},\"161\":{},\"166\":{},\"177\":{},\"190\":{},\"198\":{},\"217\":{},\"225\":{},\"235\":{},\"238\":{},\"243\":{},\"260\":{},\"284\":{},\"286\":{},\"295\":{},\"300\":{},\"304\":{},\"305\":{},\"308\":{},\"312\":{},\"313\":{},\"314\":{},\"315\":{}}}],[\"api.achfilesapi\",{\"_index\":205,\"name\":{},\"parent\":{\"316\":{},\"317\":{},\"318\":{},\"319\":{},\"320\":{},\"321\":{},\"322\":{},\"323\":{},\"324\":{},\"325\":{},\"326\":{},\"327\":{},\"328\":{},\"329\":{},\"330\":{},\"331\":{},\"332\":{},\"333\":{},\"334\":{}}}],[\"api.addenda02\",{\"_index\":34,\"name\":{},\"parent\":{\"38\":{},\"39\":{},\"40\":{},\"41\":{},\"42\":{},\"43\":{},\"44\":{},\"45\":{},\"46\":{},\"47\":{},\"48\":{},\"49\":{}}}],[\"api.addenda05\",{\"_index\":47,\"name\":{},\"parent\":{\"51\":{},\"52\":{},\"53\":{},\"54\":{},\"55\":{}}}],[\"api.addenda10\",{\"_index\":51,\"name\":{},\"parent\":{\"57\":{},\"58\":{},\"59\":{},\"60\":{},\"61\":{},\"62\":{},\"63\":{}}}],[\"api.addenda11\",{\"_index\":57,\"name\":{},\"parent\":{\"65\":{},\"66\":{},\"67\":{},\"68\":{},\"69\":{}}}],[\"api.addenda12\",{\"_index\":61,\"name\":{},\"parent\":{\"71\":{},\"72\":{},\"73\":{},\"74\":{},\"75\":{}}}],[\"api.addenda13\",{\"_index\":65,\"name\":{},\"parent\":{\"77\":{},\"78\":{},\"79\":{},\"80\":{},\"81\":{},\"82\":{}}}],[\"api.addenda14\",{\"_index\":70,\"name\":{},\"parent\":{\"84\":{},\"85\":{},\"86\":{},\"87\":{},\"88\":{},\"89\":{},\"90\":{}}}],[\"api.addenda15\",{\"_index\":75,\"name\":{},\"parent\":{\"92\":{},\"93\":{},\"94\":{},\"95\":{},\"96\":{}}}],[\"api.addenda16\",{\"_index\":79,\"name\":{},\"parent\":{\"98\":{},\"99\":{},\"100\":{},\"101\":{},\"102\":{}}}],[\"api.addenda17\",{\"_index\":83,\"name\":{},\"parent\":{\"104\":{},\"105\":{},\"106\":{},\"107\":{},\"108\":{}}}],[\"api.addenda18\",{\"_index\":85,\"name\":{},\"parent\":{\"110\":{},\"111\":{},\"112\":{},\"113\":{},\"114\":{},\"115\":{},\"116\":{},\"117\":{}}}],[\"api.addenda98\",{\"_index\":91,\"name\":{},\"parent\":{\"119\":{},\"120\":{},\"121\":{},\"122\":{},\"123\":{},\"124\":{},\"125\":{}}}],[\"api.addenda99\",{\"_index\":96,\"name\":{},\"parent\":{\"127\":{},\"128\":{},\"129\":{},\"130\":{},\"131\":{},\"132\":{},\"133\":{},\"134\":{}}}],[\"api.addenda99contested\",{\"_index\":101,\"name\":{},\"parent\":{\"136\":{},\"137\":{},\"138\":{},\"139\":{},\"140\":{},\"141\":{},\"142\":{},\"143\":{},\"144\":{},\"145\":{}}}],[\"api.addenda99dishonored\",{\"_index\":109,\"name\":{},\"parent\":{\"147\":{},\"148\":{},\"149\":{},\"150\":{},\"151\":{},\"152\":{},\"153\":{},\"154\":{},\"155\":{},\"156\":{},\"157\":{},\"158\":{},\"159\":{},\"160\":{}}}],[\"api.advbatchcontrol\",{\"_index\":3,\"name\":{},\"parent\":{\"2\":{},\"3\":{},\"4\":{},\"5\":{},\"6\":{},\"7\":{},\"8\":{},\"9\":{},\"10\":{}}}],[\"api.adventrydetail\",{\"_index\":13,\"name\":{},\"parent\":{\"12\":{},\"13\":{},\"14\":{},\"15\":{},\"16\":{},\"17\":{},\"18\":{},\"19\":{},\"20\":{},\"21\":{},\"22\":{},\"23\":{},\"24\":{},\"25\":{},\"26\":{},\"27\":{},\"28\":{}}}],[\"api.advfilecontrol\",{\"_index\":30,\"name\":{},\"parent\":{\"30\":{},\"31\":{},\"32\":{},\"33\":{},\"34\":{},\"35\":{},\"36\":{}}}],[\"api.batch\",{\"_index\":117,\"name\":{},\"parent\":{\"162\":{},\"163\":{},\"164\":{},\"165\":{}}}],[\"api.batchcontrol\",{\"_index\":121,\"name\":{},\"parent\":{\"167\":{},\"168\":{},\"169\":{},\"170\":{},\"171\":{},\"172\":{},\"173\":{},\"174\":{},\"175\":{},\"176\":{}}}],[\"api.batchheader\",{\"_index\":124,\"name\":{},\"parent\":{\"178\":{},\"179\":{},\"180\":{},\"181\":{},\"182\":{},\"183\":{},\"184\":{},\"185\":{},\"186\":{},\"187\":{},\"188\":{},\"189\":{}}}],[\"api.createfile\",{\"_index\":133,\"name\":{},\"parent\":{\"191\":{},\"192\":{},\"193\":{},\"194\":{},\"195\":{},\"196\":{},\"197\":{}}}],[\"api.entrydetail\",{\"_index\":140,\"name\":{},\"parent\":{\"199\":{},\"200\":{},\"201\":{},\"202\":{},\"203\":{},\"204\":{},\"205\":{},\"206\":{},\"207\":{},\"208\":{},\"209\":{},\"210\":{},\"211\":{},\"212\":{},\"213\":{},\"214\":{},\"215\":{},\"216\":{}}}],[\"api.filecontrol\",{\"_index\":142,\"name\":{},\"parent\":{\"218\":{},\"219\":{},\"220\":{},\"221\":{},\"222\":{},\"223\":{},\"224\":{}}}],[\"api.fileheader\",{\"_index\":143,\"name\":{},\"parent\":{\"226\":{},\"227\":{},\"228\":{},\"229\":{},\"230\":{},\"231\":{},\"232\":{},\"233\":{},\"234\":{}}}],[\"api.fileid\",{\"_index\":153,\"name\":{},\"parent\":{\"236\":{},\"237\":{}}}],[\"api.iatbatch\",{\"_index\":156,\"name\":{},\"parent\":{\"239\":{},\"240\":{},\"241\":{},\"242\":{}}}],[\"api.iatbatchheader\",{\"_index\":159,\"name\":{},\"parent\":{\"244\":{},\"245\":{},\"246\":{},\"247\":{},\"248\":{},\"249\":{},\"250\":{},\"251\":{},\"252\":{},\"253\":{},\"254\":{},\"255\":{},\"256\":{},\"257\":{},\"258\":{},\"259\":{}}}],[\"api.iatentrydetail\",{\"_index\":169,\"name\":{},\"parent\":{\"261\":{},\"262\":{},\"263\":{},\"264\":{},\"265\":{},\"266\":{},\"267\":{},\"268\":{},\"269\":{},\"270\":{},\"271\":{},\"272\":{},\"273\":{},\"274\":{},\"275\":{},\"276\":{},\"277\":{},\"278\":{},\"279\":{},\"280\":{},\"281\":{},\"282\":{},\"283\":{}}}],[\"api.modelerror\",{\"_index\":174,\"name\":{},\"parent\":{\"285\":{}}}],[\"api.modelfile\",{\"_index\":176,\"name\":{},\"parent\":{\"287\":{},\"288\":{},\"289\":{},\"290\":{},\"291\":{},\"292\":{},\"293\":{},\"294\":{}}}],[\"api.offset\",{\"_index\":181,\"name\":{},\"parent\":{\"296\":{},\"297\":{},\"298\":{},\"299\":{}}}],[\"api.offsetaccounttypeenum\",{\"_index\":187,\"name\":{},\"parent\":{\"301\":{}}}],[\"api.offsetaccounttypeenum.__type\",{\"_index\":189,\"name\":{},\"parent\":{\"302\":{},\"303\":{}}}],[\"api.segmentedfiles\",{\"_index\":193,\"name\":{},\"parent\":{\"306\":{},\"307\":{}}}],[\"api.validateopts\",{\"_index\":197,\"name\":{},\"parent\":{\"309\":{},\"310\":{},\"311\":{}}}],[\"apikey\",{\"_index\":253,\"name\":{\"368\":{},\"378\":{}},\"parent\":{}}],[\"assertparamexists\",{\"_index\":243,\"name\":{\"357\":{}},\"parent\":{}}],[\"authorizationcodeorexpiredate\",{\"_index\":41,\"name\":{\"45\":{}},\"parent\":{}}],[\"axios\",{\"_index\":222,\"name\":{\"334\":{},\"350\":{}},\"parent\":{}}],[\"base\",{\"_index\":223,\"name\":{\"335\":{}},\"parent\":{\"336\":{},\"337\":{},\"343\":{},\"346\":{},\"351\":{}}}],[\"base.baseapi\",{\"_index\":237,\"name\":{},\"parent\":{\"347\":{},\"348\":{},\"349\":{},\"350\":{}}}],[\"base.collection_formats\",{\"_index\":226,\"name\":{},\"parent\":{\"338\":{}}}],[\"base.collection_formats.__type\",{\"_index\":228,\"name\":{},\"parent\":{\"339\":{},\"340\":{},\"341\":{},\"342\":{}}}],[\"base.requestargs\",{\"_index\":234,\"name\":{},\"parent\":{\"344\":{},\"345\":{}}}],[\"base.requirederror\",{\"_index\":239,\"name\":{},\"parent\":{\"352\":{},\"353\":{},\"354\":{}}}],[\"base_path\",{\"_index\":224,\"name\":{\"336\":{}},\"parent\":{}}],[\"baseapi\",{\"_index\":236,\"name\":{\"346\":{}},\"parent\":{}}],[\"baseoptions\",{\"_index\":258,\"name\":{\"373\":{},\"383\":{}},\"parent\":{}}],[\"basepath\",{\"_index\":221,\"name\":{\"333\":{},\"349\":{},\"372\":{},\"382\":{}},\"parent\":{}}],[\"batch\",{\"_index\":115,\"name\":{\"161\":{},\"415\":{}},\"parent\":{}}],[\"batchcontrol\",{\"_index\":119,\"name\":{\"164\":{},\"166\":{},\"242\":{},\"416\":{}},\"parent\":{}}],[\"batchcount\",{\"_index\":31,\"name\":{\"31\":{},\"219\":{}},\"parent\":{}}],[\"batches\",{\"_index\":135,\"name\":{\"193\":{},\"289\":{}},\"parent\":{}}],[\"batchheader\",{\"_index\":116,\"name\":{\"162\":{},\"177\":{},\"417\":{}},\"parent\":{}}],[\"batchnumber\",{\"_index\":11,\"name\":{\"10\":{},\"176\":{},\"189\":{},\"259\":{}},\"parent\":{}}],[\"blockcount\",{\"_index\":32,\"name\":{\"32\":{},\"220\":{}},\"parent\":{}}],[\"buildfile\",{\"_index\":207,\"name\":{\"318\":{}},\"parent\":{}}],[\"bypassdestinationvalidation\",{\"_index\":199,\"name\":{\"311\":{}},\"parent\":{}}],[\"bypassoriginvalidation\",{\"_index\":198,\"name\":{\"310\":{}},\"parent\":{}}],[\"category\",{\"_index\":28,\"name\":{\"28\":{},\"216\":{},\"283\":{}},\"parent\":{}}],[\"changecode\",{\"_index\":92,\"name\":{\"121\":{}},\"parent\":{}}],[\"checkdigit\",{\"_index\":16,\"name\":{\"15\":{},\"202\":{},\"264\":{}},\"parent\":{}}],[\"checkfile\",{\"_index\":208,\"name\":{\"319\":{}},\"parent\":{}}],[\"checking\",{\"_index\":188,\"name\":{\"302\":{}},\"parent\":{}}],[\"collection_formats\",{\"_index\":225,\"name\":{\"337\":{}},\"parent\":{}}],[\"common\",{\"_index\":241,\"name\":{\"355\":{}},\"parent\":{\"356\":{},\"357\":{},\"358\":{},\"359\":{},\"360\":{},\"361\":{},\"362\":{},\"363\":{},\"364\":{},\"365\":{}}}],[\"companydescriptivedate\",{\"_index\":129,\"name\":{\"185\":{}},\"parent\":{}}],[\"companydiscretionarydata\",{\"_index\":126,\"name\":{\"181\":{}},\"parent\":{}}],[\"companyentrydescription\",{\"_index\":128,\"name\":{\"184\":{},\"253\":{}},\"parent\":{}}],[\"companyidentification\",{\"_index\":122,\"name\":{\"173\":{},\"182\":{}},\"parent\":{}}],[\"companyname\",{\"_index\":125,\"name\":{\"180\":{}},\"parent\":{}}],[\"configuration\",{\"_index\":220,\"name\":{\"332\":{},\"348\":{},\"366\":{},\"376\":{},\"437\":{}},\"parent\":{\"367\":{},\"376\":{}}}],[\"configuration.configuration\",{\"_index\":260,\"name\":{},\"parent\":{\"377\":{},\"378\":{},\"379\":{},\"380\":{},\"381\":{},\"382\":{},\"383\":{},\"384\":{},\"385\":{},\"386\":{}}}],[\"configuration.configurationparameters\",{\"_index\":254,\"name\":{},\"parent\":{\"368\":{},\"369\":{},\"370\":{},\"371\":{},\"372\":{},\"373\":{},\"374\":{},\"375\":{}}}],[\"configurationparameters\",{\"_index\":252,\"name\":{\"367\":{},\"436\":{}},\"parent\":{}}],[\"constructor\",{\"_index\":204,\"name\":{\"316\":{},\"347\":{},\"352\":{},\"377\":{}},\"parent\":{}}],[\"contestedreturncode\",{\"_index\":110,\"name\":{\"149\":{}},\"parent\":{}}],[\"correcteddata\",{\"_index\":95,\"name\":{\"124\":{}},\"parent\":{}}],[\"createfile\",{\"_index\":132,\"name\":{\"190\":{},\"320\":{},\"418\":{}},\"parent\":{}}],[\"createrequestfunction\",{\"_index\":251,\"name\":{\"365\":{}},\"parent\":{}}],[\"creditfileid\",{\"_index\":192,\"name\":{\"306\":{}},\"parent\":{}}],[\"csv\",{\"_index\":227,\"name\":{\"339\":{}},\"parent\":{}}],[\"dateofdeath\",{\"_index\":98,\"name\":{\"131\":{}},\"parent\":{}}],[\"dateoriginalentryreturned\",{\"_index\":111,\"name\":{\"151\":{}},\"parent\":{}}],[\"debitfileid\",{\"_index\":194,\"name\":{\"307\":{}},\"parent\":{}}],[\"deleteachfile\",{\"_index\":209,\"name\":{\"321\":{}},\"parent\":{}}],[\"deletefilebatch\",{\"_index\":210,\"name\":{\"322\":{}},\"parent\":{}}],[\"description\",{\"_index\":184,\"name\":{\"299\":{}},\"parent\":{}}],[\"dfiaccountnumber\",{\"_index\":17,\"name\":{\"16\":{},\"203\":{},\"267\":{}},\"parent\":{}}],[\"discretionarydata\",{\"_index\":22,\"name\":{\"22\":{},\"207\":{}},\"parent\":{}}],[\"dishonoredreturnreasoncode\",{\"_index\":102,\"name\":{\"138\":{},\"159\":{}},\"parent\":{}}],[\"dishonoredreturnsettlementdate\",{\"_index\":114,\"name\":{\"158\":{}},\"parent\":{}}],[\"dishonoredreturntracenumber\",{\"_index\":113,\"name\":{\"157\":{}},\"parent\":{}}],[\"dummy_base_url\",{\"_index\":242,\"name\":{\"356\":{}},\"parent\":{}}],[\"effectiveentrydate\",{\"_index\":130,\"name\":{\"186\":{},\"256\":{}},\"parent\":{}}],[\"entryaddendacount\",{\"_index\":5,\"name\":{\"4\":{},\"33\":{},\"169\":{},\"221\":{}},\"parent\":{}}],[\"entrydetail\",{\"_index\":139,\"name\":{\"198\":{},\"419\":{}},\"parent\":{}}],[\"entrydetails\",{\"_index\":118,\"name\":{\"163\":{}},\"parent\":{}}],[\"entrydetailsequencenumber\",{\"_index\":49,\"name\":{\"55\":{},\"63\":{},\"69\":{},\"75\":{},\"82\":{},\"90\":{},\"96\":{},\"102\":{},\"108\":{},\"117\":{}},\"parent\":{}}],[\"entryhash\",{\"_index\":6,\"name\":{\"5\":{},\"34\":{},\"170\":{},\"222\":{}},\"parent\":{}}],[\"error\",{\"_index\":154,\"name\":{\"237\":{},\"285\":{}},\"parent\":{}}],[\"field\",{\"_index\":240,\"name\":{\"354\":{}},\"parent\":{}}],[\"fileadvcontrol\",{\"_index\":179,\"name\":{\"294\":{}},\"parent\":{}}],[\"filecontrol\",{\"_index\":137,\"name\":{\"195\":{},\"217\":{},\"291\":{},\"420\":{}},\"parent\":{}}],[\"filecreationdate\",{\"_index\":149,\"name\":{\"232\":{}},\"parent\":{}}],[\"filecreationtime\",{\"_index\":148,\"name\":{\"231\":{}},\"parent\":{}}],[\"fileheader\",{\"_index\":134,\"name\":{\"192\":{},\"225\":{},\"288\":{},\"421\":{}},\"parent\":{}}],[\"fileid\",{\"_index\":152,\"name\":{\"235\":{},\"422\":{}},\"parent\":{}}],[\"fileidentification\",{\"_index\":20,\"name\":{\"19\":{}},\"parent\":{}}],[\"fileidmodifier\",{\"_index\":150,\"name\":{\"233\":{}},\"parent\":{}}],[\"flattenfile\",{\"_index\":211,\"name\":{\"323\":{}},\"parent\":{}}],[\"foreigncorrespondentbankbranchcountrycode\",{\"_index\":89,\"name\":{\"115\":{}},\"parent\":{}}],[\"foreigncorrespondentbankidnumber\",{\"_index\":88,\"name\":{\"114\":{}},\"parent\":{}}],[\"foreigncorrespondentbankidnumberqualifier\",{\"_index\":87,\"name\":{\"113\":{}},\"parent\":{}}],[\"foreigncorrespondentbankname\",{\"_index\":86,\"name\":{\"112\":{}},\"parent\":{}}],[\"foreignexchangeindicator\",{\"_index\":161,\"name\":{\"247\":{}},\"parent\":{}}],[\"foreignexchangereference\",{\"_index\":163,\"name\":{\"249\":{}},\"parent\":{}}],[\"foreignexchangereferenceindicator\",{\"_index\":162,\"name\":{\"248\":{}},\"parent\":{}}],[\"foreignpaymentamount\",{\"_index\":53,\"name\":{\"60\":{}},\"parent\":{}}],[\"foreigntracenumber\",{\"_index\":54,\"name\":{\"61\":{}},\"parent\":{}}],[\"format\",{\"_index\":264,\"name\":{\"390\":{}},\"parent\":{}}],[\"formdatactor\",{\"_index\":259,\"name\":{\"374\":{},\"384\":{}},\"parent\":{}}],[\"getfilebatch\",{\"_index\":212,\"name\":{\"324\":{}},\"parent\":{}}],[\"getfilebatches\",{\"_index\":213,\"name\":{\"325\":{}},\"parent\":{}}],[\"getfilebyid\",{\"_index\":214,\"name\":{\"326\":{}},\"parent\":{}}],[\"getfilecontents\",{\"_index\":215,\"name\":{\"327\":{}},\"parent\":{}}],[\"getfiles\",{\"_index\":216,\"name\":{\"328\":{}},\"parent\":{}}],[\"hostname\",{\"_index\":267,\"name\":{\"393\":{}},\"parent\":{}}],[\"iatbatch\",{\"_index\":155,\"name\":{\"238\":{},\"423\":{}},\"parent\":{}}],[\"iatbatches\",{\"_index\":136,\"name\":{\"194\":{},\"290\":{}},\"parent\":{}}],[\"iatbatchheader\",{\"_index\":157,\"name\":{\"240\":{},\"243\":{},\"424\":{}},\"parent\":{}}],[\"iatentrydetail\",{\"_index\":168,\"name\":{\"260\":{},\"425\":{}},\"parent\":{}}],[\"iatentrydetails\",{\"_index\":158,\"name\":{\"241\":{}},\"parent\":{}}],[\"iatindicator\",{\"_index\":160,\"name\":{\"246\":{}},\"parent\":{}}],[\"id\",{\"_index\":2,\"name\":{\"2\":{},\"12\":{},\"30\":{},\"38\":{},\"51\":{},\"57\":{},\"65\":{},\"71\":{},\"77\":{},\"84\":{},\"92\":{},\"98\":{},\"104\":{},\"110\":{},\"119\":{},\"127\":{},\"136\":{},\"147\":{},\"167\":{},\"178\":{},\"191\":{},\"199\":{},\"218\":{},\"226\":{},\"236\":{},\"239\":{},\"244\":{},\"261\":{},\"287\":{}},\"parent\":{}}],[\"identificationnumber\",{\"_index\":141,\"name\":{\"205\":{}},\"parent\":{}}],[\"immediatedestination\",{\"_index\":146,\"name\":{\"229\":{}},\"parent\":{}}],[\"immediatedestinationname\",{\"_index\":147,\"name\":{\"230\":{}},\"parent\":{}}],[\"immediateorigin\",{\"_index\":144,\"name\":{\"227\":{}},\"parent\":{}}],[\"immediateoriginname\",{\"_index\":145,\"name\":{\"228\":{}},\"parent\":{}}],[\"index\",{\"_index\":262,\"name\":{\"387\":{}},\"parent\":{\"397\":{},\"398\":{},\"399\":{},\"400\":{},\"401\":{},\"402\":{},\"403\":{},\"404\":{},\"405\":{},\"406\":{},\"407\":{},\"408\":{},\"409\":{},\"410\":{},\"411\":{},\"412\":{},\"413\":{},\"414\":{},\"415\":{},\"416\":{},\"417\":{},\"418\":{},\"419\":{},\"420\":{},\"421\":{},\"422\":{},\"423\":{},\"424\":{},\"425\":{},\"426\":{},\"427\":{},\"428\":{},\"429\":{},\"430\":{},\"431\":{},\"432\":{},\"433\":{},\"434\":{},\"435\":{},\"436\":{},\"437\":{}}}],[\"individualname\",{\"_index\":21,\"name\":{\"21\":{},\"206\":{}},\"parent\":{}}],[\"isjsonmime\",{\"_index\":261,\"name\":{\"386\":{}},\"parent\":{}}],[\"isodestinationcountrycode\",{\"_index\":164,\"name\":{\"250\":{}},\"parent\":{}}],[\"isodestinationcurrencycode\",{\"_index\":167,\"name\":{\"255\":{}},\"parent\":{}}],[\"isooriginatingcurrencycode\",{\"_index\":166,\"name\":{\"254\":{}},\"parent\":{}}],[\"julianday\",{\"_index\":25,\"name\":{\"25\":{}},\"parent\":{}}],[\"messageauthentication\",{\"_index\":123,\"name\":{\"174\":{}},\"parent\":{}}],[\"modelerror\",{\"_index\":173,\"name\":{\"284\":{},\"426\":{}},\"parent\":{}}],[\"modelfile\",{\"_index\":175,\"name\":{\"286\":{},\"427\":{}},\"parent\":{}}],[\"name\",{\"_index\":55,\"name\":{\"62\":{},\"353\":{}},\"parent\":{}}],[\"notificationofchange\",{\"_index\":177,\"name\":{\"292\":{}},\"parent\":{}}],[\"odfibranchcountrycode\",{\"_index\":68,\"name\":{\"81\":{}},\"parent\":{}}],[\"odfiidentification\",{\"_index\":10,\"name\":{\"9\":{},\"175\":{},\"188\":{},\"258\":{}},\"parent\":{}}],[\"odfiidnumberqualifier\",{\"_index\":67,\"name\":{\"80\":{}},\"parent\":{}}],[\"odfiname\",{\"_index\":66,\"name\":{\"79\":{}},\"parent\":{}}],[\"ofacscreeningindicator\",{\"_index\":171,\"name\":{\"268\":{}},\"parent\":{}}],[\"offset\",{\"_index\":120,\"name\":{\"165\":{},\"295\":{},\"428\":{}},\"parent\":{}}],[\"offsetaccounttypeenum\",{\"_index\":185,\"name\":{\"300\":{},\"304\":{},\"429\":{}},\"parent\":{}}],[\"options\",{\"_index\":235,\"name\":{\"345\":{}},\"parent\":{}}],[\"originaldfi\",{\"_index\":94,\"name\":{\"123\":{},\"132\":{}},\"parent\":{}}],[\"originalentrytracenumber\",{\"_index\":103,\"name\":{\"139\":{},\"150\":{}},\"parent\":{}}],[\"originalreceivingdfiidentification\",{\"_index\":104,\"name\":{\"140\":{},\"152\":{}},\"parent\":{}}],[\"originalsettlementdate\",{\"_index\":112,\"name\":{\"153\":{}},\"parent\":{}}],[\"originaltrace\",{\"_index\":93,\"name\":{\"122\":{},\"130\":{}},\"parent\":{}}],[\"originatorcitystateprovince\",{\"_index\":62,\"name\":{\"73\":{}},\"parent\":{}}],[\"originatorcountrypostalcode\",{\"_index\":63,\"name\":{\"74\":{}},\"parent\":{}}],[\"originatoridentification\",{\"_index\":165,\"name\":{\"251\":{}},\"parent\":{}}],[\"originatorname\",{\"_index\":58,\"name\":{\"67\":{}},\"parent\":{}}],[\"originatorstatuscode\",{\"_index\":131,\"name\":{\"187\":{},\"257\":{}},\"parent\":{}}],[\"originatorstreetaddress\",{\"_index\":59,\"name\":{\"68\":{}},\"parent\":{}}],[\"parse\",{\"_index\":263,\"name\":{\"389\":{}},\"parent\":{}}],[\"password\",{\"_index\":256,\"name\":{\"370\":{},\"380\":{}},\"parent\":{}}],[\"pathname\",{\"_index\":268,\"name\":{\"394\":{}},\"parent\":{}}],[\"paymentrelatedinformation\",{\"_index\":48,\"name\":{\"53\":{},\"106\":{}},\"parent\":{}}],[\"ping\",{\"_index\":217,\"name\":{\"329\":{}},\"parent\":{}}],[\"pipes\",{\"_index\":231,\"name\":{\"342\":{}},\"parent\":{}}],[\"protocol\",{\"_index\":265,\"name\":{\"392\":{}},\"parent\":{}}],[\"query\",{\"_index\":269,\"name\":{\"395\":{}},\"parent\":{}}],[\"rdfibranchcountrycode\",{\"_index\":73,\"name\":{\"89\":{}},\"parent\":{}}],[\"rdfiidentification\",{\"_index\":15,\"name\":{\"14\":{},\"88\":{},\"201\":{},\"263\":{}},\"parent\":{}}],[\"rdfiidnumberqualifier\",{\"_index\":72,\"name\":{\"87\":{}},\"parent\":{}}],[\"rdfiname\",{\"_index\":71,\"name\":{\"86\":{}},\"parent\":{}}],[\"receivercitystateprovince\",{\"_index\":80,\"name\":{\"100\":{}},\"parent\":{}}],[\"receivercountrypostalcode\",{\"_index\":81,\"name\":{\"101\":{}},\"parent\":{}}],[\"receiveridnumber\",{\"_index\":76,\"name\":{\"94\":{}},\"parent\":{}}],[\"receiverstreetaddress\",{\"_index\":77,\"name\":{\"95\":{}},\"parent\":{}}],[\"referencecode\",{\"_index\":151,\"name\":{\"234\":{}},\"parent\":{}}],[\"referenceinformationone\",{\"_index\":36,\"name\":{\"40\":{}},\"parent\":{}}],[\"referenceinformationtwo\",{\"_index\":37,\"name\":{\"41\":{}},\"parent\":{}}],[\"requestargs\",{\"_index\":232,\"name\":{\"343\":{}},\"parent\":{}}],[\"requireabaorigin\",{\"_index\":196,\"name\":{\"309\":{}},\"parent\":{}}],[\"requirederror\",{\"_index\":238,\"name\":{\"351\":{}},\"parent\":{}}],[\"returncode\",{\"_index\":97,\"name\":{\"129\":{}},\"parent\":{}}],[\"returnentries\",{\"_index\":178,\"name\":{\"293\":{}},\"parent\":{}}],[\"returnreasoncode\",{\"_index\":107,\"name\":{\"143\":{},\"156\":{}},\"parent\":{}}],[\"returnsettlementdate\",{\"_index\":106,\"name\":{\"142\":{},\"155\":{}},\"parent\":{}}],[\"returntracenumber\",{\"_index\":105,\"name\":{\"141\":{},\"154\":{}},\"parent\":{}}],[\"routingnumber\",{\"_index\":180,\"name\":{\"296\":{}},\"parent\":{}}],[\"savings\",{\"_index\":190,\"name\":{\"303\":{}},\"parent\":{}}],[\"search\",{\"_index\":270,\"name\":{\"396\":{}},\"parent\":{}}],[\"secondaryofacscreeningindicator\",{\"_index\":172,\"name\":{\"269\":{}},\"parent\":{}}],[\"segmentedfiles\",{\"_index\":191,\"name\":{\"305\":{},\"430\":{}},\"parent\":{}}],[\"segmentfile\",{\"_index\":218,\"name\":{\"330\":{}},\"parent\":{}}],[\"sequencenumber\",{\"_index\":26,\"name\":{\"26\":{},\"54\":{},\"107\":{},\"116\":{}},\"parent\":{}}],[\"serializedataifneeded\",{\"_index\":249,\"name\":{\"363\":{}},\"parent\":{}}],[\"serviceclasscode\",{\"_index\":4,\"name\":{\"3\":{},\"168\":{},\"179\":{},\"245\":{}},\"parent\":{}}],[\"setapikeytoobject\",{\"_index\":244,\"name\":{\"358\":{}},\"parent\":{}}],[\"setbasicauthtoobject\",{\"_index\":245,\"name\":{\"359\":{}},\"parent\":{}}],[\"setbearerauthtoobject\",{\"_index\":246,\"name\":{\"360\":{}},\"parent\":{}}],[\"setoauthtoobject\",{\"_index\":247,\"name\":{\"361\":{}},\"parent\":{}}],[\"setsearchparams\",{\"_index\":248,\"name\":{\"362\":{}},\"parent\":{}}],[\"ssv\",{\"_index\":229,\"name\":{\"340\":{}},\"parent\":{}}],[\"standardentryclasscode\",{\"_index\":127,\"name\":{\"183\":{},\"252\":{}},\"parent\":{}}],[\"terminalcity\",{\"_index\":43,\"name\":{\"47\":{}},\"parent\":{}}],[\"terminalidentificationcode\",{\"_index\":38,\"name\":{\"42\":{}},\"parent\":{}}],[\"terminallocation\",{\"_index\":42,\"name\":{\"46\":{}},\"parent\":{}}],[\"terminalstate\",{\"_index\":44,\"name\":{\"48\":{}},\"parent\":{}}],[\"topathstring\",{\"_index\":250,\"name\":{\"364\":{}},\"parent\":{}}],[\"totalcredit\",{\"_index\":8,\"name\":{\"7\":{},\"36\":{},\"172\":{},\"224\":{}},\"parent\":{}}],[\"totaldebit\",{\"_index\":7,\"name\":{\"6\":{},\"35\":{},\"171\":{},\"223\":{}},\"parent\":{}}],[\"tracenumber\",{\"_index\":45,\"name\":{\"49\":{},\"125\":{},\"134\":{},\"145\":{},\"160\":{},\"209\":{},\"271\":{}},\"parent\":{}}],[\"transactioncode\",{\"_index\":14,\"name\":{\"13\":{},\"200\":{},\"262\":{}},\"parent\":{}}],[\"transactiondate\",{\"_index\":40,\"name\":{\"44\":{}},\"parent\":{}}],[\"transactionserialnumber\",{\"_index\":39,\"name\":{\"43\":{}},\"parent\":{}}],[\"transactiontypecode\",{\"_index\":52,\"name\":{\"59\":{}},\"parent\":{}}],[\"tsv\",{\"_index\":230,\"name\":{\"341\":{}},\"parent\":{}}],[\"typecode\",{\"_index\":35,\"name\":{\"39\":{},\"52\":{},\"58\":{},\"66\":{},\"72\":{},\"78\":{},\"85\":{},\"93\":{},\"99\":{},\"105\":{},\"111\":{},\"120\":{},\"128\":{},\"137\":{},\"148\":{}},\"parent\":{}}],[\"url\",{\"_index\":233,\"name\":{\"344\":{},\"388\":{},\"391\":{}},\"parent\":{\"389\":{},\"390\":{},\"391\":{}}}],[\"url.url\",{\"_index\":266,\"name\":{},\"parent\":{\"392\":{},\"393\":{},\"394\":{},\"395\":{},\"396\":{}}}],[\"username\",{\"_index\":255,\"name\":{\"369\":{},\"379\":{}},\"parent\":{}}],[\"validatefile\",{\"_index\":219,\"name\":{\"331\":{}},\"parent\":{}}],[\"validateopts\",{\"_index\":195,\"name\":{\"308\":{},\"431\":{}},\"parent\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css new file mode 100644 index 0000000..6127b27 --- /dev/null +++ b/docs/assets/style.css @@ -0,0 +1,1414 @@ +@import url("./icons.css"); + +:root { + /* Light */ + --light-color-background: #fcfcfc; + --light-color-secondary-background: #fff; + --light-color-text: #222; + --light-color-text-aside: #707070; + --light-color-link: #4da6ff; + --light-color-menu-divider: #eee; + --light-color-menu-divider-focus: #000; + --light-color-menu-label: #707070; + --light-color-panel: var(--light-color-secondary-background); + --light-color-panel-divider: #eee; + --light-color-comment-tag: #707070; + --light-color-comment-tag-text: #fff; + --light-color-ts: #9600ff; + --light-color-ts-interface: #647f1b; + --light-color-ts-enum: #937210; + --light-color-ts-class: #0672de; + --light-color-ts-private: #707070; + --light-color-toolbar: #fff; + --light-color-toolbar-text: #333; + --light-icon-filter: invert(0); + --light-external-icon: url("data:image/svg+xml;utf8,"); + + /* Dark */ + --dark-color-background: #36393f; + --dark-color-secondary-background: #2f3136; + --dark-color-text: #ffffff; + --dark-color-text-aside: #e6e4e4; + --dark-color-link: #00aff4; + --dark-color-menu-divider: #eee; + --dark-color-menu-divider-focus: #000; + --dark-color-menu-label: #707070; + --dark-color-panel: var(--dark-color-secondary-background); + --dark-color-panel-divider: #818181; + --dark-color-comment-tag: #dcddde; + --dark-color-comment-tag-text: #2f3136; + --dark-color-ts: #c97dff; + --dark-color-ts-interface: #9cbe3c; + --dark-color-ts-enum: #d6ab29; + --dark-color-ts-class: #3695f3; + --dark-color-ts-private: #e2e2e2; + --dark-color-toolbar: #34373c; + --dark-color-toolbar-text: #ffffff; + --dark-icon-filter: invert(1); + --dark-external-icon: url("data:image/svg+xml;utf8,"); +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-secondary-background: var(--light-color-secondary-background); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-menu-divider: var(--light-color-menu-divider); + --color-menu-divider-focus: var(--light-color-menu-divider-focus); + --color-menu-label: var(--light-color-menu-label); + --color-panel: var(--light-color-panel); + --color-panel-divider: var(--light-color-panel-divider); + --color-comment-tag: var(--light-color-comment-tag); + --color-comment-tag-text: var(--light-color-comment-tag-text); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-private: var(--light-color-ts-private); + --color-toolbar: var(--light-color-toolbar); + --color-toolbar-text: var(--light-color-toolbar-text); + --icon-filter: var(--light-icon-filter); + --external-icon: var(--light-external-icon); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-secondary-background: var(--dark-color-secondary-background); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-menu-divider: var(--dark-color-menu-divider); + --color-menu-divider-focus: var(--dark-color-menu-divider-focus); + --color-menu-label: var(--dark-color-menu-label); + --color-panel: var(--dark-color-panel); + --color-panel-divider: var(--dark-color-panel-divider); + --color-comment-tag: var(--dark-color-comment-tag); + --color-comment-tag-text: var(--dark-color-comment-tag-text); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-private: var(--dark-color-ts-private); + --color-toolbar: var(--dark-color-toolbar); + --color-toolbar-text: var(--dark-color-toolbar-text); + --icon-filter: var(--dark-icon-filter); + --external-icon: var(--dark-external-icon); + } +} + +body { + margin: 0; +} + +body.light { + --color-background: var(--light-color-background); + --color-secondary-background: var(--light-color-secondary-background); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-menu-divider: var(--light-color-menu-divider); + --color-menu-divider-focus: var(--light-color-menu-divider-focus); + --color-menu-label: var(--light-color-menu-label); + --color-panel: var(--light-color-panel); + --color-panel-divider: var(--light-color-panel-divider); + --color-comment-tag: var(--light-color-comment-tag); + --color-comment-tag-text: var(--light-color-comment-tag-text); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-private: var(--light-color-ts-private); + --color-toolbar: var(--light-color-toolbar); + --color-toolbar-text: var(--light-color-toolbar-text); + --icon-filter: var(--light-icon-filter); + --external-icon: var(--light-external-icon); +} + +body.dark { + --color-background: var(--dark-color-background); + --color-secondary-background: var(--dark-color-secondary-background); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-menu-divider: var(--dark-color-menu-divider); + --color-menu-divider-focus: var(--dark-color-menu-divider-focus); + --color-menu-label: var(--dark-color-menu-label); + --color-panel: var(--dark-color-panel); + --color-panel-divider: var(--dark-color-panel-divider); + --color-comment-tag: var(--dark-color-comment-tag); + --color-comment-tag-text: var(--dark-color-comment-tag-text); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-private: var(--dark-color-ts-private); + --color-toolbar: var(--dark-color-toolbar); + --color-toolbar-text: var(--dark-color-toolbar-text); + --icon-filter: var(--dark-icon-filter); + --external-icon: var(--dark-external-icon); +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +h2 { + font-size: 1.5em; + margin: 0.83em 0; +} + +h3 { + font-size: 1.17em; + margin: 1em 0; +} + +h4, +.tsd-index-panel h3 { + font-size: 1em; + margin: 1.33em 0; +} + +h5 { + font-size: 0.83em; + margin: 1.67em 0; +} + +h6 { + font-size: 0.67em; + margin: 2.33em 0; +} + +pre { + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1200px; + margin: 0 auto; + padding: 0 40px; +} +@media (max-width: 640px) { + .container { + padding: 0 20px; + } +} + +.container-main { + padding-bottom: 200px; +} + +.row { + display: flex; + position: relative; + margin: 0 -10px; +} +.row:after { + visibility: hidden; + display: block; + content: ""; + clear: both; + height: 0; +} + +.col-4, +.col-8 { + box-sizing: border-box; + float: left; + padding: 0 10px; +} + +.col-4 { + width: 33.3333333333%; +} +.col-8 { + width: 66.6666666667%; +} + +ul.tsd-descriptions > li > :first-child, +.tsd-panel > :first-child, +.col-8 > :first-child, +.col-4 > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child, +.tsd-panel > :first-child > :first-child, +.col-8 > :first-child > :first-child, +.col-4 > :first-child > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child > :first-child, +.tsd-panel > :first-child > :first-child > :first-child, +.col-8 > :first-child > :first-child > :first-child, +.col-4 > :first-child > :first-child > :first-child { + margin-top: 0; +} +ul.tsd-descriptions > li > :last-child, +.tsd-panel > :last-child, +.col-8 > :last-child, +.col-4 > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child, +.tsd-panel > :last-child > :last-child, +.col-8 > :last-child > :last-child, +.col-4 > :last-child > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child > :last-child, +.tsd-panel > :last-child > :last-child > :last-child, +.col-8 > :last-child > :last-child > :last-child, +.col-4 > :last-child > :last-child > :last-child { + margin-bottom: 0; +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes shift-to-left { + from { + transform: translate(0, 0); + } + to { + transform: translate(-25%, 0); + } +} +@keyframes unshift-to-left { + from { + transform: translate(-25%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 14px; +} + +pre { + padding: 10px; +} +pre code { + padding: 0; + font-size: 100%; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} + +@media (min-width: 901px) and (max-width: 1024px) { + html .col-content { + width: 72%; + } + html .col-menu { + width: 28%; + } + html .tsd-navigation { + padding-left: 10px; + } +} +@media (max-width: 900px) { + html .col-content { + float: none; + width: 100%; + } + html .col-menu { + position: fixed !important; + overflow: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + width: 100%; + padding: 20px 20px 0 0; + max-width: 450px; + visibility: hidden; + background-color: var(--color-panel); + transform: translate(100%, 0); + } + html .col-menu > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu :is(header, footer, .col-content) { + animation: shift-to-left 0.4s; + } + + .to-has-menu .col-menu { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu :is(header, footer, .col-content) { + animation: unshift-to-left 0.4s; + } + + .from-has-menu .col-menu { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu :is(header, footer, .col-content) { + transform: translate(-25%, 0); + } + .has-menu .col-menu { + visibility: visible; + transform: translate(0, 0); + display: grid; + grid-template-rows: auto 1fr; + max-height: 100vh; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +.tsd-page-title { + padding: 70px 0 20px 0; + margin: 0 0 40px 0; + background: var(--color-panel); + box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); +} +.tsd-page-title h1 { + margin: 0; +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +dl.tsd-comment-tags { + overflow: hidden; +} +dl.tsd-comment-tags dt { + float: left; + padding: 1px 5px; + margin: 0 10px 0 0; + border-radius: 4px; + border: 1px solid var(--color-comment-tag); + color: var(--color-comment-tag); + font-size: 0.8em; + font-weight: normal; +} +dl.tsd-comment-tags dd { + margin: 0 0 10px 0; +} +dl.tsd-comment-tags dd:before, +dl.tsd-comment-tags dd:after { + display: table; + content: " "; +} +dl.tsd-comment-tags dd pre, +dl.tsd-comment-tags dd:after { + clear: both; +} +dl.tsd-comment-tags p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.toggle-protected .tsd-is-private { + display: none; +} + +.toggle-public .tsd-is-private, +.toggle-public .tsd-is-protected, +.toggle-public .tsd-is-private-protected { + display: none; +} + +.toggle-inherited .tsd-is-inherited { + display: none; +} + +.toggle-externals .tsd-is-external { + display: none; +} + +#tsd-filter { + position: relative; + display: inline-block; + height: 40px; + vertical-align: bottom; +} +.no-filter #tsd-filter { + display: none; +} +#tsd-filter .tsd-filter-group { + display: inline-block; + height: 40px; + vertical-align: bottom; + white-space: nowrap; +} +#tsd-filter input { + display: none; +} +@media (max-width: 900px) { + #tsd-filter .tsd-filter-group { + display: block; + position: absolute; + top: 40px; + right: 20px; + height: auto; + background-color: var(--color-panel); + visibility: hidden; + transform: translate(50%, 0); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + } + .has-options #tsd-filter .tsd-filter-group { + visibility: visible; + } + .to-has-options #tsd-filter .tsd-filter-group { + animation: fade-in 0.2s; + } + .from-has-options #tsd-filter .tsd-filter-group { + animation: fade-out 0.2s; + } + #tsd-filter label, + #tsd-filter .tsd-select { + display: block; + padding-right: 20px; + } +} + +footer { + border-top: 1px solid var(--color-panel-divider); + background-color: var(--color-panel); +} +footer:after { + content: ""; + display: table; +} +footer.with-border-bottom { + border-bottom: 1px solid var(--color-panel-divider); +} +footer .tsd-legend-group { + font-size: 0; +} +footer .tsd-legend { + display: inline-block; + width: 25%; + padding: 0; + font-size: 16px; + list-style: none; + line-height: 1.333em; + vertical-align: top; +} +@media (max-width: 900px) { + footer .tsd-legend { + width: 50%; + } +} + +.tsd-hierarchy { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-index-panel .tsd-index-content { + margin-bottom: -30px !important; +} +.tsd-index-panel .tsd-index-section { + margin-bottom: 30px !important; +} +.tsd-index-panel h3 { + margin: 0 -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 3; + -moz-column-count: 3; + -ms-column-count: 3; + -o-column-count: 3; + column-count: 3; + -webkit-column-gap: 20px; + -moz-column-gap: 20px; + -ms-column-gap: 20px; + -o-column-gap: 20px; + column-gap: 20px; + padding: 0; + list-style: none; + line-height: 1.333em; +} +@media (max-width: 900px) { + .tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 1; + -moz-column-count: 1; + -ms-column-count: 1; + -o-column-count: 1; + column-count: 1; + } +} +@media (min-width: 901px) and (max-width: 1024px) { + .tsd-index-panel ul.tsd-index-list { + -webkit-column-count: 2; + -moz-column-count: 2; + -ms-column-count: 2; + -o-column-count: 2; + column-count: 2; + } +} +.tsd-index-panel ul.tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} +.tsd-index-panel a, +.tsd-index-panel .tsd-parent-kind-module a { + color: var(--color-ts); +} +.tsd-index-panel .tsd-parent-kind-interface a { + color: var(--color-ts-interface); +} +.tsd-index-panel .tsd-parent-kind-enum a { + color: var(--color-ts-enum); +} +.tsd-index-panel .tsd-parent-kind-class a { + color: var(--color-ts-class); +} +.tsd-index-panel .tsd-kind-module a { + color: var(--color-ts); +} +.tsd-index-panel .tsd-kind-interface a { + color: var(--color-ts-interface); +} +.tsd-index-panel .tsd-kind-enum a { + color: var(--color-ts-enum); +} +.tsd-index-panel .tsd-kind-class a { + color: var(--color-ts-class); +} +.tsd-index-panel .tsd-is-private a { + color: var(--color-ts-private); +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: absolute; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} +.tsd-member [data-tsd-kind] { + color: var(--color-ts); +} +.tsd-member [data-tsd-kind="Interface"] { + color: var(--color-ts-interface); +} +.tsd-member [data-tsd-kind="Enum"] { + color: var(--color-ts-enum); +} +.tsd-member [data-tsd-kind="Class"] { + color: var(--color-ts-class); +} +.tsd-member [data-tsd-kind="Private"] { + color: var(--color-ts-private); +} + +.tsd-navigation { + margin: 0 0 0 40px; +} +.tsd-navigation a { + display: block; + padding-top: 2px; + padding-bottom: 2px; + border-left: 2px solid transparent; + color: var(--color-text); + text-decoration: none; + transition: border-left-color 0.1s; +} +.tsd-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul { + margin: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li { + padding: 0; +} + +.tsd-navigation.primary { + padding-bottom: 40px; +} +.tsd-navigation.primary a { + display: block; + padding-top: 6px; + padding-bottom: 6px; +} +.tsd-navigation.primary ul li a { + padding-left: 5px; +} +.tsd-navigation.primary ul li li a { + padding-left: 25px; +} +.tsd-navigation.primary ul li li li a { + padding-left: 45px; +} +.tsd-navigation.primary ul li li li li a { + padding-left: 65px; +} +.tsd-navigation.primary ul li li li li li a { + padding-left: 85px; +} +.tsd-navigation.primary ul li li li li li li a { + padding-left: 105px; +} +.tsd-navigation.primary > ul { + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-navigation.primary li { + border-top: 1px solid var(--color-panel-divider); +} +.tsd-navigation.primary li.current > a { + font-weight: bold; +} +.tsd-navigation.primary li.label span { + display: block; + padding: 20px 0 6px 5px; + color: var(--color-menu-label); +} +.tsd-navigation.primary li.globals + li > span, +.tsd-navigation.primary li.globals + li > a { + padding-top: 20px; +} + +.tsd-navigation.secondary { + max-height: calc(100vh - 1rem - 40px); + overflow: auto; + position: sticky; + top: calc(0.5rem + 40px); + transition: 0.3s; +} +.tsd-navigation.secondary.tsd-navigation--toolbar-hide { + max-height: calc(100vh - 1rem); + top: 0.5rem; +} +.tsd-navigation.secondary ul { + transition: opacity 0.2s; +} +.tsd-navigation.secondary ul li a { + padding-left: 25px; +} +.tsd-navigation.secondary ul li li a { + padding-left: 45px; +} +.tsd-navigation.secondary ul li li li a { + padding-left: 65px; +} +.tsd-navigation.secondary ul li li li li a { + padding-left: 85px; +} +.tsd-navigation.secondary ul li li li li li a { + padding-left: 105px; +} +.tsd-navigation.secondary ul li li li li li li a { + padding-left: 125px; +} +.tsd-navigation.secondary ul.current a { + border-left-color: var(--color-panel-divider); +} +.tsd-navigation.secondary li.focus > a, +.tsd-navigation.secondary ul.current li.focus > a { + border-left-color: var(--color-menu-divider-focus); +} +.tsd-navigation.secondary li.current { + margin-top: 20px; + margin-bottom: 20px; + border-left-color: var(--color-panel-divider); +} +.tsd-navigation.secondary li.current > a { + font-weight: bold; +} + +@media (min-width: 901px) { + .menu-sticky-wrap { + position: static; + } +} + +.tsd-panel { + margin: 20px 0; + padding: 20px; + background-color: var(--color-panel); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5em -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid var(--color-panel-divider); +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: 0; +} +.tsd-panel table { + display: block; + width: 100%; + overflow: auto; + margin-top: 10px; + word-break: normal; + word-break: keep-all; + border-collapse: collapse; +} +.tsd-panel table th { + font-weight: bold; +} +.tsd-panel table th, +.tsd-panel table td { + padding: 6px 13px; + border: 1px solid var(--color-panel-divider); +} +.tsd-panel table tr { + background: var(--color-background); +} +.tsd-panel table tr:nth-child(even) { + background: var(--color-secondary-background); +} + +.tsd-panel-group { + margin: 60px 0; +} +.tsd-panel-group > h1, +.tsd-panel-group > h2, +.tsd-panel-group > h3 { + padding-left: 20px; + padding-right: 20px; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 40px; + height: 40px; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: var(--color-background); +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-panel); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: var(--color-panel-divider); +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-panel-divider); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +.tsd-signature { + margin: 0 0 1em 0; + padding: 10px; + border: 1px solid var(--color-panel-divider); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} +.tsd-signature.tsd-kind-icon { + padding-left: 30px; +} +.tsd-signature.tsd-kind-icon:before { + top: 10px; + left: 10px; +} +.tsd-panel > .tsd-signature { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signature.tsd-kind-icon:before { + left: 20px; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + border: 1px solid var(--color-panel-divider); +} +.tsd-signatures .tsd-signature { + margin: 0; + border-width: 1px 0 0 0; + transition: background-color 0.1s; +} +.tsd-signatures .tsd-signature:first-child { + border-top-width: 0; +} +.tsd-signatures .tsd-signature.current { + background-color: var(--color-panel-divider); +} +.tsd-signatures.active > .tsd-signature { + cursor: pointer; +} +.tsd-panel > .tsd-signatures { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { + left: 20px; +} +.tsd-panel > a.anchor + .tsd-signatures { + border-top-width: 0; + margin-top: -20px; +} + +ul.tsd-descriptions { + position: relative; + overflow: hidden; + padding: 0; + list-style: none; +} +ul.tsd-descriptions.active > .tsd-description { + display: none; +} +ul.tsd-descriptions.active > .tsd-description.current { + display: block; +} +ul.tsd-descriptions.active > .tsd-description.fade-in { + animation: fade-in-delayed 0.3s; +} +ul.tsd-descriptions.active > .tsd-description.fade-out { + animation: fade-out-delayed 0.3s; + position: absolute; + display: block; + top: 0; + left: 0; + right: 0; + opacity: 0; + visibility: hidden; +} +ul.tsd-descriptions h4, +ul.tsd-descriptions .tsd-index-panel h3, +.tsd-index-panel ul.tsd-descriptions h3 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} + +ul.tsd-parameters, +ul.tsd-type-parameters { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameters > li.tsd-parameter-signature, +ul.tsd-type-parameters > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameters h5, +ul.tsd-type-parameters h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +ul.tsd-parameters .tsd-comment, +ul.tsd-type-parameters .tsd-comment { + margin-top: -0.5em; +} + +.tsd-sources { + font-size: 14px; + color: var(--color-text-aside); + margin: 0 0 1em 0; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul, +.tsd-sources p { + margin: 0 !important; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: fixed; + z-index: 1; + top: 0; + left: 0; + width: 100%; + height: 40px; + color: var(--color-toolbar-text); + background: var(--color-toolbar); + border-bottom: 1px solid var(--color-panel-divider); + transition: transform 0.3s linear; +} +.tsd-page-toolbar a { + color: var(--color-toolbar-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .table-wrap { + display: table; + width: 100%; + height: 40px; +} +.tsd-page-toolbar .table-cell { + display: table-cell; + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} + +.tsd-page-toolbar--hide { + transform: translateY(-100%); +} + +.tsd-select .tsd-select-list li:before, +.tsd-select .tsd-select-label:before, +.tsd-widget:before { + content: ""; + display: inline-block; + width: 40px; + height: 40px; + margin: 0 -8px 0 0; + background-image: url(./widgets.png); + background-repeat: no-repeat; + text-indent: -1024px; + vertical-align: bottom; + filter: var(--icon-filter); +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-select .tsd-select-list li:before, + .tsd-select .tsd-select-label:before, + .tsd-widget:before { + background-image: url(./widgets@2x.png); + background-size: 320px 40px; + } +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-panel-divider); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} +.tsd-widget.search:before { + background-position: 0 0; +} +.tsd-widget.menu:before { + background-position: -40px 0; +} +.tsd-widget.options:before { + background-position: -80px 0; +} +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +@media (max-width: 900px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +.tsd-select { + position: relative; + display: inline-block; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-select .tsd-select-label { + opacity: 0.6; + transition: opacity 0.2s; +} +.tsd-select .tsd-select-label:before { + background-position: -240px 0; +} +.tsd-select.active .tsd-select-label { + opacity: 0.8; +} +.tsd-select.active .tsd-select-list { + visibility: visible; + opacity: 1; + transition-delay: 0s; +} +.tsd-select .tsd-select-list { + position: absolute; + visibility: hidden; + top: 40px; + left: 0; + margin: 0; + padding: 0; + opacity: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + transition: visibility 0s 0.2s, opacity 0.2s; +} +.tsd-select .tsd-select-list li { + padding: 0 20px 0 0; + background-color: var(--color-background); +} +.tsd-select .tsd-select-list li:before { + background-position: 40px 0; +} +.tsd-select .tsd-select-list li:nth-child(even) { + background-color: var(--color-panel); +} +.tsd-select .tsd-select-list li:hover { + background-color: var(--color-panel-divider); +} +.tsd-select .tsd-select-list li.selected:before { + background-position: -200px 0; +} +@media (max-width: 900px) { + .tsd-select .tsd-select-list { + top: 0; + left: auto; + right: 100%; + margin-right: -5px; + } + .tsd-select .tsd-select-label:before { + background-position: -280px 0; + } +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + margin-left: 10px; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} diff --git a/docs/assets/images/widgets.png b/docs/assets/widgets.png similarity index 100% rename from docs/assets/images/widgets.png rename to docs/assets/widgets.png diff --git a/docs/assets/images/widgets@2x.png b/docs/assets/widgets@2x.png similarity index 100% rename from docs/assets/images/widgets@2x.png rename to docs/assets/widgets@2x.png diff --git a/docs/classes/_api_.achfilesapi.html b/docs/classes/_api_.achfilesapi.html deleted file mode 100644 index ce88a05..0000000 --- a/docs/classes/_api_.achfilesapi.html +++ /dev/null @@ -1,1122 +0,0 @@ - - - - - - ACHFilesApi | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Class ACHFilesApi

-
-
-
-
-
-
-
-
-
-

ACHFilesApi - object-oriented interface

-
-
-
export
-
-
-
-
-
-

Hierarchy

-
    -
  • - BaseAPI -
      -
    • - ACHFilesApi -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-

Methods

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

Protected axios

-
axios: AxiosInstance
- -
-
- -

Protected basePath

-
basePath: string
- -
-
- -

Protected configuration

-
configuration: Configuration | undefined
- -
-
-
-

Methods

-
- -

addBatchToFile

-
    -
  • addBatchToFile(fileID: string, batch: Batch, xRequestID?: undefined | string, xIdempotencyKey?: undefined | string, options?: any): Promise<AxiosResponse<void>>
    • -
-
    -
  • - -
    -
    -

    Append a Batch record to the specified file

    -
    -
    -
    summary
    -

    Add Batch to File

    -
    -
    throws
    -

    {RequiredError}

    -
    -
    memberof
    -

    ACHFilesApi

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      fileID: string
      -
      -

      File ID

      -
      -
      • -
    • -
      batch: Batch
      -
      • -
    • -
      Optional xRequestID: undefined | string
      -
      • -
    • -
      Optional xIdempotencyKey: undefined | string
      -
      • -
    • -
      Optional options: any
      -
      • -
    -

    Returns Promise<AxiosResponse<void>>

    -
    • -
-
-
- -

checkFile

-
    -
  • checkFile(fileID: string, xRequestID?: undefined | string, options?: any): Promise<AxiosResponse<Error>>
    • -
-
    -
  • - -
    -
    -

    Validates the existing file. You need only supply the unique File identifier that was returned upon creation.

    -
    -
    -
    summary
    -

    Validate file

    -
    -
    throws
    -

    {RequiredError}

    -
    -
    memberof
    -

    ACHFilesApi

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      fileID: string
      -
      -

      File ID

      -
      -
      • -
    • -
      Optional xRequestID: undefined | string
      -
      • -
    • -
      Optional options: any
      -
      • -
    -

    Returns Promise<AxiosResponse<Error>>

    -
    • -
-
-
- -

createFile

-
    -
  • createFile(createFile: CreateFile, xRequestID?: undefined | string, xIdempotencyKey?: undefined | string, options?: any): Promise<AxiosResponse<FileID>>
    • -
-
    -
  • - -
    -
    -

    Create a new File object from either the plaintext or JSON representation.

    -
    -
    -
    summary
    -

    Create File

    -
    -
    throws
    -

    {RequiredError}

    -
    -
    memberof
    -

    ACHFilesApi

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      createFile: CreateFile
      -
      -

      Content of the ACH file (in json or raw text)

      -
      -
      • -
    • -
      Optional xRequestID: undefined | string
      -
      • -
    • -
      Optional xIdempotencyKey: undefined | string
      -
      • -
    • -
      Optional options: any
      -
      • -
    -

    Returns Promise<AxiosResponse<FileID>>

    -
    • -
-
-
- -

deleteACHFile

-
    -
  • deleteACHFile(fileID: string, xRequestID?: undefined | string, options?: any): Promise<AxiosResponse<void>>
    • -
-
    -
  • - -
    -
    -

    Permanently deletes a File and associated Batches. It cannot be undone.

    -
    -
    -
    summary
    -

    Delete file

    -
    -
    throws
    -

    {RequiredError}

    -
    -
    memberof
    -

    ACHFilesApi

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      fileID: string
      -
      -

      File ID

      -
      -
      • -
    • -
      Optional xRequestID: undefined | string
      -
      • -
    • -
      Optional options: any
      -
      • -
    -

    Returns Promise<AxiosResponse<void>>

    -
    • -
-
-
- -

deleteFileBatch

-
    -
  • deleteFileBatch(fileID: string, batchID: string, xRequestID?: undefined | string, options?: any): Promise<AxiosResponse<void>>
    • -
-
    -
  • - -
    -
    -

    Delete a Batch from a File

    -
    -
    -
    summary
    -

    Delete batch

    -
    -
    throws
    -

    {RequiredError}

    -
    -
    memberof
    -

    ACHFilesApi

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      fileID: string
      -
      -

      File ID

      -
      -
      • -
    • -
      batchID: string
      -
      -

      Batch ID

      -
      -
      • -
    • -
      Optional xRequestID: undefined | string
      -
      • -
    • -
      Optional options: any
      -
      • -
    -

    Returns Promise<AxiosResponse<void>>

    -
    • -
-
-
- -

flattenFile

-
    -
  • flattenFile(fileID: string, xRequestID?: undefined | string, xIdempotencyKey?: undefined | string, options?: any): Promise<AxiosResponse<FileID>>
    • -
-
    -
  • - -
    -
    -

    Consolidate batches and entries into the minimum number of batches needed.

    -
    -
    -
    summary
    -

    Flatten batches

    -
    -
    throws
    -

    {RequiredError}

    -
    -
    memberof
    -

    ACHFilesApi

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      fileID: string
      -
      -

      File ID

      -
      -
      • -
    • -
      Optional xRequestID: undefined | string
      -
      • -
    • -
      Optional xIdempotencyKey: undefined | string
      -
      • -
    • -
      Optional options: any
      -
      • -
    -

    Returns Promise<AxiosResponse<FileID>>

    -
    • -
-
-
- -

getFileBatch

-
    -
  • getFileBatch(fileID: string, batchID: string, xRequestID?: undefined | string, options?: any): Promise<AxiosResponse<Batch>>
    • -
-
    -
  • - -
    -
    -

    Get a specific Batch on a File

    -
    -
    -
    summary
    -

    Get Batch

    -
    -
    throws
    -

    {RequiredError}

    -
    -
    memberof
    -

    ACHFilesApi

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      fileID: string
      -
      -

      File ID

      -
      -
      • -
    • -
      batchID: string
      -
      -

      Batch ID

      -
      -
      • -
    • -
      Optional xRequestID: undefined | string
      -
      • -
    • -
      Optional options: any
      -
      • -
    -

    Returns Promise<AxiosResponse<Batch>>

    -
    • -
-
-
- -

getFileBatches

-
    -
  • getFileBatches(fileID: string, xRequestID?: undefined | string, options?: any): Promise<AxiosResponse<Batch[]>>
    • -
-
    -
  • - -
    -
    -

    Get the batches on a File.

    -
    -
    -
    summary
    -

    Get batches

    -
    -
    throws
    -

    {RequiredError}

    -
    -
    memberof
    -

    ACHFilesApi

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      fileID: string
      -
      -

      File ID

      -
      -
      • -
    • -
      Optional xRequestID: undefined | string
      -
      • -
    • -
      Optional options: any
      -
      • -
    -

    Returns Promise<AxiosResponse<Batch[]>>

    -
    • -
-
-
- -

getFileByID

-
    -
  • getFileByID(fileID: string, xRequestID?: undefined | string, options?: any): Promise<AxiosResponse<any>>
    • -
-
    -
  • - -
    -
    -

    Get the details of an existing File using the unique File identifier that was returned upon creation.

    -
    -
    -
    summary
    -

    Retrieve a file

    -
    -
    throws
    -

    {RequiredError}

    -
    -
    memberof
    -

    ACHFilesApi

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      fileID: string
      -
      -

      File ID

      -
      -
      • -
    • -
      Optional xRequestID: undefined | string
      -
      • -
    • -
      Optional options: any
      -
      • -
    -

    Returns Promise<AxiosResponse<any>>

    -
    • -
-
-
- -

getFileContents

-
    -
  • getFileContents(fileID: string, xRequestID?: undefined | string, options?: any): Promise<AxiosResponse<string>>
    • -
-
    -
  • - -
    -
    -

    Assembles the existing file (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.

    -
    -
    -
    summary
    -

    Get file contents

    -
    -
    throws
    -

    {RequiredError}

    -
    -
    memberof
    -

    ACHFilesApi

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      fileID: string
      -
      -

      File ID

      -
      -
      • -
    • -
      Optional xRequestID: undefined | string
      -
      • -
    • -
      Optional options: any
      -
      • -
    -

    Returns Promise<AxiosResponse<string>>

    -
    • -
-
-
- -

getFiles

-
    -
  • getFiles(xRequestID?: undefined | string, options?: any): Promise<AxiosResponse<any[]>>
    • -
-
    -
  • - -
    -
    -

    List all ACH files created with the ACH service. These files are not persisted through multiple runs of the service.

    -
    -
    -
    summary
    -

    Get ACH files

    -
    -
    throws
    -

    {RequiredError}

    -
    -
    memberof
    -

    ACHFilesApi

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      Optional xRequestID: undefined | string
      -
      • -
    • -
      Optional options: any
      -
      • -
    -

    Returns Promise<AxiosResponse<any[]>>

    -
    • -
-
-
- -

ping

-
    -
  • ping(options?: any): Promise<AxiosResponse<void>>
    • -
-
    -
  • - -
    -
    -

    Check the ACH service to check if running

    -
    -
    -
    summary
    -

    Ping ACH service

    -
    -
    throws
    -

    {RequiredError}

    -
    -
    memberof
    -

    ACHFilesApi

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      Optional options: any
      -
      • -
    -

    Returns Promise<AxiosResponse<void>>

    -
    • -
-
-
- -

segmentFile

-
    -
  • segmentFile(fileID: string, xRequestID?: undefined | string, xIdempotencyKey?: undefined | string, options?: any): Promise<AxiosResponse<SegmentedFiles>>
    • -
-
    -
  • - -
    -
    -

    Split one file into two. One with only debits and one with only credits.

    -
    -
    -
    summary
    -

    Segment file

    -
    -
    throws
    -

    {RequiredError}

    -
    -
    memberof
    -

    ACHFilesApi

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      fileID: string
      -
      -

      File ID

      -
      -
      • -
    • -
      Optional xRequestID: undefined | string
      -
      • -
    • -
      Optional xIdempotencyKey: undefined | string
      -
      • -
    • -
      Optional options: any
      -
      • -
    -

    Returns Promise<AxiosResponse<SegmentedFiles>>

    -
    • -
-
-
- -

validateFile

-
    -
  • validateFile(fileID: string, xRequestID?: undefined | string, validateOpts?: ValidateOpts, options?: any): Promise<AxiosResponse<Error>>
    • -
-
    -
  • - -
    -
    -

    Validates the existing file. You need only supply the unique File identifier that was returned upon creation.

    -
    -
    -
    summary
    -

    Validate file

    -
    -
    throws
    -

    {RequiredError}

    -
    -
    memberof
    -

    ACHFilesApi

    -
    -
    -
    -

    Parameters

    -
      -
    • -
      fileID: string
      -
      -

      File ID

      -
      -
      • -
    • -
      Optional xRequestID: undefined | string
      -
      • -
    • -
      Optional validateOpts: ValidateOpts
      -
      • -
    • -
      Optional options: any
      -
      • -
    -

    Returns Promise<AxiosResponse<Error>>

    -
    • -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Class
    • -
  • Method
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
    -
  • Inherited constructor
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/classes/_base_.baseapi.html b/docs/classes/_base_.baseapi.html deleted file mode 100644 index e47d41e..0000000 --- a/docs/classes/_base_.baseapi.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - BaseAPI | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Class BaseAPI

-
-
-
-
-
-
-
-
-
-
export
-
-
-
-
-
-

Hierarchy

- -
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

Protected axios

-
axios: AxiosInstance
- -
-
- -

Protected basePath

-
basePath: string
- -
-
- -

Protected configuration

-
configuration: Configuration | undefined
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Class
    • -
  • Constructor
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
    -
  • Protected property
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/classes/_base_.requirederror.html b/docs/classes/_base_.requirederror.html deleted file mode 100644 index 23237f4..0000000 --- a/docs/classes/_base_.requirederror.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - RequiredError | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Class RequiredError

-
-
-
-
-
-
-
-
-
-
export
-
-
-
-
-
-

Hierarchy

-
    -
  • - Error -
      -
    • - RequiredError -
      • -
    -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

-
    -
  • new RequiredError(field: string, msg?: undefined | string): RequiredError
    • -
- -
-
-
-

Properties

-
- -

field

-
field: string
- -
-
- -

message

-
message: string
- -
-
- -

name

-
name: "RequiredError" = "RequiredError"
- -
-
- -

Optional stack

-
stack: undefined | string
- -
-
- -

Static Error

-
Error: ErrorConstructor
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Class
    • -
  • Constructor
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
    -
  • Inherited property
    • -
-
    -
  • Static property
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/classes/_configuration_.configuration.html b/docs/classes/_configuration_.configuration.html deleted file mode 100644 index c34403d..0000000 --- a/docs/classes/_configuration_.configuration.html +++ /dev/null @@ -1,352 +0,0 @@ - - - - - - Configuration | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Class Configuration

-
-
-
-
-
-
-
-

Hierarchy

-
    -
  • - Configuration -
    • -
-
-
-

Index

-
-
-
-

Constructors

- -
-
-

Properties

- -
-
-
-
-
-

Constructors

-
- -

constructor

- - -
-
-
-

Properties

-
- -

Optional accessToken

-
accessToken: string | ((name?: undefined | string, scopes?: string[]) => string)
- -
-
-

parameter for oauth2 security

-
-
-
param
-

security name

-
-
param
-

oauth2 scope

-
-
memberof
-

Configuration

-
-
-
-
-
- -

Optional apiKey

-
apiKey: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>)
- -
-
-

parameter for apiKey security

-
-
-
param
-

security name

-
-
memberof
-

Configuration

-
-
-
-
-
- -

Optional baseOptions

-
baseOptions: any
- -
-
-

base options for axios calls

-
-
-
memberof
-

Configuration

-
-
-
-
-
- -

Optional basePath

-
basePath: undefined | string
- -
-
-

override base path

-
-
-
memberof
-

Configuration

-
-
-
-
-
- -

Optional password

-
password: undefined | string
- -
-
-

parameter for basic security

-
-
-
memberof
-

Configuration

-
-
-
-
-
- -

Optional username

-
username: undefined | string
- -
-
-

parameter for basic security

-
-
-
memberof
-

Configuration

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Class
    • -
  • Constructor
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/classes/api.ACHFilesApi.html b/docs/classes/api.ACHFilesApi.html new file mode 100644 index 0000000..ed792a6 --- /dev/null +++ b/docs/classes/api.ACHFilesApi.html @@ -0,0 +1,108 @@ +ACHFilesApi | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ACHFilesApi

+

ACHFilesApi - object-oriented interface

+
export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

addBatchToFile

  • addBatchToFile(fileID: string, batch: Batch, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>
  • +

    Append a Batch record to the specified File.

    +
    summary

    Append Batch to File

    +
    throws

    {RequiredError}

    +
    memberof

    ACHFilesApi

    +

    Parameters

    • fileID: string
      +

      File ID

      +
    • batch: Batch
    • Optional xRequestID: string
    • Optional xIdempotencyKey: string
    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<void>>

buildFile

  • buildFile(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<any>>
  • +

    Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file.

    +
    summary

    Build File

    +
    throws

    {RequiredError}

    +
    memberof

    ACHFilesApi

    +

    Parameters

    • fileID: string
      +

      File ID

      +
    • Optional xRequestID: string
    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<any>>

checkFile

  • checkFile(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Error>>
  • +

    Validates the existing File. You need only supply the unique File identifier that was returned upon creation.

    +
    summary

    Validate File

    +
    throws

    {RequiredError}

    +
    memberof

    ACHFilesApi

    +

    Parameters

    • fileID: string
      +

      File ID

      +
    • Optional xRequestID: string
    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<Error>>

createFile

  • createFile(body: string, xRequestID?: string, xIdempotencyKey?: string, requireABAOrigin?: boolean, bypassOrigin?: boolean, bypassDestination?: boolean, customTraceNumbers?: boolean, allowZeroBatches?: boolean, allowMissingFileHeader?: boolean, allowMissingFileControl?: boolean, bypassCompanyIdentificationMatch?: boolean, customReturnCodes?: boolean, unequalServiceClassCode?: boolean, options?: AxiosRequestConfig): Promise<AxiosResponse<FileID>>
  • +

    Create a new File object from either the plaintext or JSON representation.

    +
    summary

    Create File

    +
    throws

    {RequiredError}

    +
    memberof

    ACHFilesApi

    +

    Parameters

    • body: string
      +

      Content of the ACH file (in json or raw text)

      +
    • Optional xRequestID: string
    • Optional xIdempotencyKey: string
    • Optional requireABAOrigin: boolean
    • Optional bypassOrigin: boolean
    • Optional bypassDestination: boolean
    • Optional customTraceNumbers: boolean
    • Optional allowZeroBatches: boolean
    • Optional allowMissingFileHeader: boolean
    • Optional allowMissingFileControl: boolean
    • Optional bypassCompanyIdentificationMatch: boolean
    • Optional customReturnCodes: boolean
    • Optional unequalServiceClassCode: boolean
    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<FileID>>

deleteACHFile

  • deleteACHFile(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>
  • +

    Permanently deletes a File and associated Batches. It cannot be undone.

    +
    summary

    Delete File

    +
    throws

    {RequiredError}

    +
    memberof

    ACHFilesApi

    +

    Parameters

    • fileID: string
      +

      File ID

      +
    • Optional xRequestID: string
    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<void>>

deleteFileBatch

  • deleteFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>
  • +

    Delete a Batch from a File.

    +
    summary

    Delete Batch

    +
    throws

    {RequiredError}

    +
    memberof

    ACHFilesApi

    +

    Parameters

    • fileID: string
      +

      File ID

      +
    • batchID: string
      +

      Batch ID

      +
    • Optional xRequestID: string
    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<void>>

flattenFile

  • flattenFile(fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<FileID>>
  • +

    Consolidate Batches and Entries into the minimum number of Batches needed.

    +
    summary

    Flatten Batches

    +
    throws

    {RequiredError}

    +
    memberof

    ACHFilesApi

    +

    Parameters

    • fileID: string
      +

      File ID

      +
    • Optional xRequestID: string
    • Optional xIdempotencyKey: string
    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<FileID>>

getFileBatch

  • getFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Batch>>
  • +

    Get a specific Batch on a File.

    +
    summary

    Get Batch

    +
    throws

    {RequiredError}

    +
    memberof

    ACHFilesApi

    +

    Parameters

    • fileID: string
      +

      File ID

      +
    • batchID: string
      +

      Batch ID

      +
    • Optional xRequestID: string
    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<Batch>>

getFileBatches

  • getFileBatches(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Batch[]>>
  • +

    Get the Batches on a File.

    +
    summary

    Get Batches

    +
    throws

    {RequiredError}

    +
    memberof

    ACHFilesApi

    +

    Parameters

    • fileID: string
      +

      File ID

      +
    • Optional xRequestID: string
    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<Batch[]>>

getFileByID

  • getFileByID(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<any>>
  • +

    Get the details of an existing File using the unique File identifier that was returned upon creation.

    +
    summary

    Retrieve File

    +
    throws

    {RequiredError}

    +
    memberof

    ACHFilesApi

    +

    Parameters

    • fileID: string
      +

      File ID

      +
    • Optional xRequestID: string
    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<any>>

getFileContents

  • getFileContents(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<string>>
  • +

    Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.

    +
    summary

    Get File Contents

    +
    throws

    {RequiredError}

    +
    memberof

    ACHFilesApi

    +

    Parameters

    • fileID: string
      +

      File ID

      +
    • Optional xRequestID: string
    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<string>>

getFiles

  • getFiles(xRequestID?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<any[]>>
  • +

    List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service.

    +
    summary

    List Files

    +
    throws

    {RequiredError}

    +
    memberof

    ACHFilesApi

    +

    Parameters

    • Optional xRequestID: string
    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<any[]>>

ping

  • ping(options?: AxiosRequestConfig): Promise<AxiosResponse<void>>
  • +

    Check if the ACH service is running.

    +
    summary

    Ping ACH service

    +
    throws

    {RequiredError}

    +
    memberof

    ACHFilesApi

    +

    Parameters

    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<void>>

segmentFile

  • segmentFile(fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<SegmentedFiles>>
  • +

    Split one File into two. One with only debits and one with only credits.

    +
    summary

    Segment File

    +
    throws

    {RequiredError}

    +
    memberof

    ACHFilesApi

    +

    Parameters

    • fileID: string
      +

      File ID

      +
    • Optional xRequestID: string
    • Optional xIdempotencyKey: string
    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<SegmentedFiles>>

validateFile

  • validateFile(fileID: string, xRequestID?: string, validateOpts?: ValidateOpts, options?: AxiosRequestConfig): Promise<AxiosResponse<Error>>
  • +

    Validates the existing File. You need only supply the unique File identifier that was returned upon creation.

    +
    summary

    Validate File (Custom)

    +
    throws

    {RequiredError}

    +
    memberof

    ACHFilesApi

    +

    Parameters

    • fileID: string
      +

      File ID

      +
    • Optional xRequestID: string
    • Optional validateOpts: ValidateOpts
    • Optional options: AxiosRequestConfig

    Returns Promise<AxiosResponse<Error>>

Legend

  • Variable
  • Function
  • Type alias
  • Class
  • Method
  • Interface
  • Inherited constructor

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/base.BaseAPI.html b/docs/classes/base.BaseAPI.html new file mode 100644 index 0000000..c3e3482 --- /dev/null +++ b/docs/classes/base.BaseAPI.html @@ -0,0 +1 @@ +BaseAPI | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseAPI

export

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Legend

  • Variable
  • Function
  • Type alias
  • Class
  • Constructor
  • Interface
  • Protected property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/base.RequiredError.html b/docs/classes/base.RequiredError.html new file mode 100644 index 0000000..45f435e --- /dev/null +++ b/docs/classes/base.RequiredError.html @@ -0,0 +1 @@ +RequiredError | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RequiredError

export

Hierarchy

  • Error
    • RequiredError

Index

Constructors

Properties

Constructors

constructor

Properties

field

field: string

message

message: string

name

name: "RequiredError" = "RequiredError"

Optional stack

stack?: string

Legend

  • Variable
  • Function
  • Type alias
  • Class
  • Constructor
  • Property
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/configuration.Configuration.html b/docs/classes/configuration.Configuration.html new file mode 100644 index 0000000..705febd --- /dev/null +++ b/docs/classes/configuration.Configuration.html @@ -0,0 +1,36 @@ +Configuration | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Configuration

Hierarchy

  • Configuration

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional accessToken

accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>)
+

parameter for oauth2 security

+
param name

security name

+
param scopes

oauth2 scope

+
memberof

Configuration

+

Optional apiKey

apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>)
+

parameter for apiKey security

+
param name

security name

+
memberof

Configuration

+

Optional baseOptions

baseOptions?: any
+

base options for axios calls

+
memberof

Configuration

+

Optional basePath

basePath?: string
+

override base path

+
memberof

Configuration

+

Optional formDataCtor

formDataCtor?: (new () => any)

Type declaration

    • new (): any
    • +

      The FormData constructor that will be used to create multipart form data +requests. You can inject this here so that execution environments that +do not support the FormData class can still run the generated client.

      +

      Returns any

Optional password

password?: string
+

parameter for basic security

+
memberof

Configuration

+

Optional username

username?: string
+

parameter for basic security

+
memberof

Configuration

+

Methods

isJsonMime

  • isJsonMime(mime: string): boolean
  • +

    Check if the given MIME is a JSON MIME. +JSON MIME examples: + application/json + application/json; charset=UTF8 + APPLICATION/JSON + application/vnd.company+json

    +

    Parameters

    • mime: string
      +

      MIME (Multipurpose Internet Mail Extensions)

      +

    Returns boolean

    True if the given MIME is JSON, false otherwise.

    +

Legend

  • Class
  • Constructor
  • Property
  • Method
  • Variable
  • Function
  • Type alias
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/_api_.offsetaccounttypeenum.html b/docs/enums/_api_.offsetaccounttypeenum.html deleted file mode 100644 index 7741d0d..0000000 --- a/docs/enums/_api_.offsetaccounttypeenum.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - OffsetAccountTypeEnum | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Enumeration OffsetAccountTypeEnum

-
-
-
-
-
-
-
-
-
-
export
-
-
-
-
-
-

Index

-
-
-
-

Enumeration members

- -
-
-
-
-
-

Enumeration members

-
- -

Checking

-
Checking: = "checking"
- -
-
- -

Savings

-
Savings: = "savings"
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/globals.html b/docs/globals.html deleted file mode 100644 index 2059111..0000000 --- a/docs/globals.html +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

ach-node-sdk

-
-
-
-
-
-
-
-

Index

-
-
-
-

Modules

- -
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 61b3d2d..79d7a62 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,161 +1,51 @@ - - - - - - ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

ach-node-sdk

-
-
-
-
-
-
-
- -

ACH Node SDK

- -

Generated Typescript SDK for the moov-io/ach service.

- -

Installation

- -

Install in your Node.js or Typescript project using npm:

- 
npm install ach-node-sdk
- -

Usage

- -

Using require sytax:

- 
const { ACHFilesApi, Configuration } = require('ach-node-sdk');
-

Using import syntax:

- 
import { ACHFilesApi, Configuration } from 'ach-node-sdk';
-

Build the client instance:

- 
const configuration = new Configuration({ basePath: 'https://ach.mycompany.com' });
-const achFilesApi = new ACHFilesApi(configuration);
-

Call functions on the client:

- 
achFilesApi.getFiles().then(response => console.log(response.data));
-=> Promise{ <pending> }
-{ files: [], error: null };
-

See the generated documentation for more detail.

- -

Building Locally

- -

Run the following to build our library locally.

- 
tsc --build tsconfig.json
- -

Generating Docs

- -

Run the following for generating the documentation.

- 
# Install typedoc if needed
-npm install -g typedoc
+ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
 
Menu
 ach-node-sdk 

+
+  
ACH Node SDK

+
+
Generated Typescript SDK for the moov-io/ach service.

 
-# Generate the documentation
-typedoc --out docs/ *.ts
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file + +

Installation

+ +

Install in your Node.js or Typescript project using npm:

+
npm install ach-node-sdk
+
+ + +

Usage

+ +

Using require sytax:

+
const { ACHFilesApi, Configuration } = require('ach-node-sdk');
+
+

Using import syntax:

+
import { ACHFilesApi, Configuration } from 'ach-node-sdk';
+
+

Build the client instance:

+
const configuration = new Configuration({ basePath: 'https://ach.mycompany.com' });
const achFilesApi = new ACHFilesApi(configuration);
+
+

Call functions on the client:

+
achFilesApi.getFiles().then(response => console.log(response.data));
=> Promise{ <pending> }
{ files: [], error: null };
+
+

See the generated documentation for more detail.

+ + +

Building Locally

+ +

Run the following to build our library locally.

+
tsc --build tsconfig.json
+
+ + +

Generating Client

+ +

Run the following for generating the TypeScript client.

+
make client
+
+ + +

Generating Docs

+ +

Run the following for generating the documentation.

+
make docs
+
+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_api_.addenda02.html b/docs/interfaces/_api_.addenda02.html deleted file mode 100644 index 41b4d2c..0000000 --- a/docs/interfaces/_api_.addenda02.html +++ /dev/null @@ -1,564 +0,0 @@ - - - - - - Addenda02 | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface Addenda02

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

Addenda02

-
-
-
-
-
-

Hierarchy

-
    -
  • - Addenda02 -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional authorizationCodeOrExpireDate

-
authorizationCodeOrExpireDate: undefined | string
- -
-
-

Indicates the code that a card authorization center has furnished to the merchant.

-
-
-
memberof
-

Addenda02

-
-
-
-
-
- -

Optional id

-
id: undefined | string
- -
-
-

Client defined string used as a reference to this record.

-
-
-
memberof
-

Addenda02

-
-
-
-
-
- -

Optional referenceInformationOne

-
referenceInformationOne: undefined | string
- -
-
-

ReferenceInformationOne may be used for additional reference numbers, identification numbers, or codes that the merchant needs to identify the particular transaction or customer.

-
-
-
memberof
-

Addenda02

-
-
-
-
-
- -

Optional referenceInformationTwo

-
referenceInformationTwo: undefined | string
- -
-
-

ReferenceInformationTwo may be used for additional reference numbers, identification numbers, or codes that the merchant needs to identify the particular transaction or customer.

-
-
-
memberof
-

Addenda02

-
-
-
-
-
- -

Optional terminalCity

-
terminalCity: undefined | string
- -
-
-

Identifies the city in which the electronic terminal is located.

-
-
-
memberof
-

Addenda02

-
-
-
-
-
- -

Optional terminalIdentificationCode

-
terminalIdentificationCode: undefined | string
- -
-
-

TerminalIdentificationCode identifies an Electronic terminal with a unique code that allows a terminal owner and/or switching network to identify the terminal at which an Entry originated.

-
-
-
memberof
-

Addenda02

-
-
-
-
-
- -

Optional terminalLocation

-
terminalLocation: undefined | string
- -
-
-

Identifies the specific location of a terminal (i.e., street names of an intersection, address, etc.) in accordance with the requirements of Regulation E.

-
-
-
memberof
-

Addenda02

-
-
-
-
-
- -

Optional terminalState

-
terminalState: undefined | string
- -
-
-

Identifies the state in which the electronic terminal is located

-
-
-
memberof
-

Addenda02

-
-
-
-
-
- -

Optional traceNumber

-
traceNumber: undefined | string
- -
-
-

Entry Detail Trace Number

-
-
-
memberof
-

Addenda02

-
-
-
-
-
- -

Optional transactionDate

-
transactionDate: undefined | string
- -
-
-

MMDD formatted timestamp identifies the date on which the transaction occurred.

-
-
-
memberof
-

Addenda02

-
-
-
-
-
- -

Optional transactionSerialNumber

-
transactionSerialNumber: undefined | string
- -
-
-

TransactionSerialNumber is assigned by the terminal at the time the transaction is originated. The number, with the Terminal Identification Code, serves as an audit trail for the transaction and is usually assigned in ascending sequence.

-
-
-
memberof
-

Addenda02

-
-
-
-
-
- -

Optional typeCode

-
typeCode: undefined | string
- -
-
-

02 - NACHA regulations

-
-
-
memberof
-

Addenda02

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.addenda05.html b/docs/interfaces/_api_.addenda05.html deleted file mode 100644 index 23ee8a7..0000000 --- a/docs/interfaces/_api_.addenda05.html +++ /dev/null @@ -1,396 +0,0 @@ - - - - - - Addenda05 | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface Addenda05

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

Addenda05

-
-
-
-
-
-

Hierarchy

-
    -
  • - Addenda05 -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional entryDetailSequenceNumber

-
entryDetailSequenceNumber: undefined | number
- -
-
-

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

-
-
-
memberof
-

Addenda05

-
-
-
-
-
- -

Optional id

-
id: undefined | string
- -
-
-

Client defined string used as a reference to this record.

-
-
-
memberof
-

Addenda05

-
-
-
-
-
- -

Optional paymentRelatedInformation

-
paymentRelatedInformation: undefined | string
- -
-
-

Text for describing the related payment

-
-
-
memberof
-

Addenda05

-
-
-
-
-
- -

Optional sequenceNumber

-
sequenceNumber: undefined | number
- -
-
-

SequenceNumber is consecutively assigned to each Addenda05 Record following an Entry Detail Record. The first addenda05 sequence number must always be a 1.

-
-
-
memberof
-

Addenda05

-
-
-
-
-
- -

Optional typeCode

-
typeCode: undefined | string
- -
-
-

05 - NACHA regulations

-
-
-
memberof
-

Addenda05

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.addenda10.html b/docs/interfaces/_api_.addenda10.html deleted file mode 100644 index 126428b..0000000 --- a/docs/interfaces/_api_.addenda10.html +++ /dev/null @@ -1,444 +0,0 @@ - - - - - - Addenda10 | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface Addenda10

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

Addenda10

-
-
-
-
-
-

Hierarchy

-
    -
  • - Addenda10 -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional entryDetailSequenceNumber

-
entryDetailSequenceNumber: undefined | number
- -
-
-

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

-
-
-
memberof
-

Addenda10

-
-
-
-
-
- -

Optional foreignPaymentAmount

-
foreignPaymentAmount: undefined | number
- -
-
-

For inbound IAT payments this field should contain the USD amount or may be blank.

-
-
-
memberof
-

Addenda10

-
-
-
-
-
- -

Optional foreignTraceNumber

-
foreignTraceNumber: undefined | string
- -
-
-

Trace number

-
-
-
memberof
-

Addenda10

-
-
-
-
-
- -

Optional id

-
id: undefined | string
- -
-
-

Client defined string used as a reference to this record.

-
-
-
memberof
-

Addenda10

-
-
-
-
-
- -

Optional name

-
name: undefined | string
- -
-
-

Receiving Company Name/Individual Name

-
-
-
memberof
-

Addenda10

-
-
-
-
-
- -

Optional transactionTypeCode

-
transactionTypeCode: undefined | string
- -
-
-

Transaction Type Code Describes the type of payment ANN = Annuity BUS = Business/Commercial DEP = Deposit LOA = Loan MIS = Miscellaneous MOR = Mortgage PEN = Pension RLS = Rent/Lease REM = Remittance2 SAL = Salary/Payroll TAX = Tax TEL = Telephone-Initiated Transaction WEB = Internet-Initiated Transaction ARC = Accounts Receivable Entry BOC = Back Office Conversion Entry POP = Point of Purchase Entry RCK = Re-presented Check Entry

-
-
-
memberof
-

Addenda10

-
-
-
-
-
- -

Optional typeCode

-
typeCode: undefined | string
- -
-
-

10 - NACHA regulations

-
-
-
memberof
-

Addenda10

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.addenda11.html b/docs/interfaces/_api_.addenda11.html deleted file mode 100644 index 7b0b690..0000000 --- a/docs/interfaces/_api_.addenda11.html +++ /dev/null @@ -1,396 +0,0 @@ - - - - - - Addenda11 | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface Addenda11

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

Addenda11

-
-
-
-
-
-

Hierarchy

-
    -
  • - Addenda11 -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional entryDetailSequenceNumber

-
entryDetailSequenceNumber: undefined | number
- -
-
-

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

-
-
-
memberof
-

Addenda11

-
-
-
-
-
- -

Optional id

-
id: undefined | string
- -
-
-

Client defined string used as a reference to this record.

-
-
-
memberof
-

Addenda11

-
-
-
-
-
- -

Optional originatorName

-
originatorName: undefined | string
- -
-
-

Originators name (your company name / name)

-
-
-
memberof
-

Addenda11

-
-
-
-
-
- -

Optional originatorStreetAddress

-
originatorStreetAddress: undefined | string
- -
-
-

Originators street address

-
-
-
memberof
-

Addenda11

-
-
-
-
-
- -

Optional typeCode

-
typeCode: undefined | string
- -
-
-

10 - NACHA regulations

-
-
-
memberof
-

Addenda11

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.addenda12.html b/docs/interfaces/_api_.addenda12.html deleted file mode 100644 index 76e4f2b..0000000 --- a/docs/interfaces/_api_.addenda12.html +++ /dev/null @@ -1,396 +0,0 @@ - - - - - - Addenda12 | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface Addenda12

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

Addenda12

-
-
-
-
-
-

Hierarchy

-
    -
  • - Addenda12 -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional entryDetailSequenceNumber

-
entryDetailSequenceNumber: undefined | number
- -
-
-

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

-
-
-
memberof
-

Addenda12

-
-
-
-
-
- -

Optional id

-
id: undefined | string
- -
-
-

Client defined string used as a reference to this record.

-
-
-
memberof
-

Addenda12

-
-
-
-
-
- -

Optional originatorCityStateProvince

-
originatorCityStateProvince: undefined | string
- -
-
-

Originator City & State / Province Data elements City and State / Province should be separated with an asterisk (*) as a delimiter and the field should end with a backslash (\).

-
-
-
memberof
-

Addenda12

-
-
-
-
-
- -

Optional originatorCountryPostalCode

-
originatorCountryPostalCode: undefined | string
- -
-
-

Originator Country & Postal Code Data elements must be separated by an asterisk (*) and must end with a backslash (\)

-
-
-
memberof
-

Addenda12

-
-
-
-
-
- -

Optional typeCode

-
typeCode: undefined | string
- -
-
-

10 - NACHA regulations

-
-
-
memberof
-

Addenda12

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.addenda13.html b/docs/interfaces/_api_.addenda13.html deleted file mode 100644 index 46e0a7f..0000000 --- a/docs/interfaces/_api_.addenda13.html +++ /dev/null @@ -1,420 +0,0 @@ - - - - - - Addenda13 | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface Addenda13

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

Addenda13

-
-
-
-
-
-

Hierarchy

-
    -
  • - Addenda13 -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional ODFIBranchCountryCode

-
ODFIBranchCountryCode: undefined | string
- -
-
-

Originating DFI Branch Country Code USb = United States //("b" indicates a blank space) For Inbound IATs: This 3 position field contains a 2-character code as approved by the International Organization for Standardization (ISO) used to identify the country in which the branch of the bank that originated the entry is located. Values for other countries can be found on the International Organization for Standardization website: www.iso.org.

-
-
-
memberof
-

Addenda13

-
-
-
-
-
- -

Optional ODFIIDNumberQualifier

-
ODFIIDNumberQualifier: undefined | string
- -
-
-

Originating DFI Identification Number Qualifier For Inbound IATs: The 2-digit code that identifies the numbering scheme used in the Foreign DFI Identification Number field 01 = National Clearing System 02 = BIC Code 03 = IBAN Code

-
-
-
memberof
-

Addenda13

-
-
-
-
-
- -

Optional ODFIName

-
ODFIName: undefined | string
- -
-
-

Originating DFI Name For Outbound IAT Entries, this field must contain the name of the U.S. ODFI. For Inbound IATs: Name of the foreign bank providing funding for the payment transaction

-
-
-
memberof
-

Addenda13

-
-
-
-
-
- -

Optional entryDetailSequenceNumber

-
entryDetailSequenceNumber: undefined | number
- -
-
-

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

-
-
-
memberof
-

Addenda13

-
-
-
-
-
- -

Optional id

-
id: undefined | string
- -
-
-

Client defined string used as a reference to this record.

-
-
-
memberof
-

Addenda13

-
-
-
-
-
- -

Optional typeCode

-
typeCode: undefined | string
- -
-
-

10 - NACHA regulations

-
-
-
memberof
-

Addenda13

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.addenda14.html b/docs/interfaces/_api_.addenda14.html deleted file mode 100644 index 8609d02..0000000 --- a/docs/interfaces/_api_.addenda14.html +++ /dev/null @@ -1,444 +0,0 @@ - - - - - - Addenda14 | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface Addenda14

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

Addenda14

-
-
-
-
-
-

Hierarchy

-
    -
  • - Addenda14 -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional RDFIBranchCountryCode

-
RDFIBranchCountryCode: undefined | string
- -
-
-

Receiving DFI Branch Country Code USb" = United States ("b" indicates a blank space) This 3 position field contains a 2-character code as approved by the International Organization for Standardization (ISO) used to identify the country in which the branch of the bank that receives the entry is located. Values for other countries can be found on the International Organization for Standardization website: www.iso.org

-
-
-
memberof
-

Addenda14

-
-
-
-
-
- -

Optional RDFIIDNumberQualifier

-
RDFIIDNumberQualifier: undefined | string
- -
-
-

Receiving DFI Identification Number Qualifier The 2-digit code that identifies the numbering scheme used in the Receiving DFI Identification Number field 01 = National Clearing System 02 = BIC Code 03 = IBAN Code

-
-
-
memberof
-

Addenda14

-
-
-
-
-
- -

Optional RDFIIdentification

-
RDFIIdentification: undefined | string
- -
-
-

This field contains the bank identification number of the DFI at which the Receiver maintains his account.

-
-
-
memberof
-

Addenda14

-
-
-
-
-
- -

Optional RDFIName

-
RDFIName: undefined | string
- -
-
-

Name of the Receiver bank

-
-
-
memberof
-

Addenda14

-
-
-
-
-
- -

Optional entryDetailSequenceNumber

-
entryDetailSequenceNumber: undefined | number
- -
-
-

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

-
-
-
memberof
-

Addenda14

-
-
-
-
-
- -

Optional id

-
id: undefined | string
- -
-
-

Client defined string used as a reference to this record.

-
-
-
memberof
-

Addenda14

-
-
-
-
-
- -

Optional typeCode

-
typeCode: undefined | string
- -
-
-

10 - NACHA regulations

-
-
-
memberof
-

Addenda14

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.addenda15.html b/docs/interfaces/_api_.addenda15.html deleted file mode 100644 index c48d677..0000000 --- a/docs/interfaces/_api_.addenda15.html +++ /dev/null @@ -1,396 +0,0 @@ - - - - - - Addenda15 | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface Addenda15

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

Addenda15

-
-
-
-
-
-

Hierarchy

-
    -
  • - Addenda15 -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional entryDetailSequenceNumber

-
entryDetailSequenceNumber: undefined | number
- -
-
-

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

-
-
-
memberof
-

Addenda15

-
-
-
-
-
- -

Optional id

-
id: undefined | string
- -
-
-

Client defined string used as a reference to this record.

-
-
-
memberof
-

Addenda15

-
-
-
-
-
- -

Optional receiverIDNumber

-
receiverIDNumber: undefined | string
- -
-
-

Receiver Identification Number contains the accounting number by which the Originator is known to the Receiver for descriptive purposes. NACHA Rules recommend but do not require the RDFI to print the contents of this field on the receiver's statement.

-
-
-
memberof
-

Addenda15

-
-
-
-
-
- -

Optional receiverStreetAddress

-
receiverStreetAddress: undefined | string
- -
-
-

Receiver's physical address

-
-
-
memberof
-

Addenda15

-
-
-
-
-
- -

Optional typeCode

-
typeCode: undefined | string
- -
-
-

10 - NACHA regulations

-
-
-
memberof
-

Addenda15

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.addenda16.html b/docs/interfaces/_api_.addenda16.html deleted file mode 100644 index 65c2c62..0000000 --- a/docs/interfaces/_api_.addenda16.html +++ /dev/null @@ -1,396 +0,0 @@ - - - - - - Addenda16 | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface Addenda16

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

Addenda16

-
-
-
-
-
-

Hierarchy

-
    -
  • - Addenda16 -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional entryDetailSequenceNumber

-
entryDetailSequenceNumber: undefined | number
- -
-
-

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

-
-
-
memberof
-

Addenda16

-
-
-
-
-
- -

Optional id

-
id: undefined | string
- -
-
-

Client defined string used as a reference to this record.

-
-
-
memberof
-

Addenda16

-
-
-
-
-
- -

Optional receiverCityStateProvince

-
receiverCityStateProvince: undefined | string
- -
-
-

Receiver City & State / Province Data elements City and State / Province should be separated with an asterisk (*) as a delimiter and the field should end with a backslash (\).

-
-
-
memberof
-

Addenda16

-
-
-
-
-
- -

Optional receiverCountryPostalCode

-
receiverCountryPostalCode: undefined | string
- -
-
-

Receiver Country & Postal Code Data elements must be separated by an asterisk (*) and must end with a backslash (\)

-
-
-
memberof
-

Addenda16

-
-
-
-
-
- -

Optional typeCode

-
typeCode: undefined | string
- -
-
-

10 - NACHA regulations

-
-
-
memberof
-

Addenda16

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.addenda17.html b/docs/interfaces/_api_.addenda17.html deleted file mode 100644 index bf4695c..0000000 --- a/docs/interfaces/_api_.addenda17.html +++ /dev/null @@ -1,396 +0,0 @@ - - - - - - Addenda17 | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface Addenda17

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

Addenda17

-
-
-
-
-
-

Hierarchy

-
    -
  • - Addenda17 -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional entryDetailSequenceNumber

-
entryDetailSequenceNumber: undefined | number
- -
-
-

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

-
-
-
memberof
-

Addenda17

-
-
-
-
-
- -

Optional id

-
id: undefined | string
- -
-
-

Client defined string used as a reference to this record.

-
-
-
memberof
-

Addenda17

-
-
-
-
-
- -

Optional paymentRelatedInformation

-
paymentRelatedInformation: undefined | string
- -
-
-

Additional information related to the payment

-
-
-
memberof
-

Addenda17

-
-
-
-
-
- -

Optional sequenceNumber

-
sequenceNumber: undefined | number
- -
-
-

SequenceNumber is consecutively assigned to each Addenda17 Record following an Entry Detail Record. The first addenda17 sequence number must always be a 1.

-
-
-
memberof
-

Addenda17

-
-
-
-
-
- -

Optional typeCode

-
typeCode: undefined | string
- -
-
-

10 - NACHA regulations

-
-
-
memberof
-

Addenda17

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.addenda18.html b/docs/interfaces/_api_.addenda18.html deleted file mode 100644 index 398f775..0000000 --- a/docs/interfaces/_api_.addenda18.html +++ /dev/null @@ -1,468 +0,0 @@ - - - - - - Addenda18 | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface Addenda18

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

Addenda18

-
-
-
-
-
-

Hierarchy

-
    -
  • - Addenda18 -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional entryDetailSequenceNumber

-
entryDetailSequenceNumber: undefined | number
- -
-
-

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

-
-
-
memberof
-

Addenda18

-
-
-
-
-
- -

Optional foreignCorrespondentBankBranchCountryCode

-
foreignCorrespondentBankBranchCountryCode: undefined | string
- -
-
-

Foreign Correspondent Bank Branch Country Code contains the two-character code, as approved by the International Organization for Standardization (ISO), to identify the country in which the branch of the Foreign Correspondent Bank is located. Values can be found on the International Organization for Standardization website: www.iso.org

-
-
-
memberof
-

Addenda18

-
-
-
-
-
- -

Optional foreignCorrespondentBankIDNumber

-
foreignCorrespondentBankIDNumber: undefined | string
- -
-
-

Foreign Correspondent Bank Identification Number contains the bank ID number of the Foreign Correspondent Bank

-
-
-
memberof
-

Addenda18

-
-
-
-
-
- -

Optional foreignCorrespondentBankIDNumberQualifier

-
foreignCorrespondentBankIDNumberQualifier: undefined | string
- -
-
-

Foreign Correspondent Bank Identification Number Qualifier contains a 2-digit code that identifies the numbering scheme used in the Foreign Correspondent Bank Identification Number field. Code values for this field are "01" = National Clearing System "02" = BIC Code "03" = IBAN Code

-
-
-
memberof
-

Addenda18

-
-
-
-
-
- -

Optional foreignCorrespondentBankName

-
foreignCorrespondentBankName: undefined | string
- -
-
-

Name of the Foreign Correspondent Bank

-
-
-
memberof
-

Addenda18

-
-
-
-
-
- -

Optional id

-
id: undefined | string
- -
-
-

Client defined string used as a reference to this record.

-
-
-
memberof
-

Addenda18

-
-
-
-
-
- -

Optional sequenceNumber

-
sequenceNumber: undefined | number
- -
-
-

SequenceNumber is consecutively assigned to each Addenda17 Record following an Entry Detail Record. The first addenda17 sequence number must always be a 1.

-
-
-
memberof
-

Addenda18

-
-
-
-
-
- -

Optional typeCode

-
typeCode: undefined | string
- -
-
-

10 - NACHA regulations

-
-
-
memberof
-

Addenda18

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.addenda98.html b/docs/interfaces/_api_.addenda98.html deleted file mode 100644 index a56d02d..0000000 --- a/docs/interfaces/_api_.addenda98.html +++ /dev/null @@ -1,444 +0,0 @@ - - - - - - Addenda98 | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface Addenda98

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

Addenda98

-
-
-
-
-
-

Hierarchy

-
    -
  • - Addenda98 -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional changeCode

-
changeCode: undefined | string
- -
-
-

ChangeCode field contains a standard code used by an ACH Operator or RDFI to describe the reason for a change Entry.

-
-
-
memberof
-

Addenda98

-
-
-
-
-
- -

Optional correctedData

-
correctedData: undefined | string
- -
-
-

Correct field value of what ChangeCode references

-
-
-
memberof
-

Addenda98

-
-
-
-
-
- -

Optional id

-
id: undefined | string
- -
-
-

Client defined string used as a reference to this record.

-
-
-
memberof
-

Addenda98

-
-
-
-
-
- -

Optional originalDFI

-
originalDFI: undefined | string
- -
-
-

The Receiving DFI Identification (addenda.RDFIIdentification) as originally included on the forward Entry or Prenotification that the RDFI is returning or correcting.

-
-
-
memberof
-

Addenda98

-
-
-
-
-
- -

Optional originalTrace

-
originalTrace: undefined | string
- -
-
-

OriginalTrace This field contains the Trace Number as originally included on the forward Entry or Prenotification. The RDFI must include the Original Entry Trace Number in the Addenda Record of an Entry being returned to an ODFI, in the Addenda Record of an 98, within an Acknowledgment Entry, or with an RDFI request for a copy of an authorization.

-
-
-
memberof
-

Addenda98

-
-
-
-
-
- -

Optional traceNumber

-
traceNumber: undefined | string
- -
-
-

Entry Detail Trace Number

-
-
-
memberof
-

Addenda98

-
-
-
-
-
- -

Optional typeCode

-
typeCode: undefined | string
- -
-
-

98 - NACHA regulations

-
-
-
memberof
-

Addenda98

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.addenda99.html b/docs/interfaces/_api_.addenda99.html deleted file mode 100644 index 4e112fd..0000000 --- a/docs/interfaces/_api_.addenda99.html +++ /dev/null @@ -1,468 +0,0 @@ - - - - - - Addenda99 | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface Addenda99

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

Addenda99

-
-
-
-
-
-

Hierarchy

-
    -
  • - Addenda99 -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional addendaInformation

-
addendaInformation: undefined | string
- -
-
-

Information related to the return

-
-
-
memberof
-

Addenda99

-
-
-
-
-
- -

Optional dateOfDeath

-
dateOfDeath: undefined | string
- -
-
-

DateOfDeath The field date of death is to be supplied on Entries being returned for reason of death (return reason codes R14 and R15). Format YYMMDD (Y=Year, M=Month, D=Day)

-
-
-
memberof
-

Addenda99

-
-
-
-
-
- -

Optional id

-
id: undefined | string
- -
-
-

Client defined string used as a reference to this record.

-
-
-
memberof
-

Addenda99

-
-
-
-
-
- -

Optional originalDFI

-
originalDFI: undefined | string
- -
-
-

OriginalDFI field contains the Receiving DFI Identification (addenda.RDFIIdentification) as originally included on the forward Entry or Prenotification that the RDFI is returning or correcting.

-
-
-
memberof
-

Addenda99

-
-
-
-
-
- -

Optional originalTrace

-
originalTrace: undefined | string
- -
-
-

OriginalTrace This field contains the Trace Number as originally included on the forward Entry or Prenotification. The RDFI must include the Original Entry Trace Number in the Addenda Record of an Entry being returned to an ODFI, in the Addenda Record of an 98, within an Acknowledgment Entry, or with an RDFI request for a copy of an authorization.

-
-
-
memberof
-

Addenda99

-
-
-
-
-
- -

Optional returnCode

-
returnCode: undefined | string
- -
-
-

Standard code used by an ACH Operator or RDFI to describe the reason for returning an Entry.

-
-
-
memberof
-

Addenda99

-
-
-
-
-
- -

Optional traceNumber

-
traceNumber: undefined | string
- -
-
-

Matches the Entry Detail Trace Number of the entry being returned.

-
-
-
memberof
-

Addenda99

-
-
-
-
-
- -

Optional typeCode

-
typeCode: undefined | string
- -
-
-

99 - NACHA regulations

-
-
-
memberof
-

Addenda99

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.advbatchcontrol.html b/docs/interfaces/_api_.advbatchcontrol.html deleted file mode 100644 index 4ddf0f8..0000000 --- a/docs/interfaces/_api_.advbatchcontrol.html +++ /dev/null @@ -1,492 +0,0 @@ - - - - - - ADVBatchControl | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface ADVBatchControl

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

ADVBatchControl

-
-
-
-
-
-

Hierarchy

-
    -
  • - ADVBatchControl -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional ID

-
ID: undefined | string
- -
-
-

Batch ID

-
-
-
memberof
-

ADVBatchControl

-
-
-
-
-
- -

Optional ODFIIdentification

-
ODFIIdentification: undefined | string
- -
-
-

The routing number is used to identify the DFI originating entries within a given branch.

-
-
-
memberof
-

ADVBatchControl

-
-
-
-
-
- -

Optional achOperatorData

-
achOperatorData: undefined | string
- -
-
-

Alphanumeric code used to identify an ACH Operator

-
-
-
memberof
-

ADVBatchControl

-
-
-
-
-
- -

Optional batchNumber

-
batchNumber: undefined | string
- -
-
-

BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.

-
-
-
memberof
-

ADVBatchControl

-
-
-
-
-
- -

Optional entryAddendaCount

-
entryAddendaCount: undefined | number
- -
-
-

EntryAddendaCount is a tally of each Entry Detail Record and each Addenda Record processed, within either the batch or file as appropriate.

-
-
-
memberof
-

ADVBatchControl

-
-
-
-
-
- -

Optional entryHash

-
entryHash: undefined | number
- -
-
-

Validate the Receiving DFI Identification in each Entry Detail Record is hashed to provide a check against inadvertent alteration of data contents due to hardware failure or program error. In this context the Entry Hash is the sum of the corresponding fields in the Entry Detail Records on the file.

-
-
-
memberof
-

ADVBatchControl

-
-
-
-
-
- -

Optional serviceClassCode

-
serviceClassCode: undefined | number
- -
-
-

Same as ServiceClassCode in BatchHeader record

-
-
-
memberof
-

ADVBatchControl

-
-
-
-
-
- -

Optional totalCredit

-
totalCredit: undefined | number
- -
-
-

Contains accumulated Entry credit totals within the batch.

-
-
-
memberof
-

ADVBatchControl

-
-
-
-
-
- -

Optional totalDebit

-
totalDebit: undefined | number
- -
-
-

Contains accumulated Entry debit totals within the batch.

-
-
-
memberof
-

ADVBatchControl

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.adventrydetail.html b/docs/interfaces/_api_.adventrydetail.html deleted file mode 100644 index 5cf3ada..0000000 --- a/docs/interfaces/_api_.adventrydetail.html +++ /dev/null @@ -1,684 +0,0 @@ - - - - - - ADVEntryDetail | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface ADVEntryDetail

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

ADVEntryDetail

-
-
-
-
-
-

Hierarchy

-
    -
  • - ADVEntryDetail -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

DFIAccountNumber

-
DFIAccountNumber: string
- -
-
-

The receiver's bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so its space padded, no zero padded

-
-
-
memberof
-

ADVEntryDetail

-
-
-
-
-
- -

Optional ID

-
ID: undefined | string
- -
-
-

Entry Detail ID

-
-
-
memberof
-

ADVEntryDetail

-
-
-
-
-
- -

RDFIIdentification

-
RDFIIdentification: string
- -
-
-

RDFI's routing number without the last digit.

-
-
-
memberof
-

ADVEntryDetail

-
-
-
-
-
- -

Optional achOperatorData

-
achOperatorData: undefined | string
- -
-
-

Information related to the ACH opreator

-
-
-
memberof
-

ADVEntryDetail

-
-
-
-
-
- -

Optional achOperatorRoutingNumber

-
achOperatorRoutingNumber: undefined | string
- -
-
-

Routing number for ACH operator

-
-
-
memberof
-

ADVEntryDetail

-
-
-
-
-
- -

Optional addenda99

-
addenda99: Array<Addenda99>
- -
-
-

Addenda99 record for the Entry Detail

-
-
-
memberof
-

ADVEntryDetail

-
-
-
-
-
- -

Optional addendaRecordIndicator

-
addendaRecordIndicator: undefined | number
- -
-
-

AddendaRecordIndicator indicates the existence of an Addenda Record. A value of "1" indicates that one ore more addenda records follow, and "0" means no such record is present.

-
-
-
memberof
-

ADVEntryDetail

-
-
-
-
-
- -

Optional adviceRoutingNumber

-
adviceRoutingNumber: undefined | string
- -
-
-

Suggested routing number to use

-
-
-
memberof
-

ADVEntryDetail

-
-
-
-
-
- -

amount

-
amount: number
- -
-
-

Number of cents you are debiting/crediting this account

-
-
-
memberof
-

ADVEntryDetail

-
-
-
-
-
- -

Optional category

-
category: undefined | string
- -
-
-

Category defines if the entry is a Forward, Return, or NOC

-
-
-
memberof
-

ADVEntryDetail

-
-
-
-
-
- -

checkDigit

-
checkDigit: string
- -
-
-

Last digit in RDFI routing number.

-
-
-
memberof
-

ADVEntryDetail

-
-
-
-
-
- -

Optional discretionaryData

-
discretionaryData: undefined | string
- -
-
-

DiscretionaryData allows ODFIs to include codes, of significance only to them, to enable specialized handling of the entry. There will be no standardized interpretation for the value of this field. It can either be a single two-character code, or two distinct one-character codes, according to the needs of the ODFI and/or Originator involved. This field must be returned intact for any returned entry. WEB uses the Discretionary Data Field as the Payment Type Code

-
-
-
memberof
-

ADVEntryDetail

-
-
-
-
-
- -

Optional fileIdentification

-
fileIdentification: undefined | string
- -
-
-

Unique identifier for the File

-
-
-
memberof
-

ADVEntryDetail

-
-
-
-
-
- -

individualName

-
individualName: string
- -
-
-

The name of the receiver, usually the name on the bank account

-
-
-
memberof
-

ADVEntryDetail

-
-
-
-
-
- -

Optional julianDay

-
julianDay: undefined | number
- -
-
-

Julian Day of the year

-
-
-
memberof
-

ADVEntryDetail

-
-
-
-
-
- -

Optional sequenceNumber

-
sequenceNumber: undefined | number
- -
-
-

SequenceNumber is consecutively assigned to each Addenda05 Record following an Entry Detail Record. The first addenda05 sequence number must always be a 1.

-
-
-
memberof
-

ADVEntryDetail

-
-
-
-
-
- -

transactionCode

-
transactionCode: number
- -
-
-

TransactionCode representing Accounting Entries Credit for ACH debits originated - 81 Debit for ACH credits originated - 82 Credit for ACH credits received 83 Debit for ACH debits received 84 Credit for ACH credits in rejected batches 85 Debit for ACH debits in rejected batches - 86 Summary credit for respondent ACH activity - 87 Summary debit for respondent ACH activity - 88

-
-
-
memberof
-

ADVEntryDetail

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.batch.html b/docs/interfaces/_api_.batch.html deleted file mode 100644 index 11d57b3..0000000 --- a/docs/interfaces/_api_.batch.html +++ /dev/null @@ -1,360 +0,0 @@ - - - - - - Batch | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface Batch

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

Batch

-
-
-
-
-
-

Hierarchy

-
    -
  • - Batch -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional batchControl

-
batchControl: BatchControl
- -
-
-
memberof
-

Batch

-
-
-
-
-
- -

Optional batchHeader

-
batchHeader: BatchHeader
- -
-
-
memberof
-

Batch

-
-
-
-
-
- -

Optional entryDetails

-
entryDetails: Array<EntryDetail>
- -
-
-
memberof
-

Batch

-
-
-
-
-
- -

Optional offset

-
offset: Offset
- -
-
-
memberof
-

Batch

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.batchcontrol.html b/docs/interfaces/_api_.batchcontrol.html deleted file mode 100644 index 48998a9..0000000 --- a/docs/interfaces/_api_.batchcontrol.html +++ /dev/null @@ -1,516 +0,0 @@ - - - - - - BatchControl | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface BatchControl

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

BatchControl

-
-
-
-
-
-

Hierarchy

-
    -
  • - BatchControl -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional ID

-
ID: undefined | string
- -
-
-

Batch ID

-
-
-
memberof
-

BatchControl

-
-
-
-
-
- -

Optional ODFIIdentification

-
ODFIIdentification: undefined | string
- -
-
-

The routing number is used to identify the DFI originating entries within a given branch.

-
-
-
memberof
-

BatchControl

-
-
-
-
-
- -

Optional batchNumber

-
batchNumber: undefined | string
- -
-
-

BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.

-
-
-
memberof
-

BatchControl

-
-
-
-
-
- -

Optional companyIdentification

-
companyIdentification: undefined | string
- -
-
-

Alphanumeric code used to identify an Originator The Company Identification Field must be included on all prenotification records and on each entry initiated pursuant to such prenotification. The Company ID may begin with the ANSI one-digit Identification Code Designator (ICD), followed by the identification number The ANSI Identification Numbers and related Identification Code IRS Employer Identification Number (EIN) "1" Data Universal Numbering Systems (DUNS) "3" User Assigned Number "9"

-
-
-
memberof
-

BatchControl

-
-
-
-
-
- -

Optional entryAddendaCount

-
entryAddendaCount: undefined | number
- -
-
-

EntryAddendaCount is a tally of each Entry Detail Record and each Addenda Record processed, within either the batch or file as appropriate.

-
-
-
memberof
-

BatchControl

-
-
-
-
-
- -

Optional entryHash

-
entryHash: undefined | number
- -
-
-

Validate the Receiving DFI Identification in each Entry Detail Record is hashed to provide a check against inadvertent alteration of data contents due to hardware failure or program error. In this context the Entry Hash is the sum of the corresponding fields in the Entry Detail Records on the file.

-
-
-
memberof
-

BatchControl

-
-
-
-
-
- -

Optional messageAuthentication

-
messageAuthentication: undefined | string
- -
-
-

MAC is an eight character code derived from a special key used in conjunction with the DES algorithm. The purpose of the MAC is to validate the authenticity of ACH entries. The DES algorithm and key message standards must be in accordance with standards adopted by the American National Standards Institute. The remaining eleven characters of this field are blank.

-
-
-
memberof
-

BatchControl

-
-
-
-
-
- -

Optional serviceClassCode

-
serviceClassCode: undefined | number
- -
-
-

Same as ServiceClassCode in BatchHeaderRecord

-
-
-
memberof
-

BatchControl

-
-
-
-
-
- -

Optional totalCredit

-
totalCredit: undefined | number
- -
-
-

Contains accumulated Entry credit totals within the batch.

-
-
-
memberof
-

BatchControl

-
-
-
-
-
- -

Optional totalDebit

-
totalDebit: undefined | number
- -
-
-

Contains accumulated Entry debit totals within the batch.

-
-
-
memberof
-

BatchControl

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.batchheader.html b/docs/interfaces/_api_.batchheader.html deleted file mode 100644 index 4f9e1ec..0000000 --- a/docs/interfaces/_api_.batchheader.html +++ /dev/null @@ -1,540 +0,0 @@ - - - - - - BatchHeader | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface BatchHeader

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

BatchHeader

-
-
-
-
-
-

Hierarchy

-
    -
  • - BatchHeader -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional ID

-
ID: undefined | string
- -
-
-

Batch Header ID

-
-
-
memberof
-

BatchHeader

-
-
-
-
-
- -

ODFIIdentification

-
ODFIIdentification: string
- -
-
-

First 8 digits of the originating DFI transit routing number

-
-
-
memberof
-

BatchHeader

-
-
-
-
-
- -

Optional batchNumber

-
batchNumber: undefined | string
- -
-
-

BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.

-
-
-
memberof
-

BatchHeader

-
-
-
-
-
- -

Optional companyDescriptiveDate

-
companyDescriptiveDate: undefined | string
- -
-
-

The Originator establishes this field as the date it would like to see displayed to the receiver for descriptive purposes. This field is never used to control timing of any computer or manual operation. It is solely for descriptive purposes. The RDFI should not assume any specific format.

-
-
-
memberof
-

BatchHeader

-
-
-
-
-
- -

Optional companyDiscretionaryData

-
companyDiscretionaryData: undefined | string
- -
-
-

The 9 digit FEIN number (proceeded by a predetermined alpha or numeric character) of the entity in the company name field

-
-
-
memberof
-

BatchHeader

-
-
-
-
-
- -

Optional companyEntryDescription

-
companyEntryDescription: undefined | string
- -
-
-

A description of the entries contained in the batch. The Originator establishes the value of this field to provide a description of the purpose of the entry to be displayed back to the receive For example, "GAS BILL," "REG. SALARY," "INS. PREM,", "SOC. SEC.," "DTC," "TRADE PAY," "PURCHASE," etc. This field must contain the word "REVERSAL" (left justified) when the batch contains reversing entries. This field must contain the word "RECLAIM" (left justified) when the batch contains reclamation entries. This field must contain the word "NONSETTLED" (left justified) when the batch contains entries which could not settle.

-
-
-
memberof
-

BatchHeader

-
-
-
-
-
- -

companyName

-
companyName: string
- -
-
-

Company originating the entries in the batch

-
-
-
memberof
-

BatchHeader

-
-
-
-
-
- -

Optional effectiveEntryDate

-
effectiveEntryDate: undefined | string
- -
-
-

Date on which the entries are to settle. Format YYMMDD (Y=Year, M=Month, D=Day)

-
-
-
memberof
-

BatchHeader

-
-
-
-
-
- -

Optional originatorStatusCode

-
originatorStatusCode: undefined | number
- -
-
-

ODFI initiating the Entry. 0 ADV File prepared by an ACH Operator. 1 This code identifies the Originator as a depository financial institution. 2 This code identifies the Originator as a Federal Government entity or agency.

-
-
-
memberof
-

BatchHeader

-
-
-
-
-
- -

serviceClassCode

-
serviceClassCode: number
- -
-
-

Service Class Code - ACH Credits Only 220 and ACH Debits Only 225

-
-
-
memberof
-

BatchHeader

-
-
-
-
-
- -

Optional standardEntryClassCode

-
standardEntryClassCode: undefined | string
- -
-
-

Identifies the payment type (product) found within an ACH batch-using a 3-character code.

-
-
-
memberof
-

BatchHeader

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.createfile.html b/docs/interfaces/_api_.createfile.html deleted file mode 100644 index 6142821..0000000 --- a/docs/interfaces/_api_.createfile.html +++ /dev/null @@ -1,426 +0,0 @@ - - - - - - CreateFile | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface CreateFile

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

CreateFile

-
-
-
-
-
-

Hierarchy

-
    -
  • - CreateFile -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional IATBatches

-
IATBatches: Array<IATBatch>
- -
-
-
memberof
-

CreateFile

-
-
-
-
-
- -

Optional ID

-
ID: undefined | string
- -
-
-

File ID

-
-
-
memberof
-

CreateFile

-
-
-
-
-
- -

Optional advBatchControl

-
advBatchControl: ADVBatchControl
- -
-
-
memberof
-

CreateFile

-
-
-
-
-
- -

Optional advEntryDetails

-
advEntryDetails: Array<ADVEntryDetail>
- -
-
-
memberof
-

CreateFile

-
-
-
-
-
- -

Optional batches

-
batches: Array<Batch>
- -
-
-
memberof
-

CreateFile

-
-
-
-
-
- -

Optional fileControl

-
fileControl: FileControl
- -
-
-
memberof
-

CreateFile

-
-
-
-
-
- -

fileHeader

-
fileHeader: FileHeader
- -
-
-
memberof
-

CreateFile

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.entrydetail.html b/docs/interfaces/_api_.entrydetail.html deleted file mode 100644 index e036f56..0000000 --- a/docs/interfaces/_api_.entrydetail.html +++ /dev/null @@ -1,651 +0,0 @@ - - - - - - EntryDetail | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface EntryDetail

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

EntryDetail

-
-
-
-
-
-

Hierarchy

-
    -
  • - EntryDetail -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

DFIAccountNumber

-
DFIAccountNumber: string
- -
-
-

The receiver's bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so its space padded, no zero padded

-
-
-
memberof
-

EntryDetail

-
-
-
-
-
- -

Optional ID

-
ID: undefined | string
- -
-
-

Entry Detail ID

-
-
-
memberof
-

EntryDetail

-
-
-
-
-
- -

RDFIIdentification

-
RDFIIdentification: string
- -
-
-

RDFI's routing number without the last digit.

-
-
-
memberof
-

EntryDetail

-
-
-
-
-
- -

Optional addenda02

-
addenda02: Addenda02
- -
-
-
memberof
-

EntryDetail

-
-
-
-
-
- -

Optional addenda05

-
addenda05: Array<Addenda05>
- -
-
-

List of Addenda05 records

-
-
-
memberof
-

EntryDetail

-
-
-
-
-
- -

Optional addenda98

-
addenda98: Addenda98
- -
-
-
memberof
-

EntryDetail

-
-
-
-
-
- -

Optional addenda99

-
addenda99: Addenda99
- -
-
-
memberof
-

EntryDetail

-
-
-
-
-
- -

Optional addendaRecordIndicator

-
addendaRecordIndicator: undefined | number
- -
-
-

AddendaRecordIndicator indicates the existence of an Addenda Record. A value of "1" indicates that one ore more addenda records follow, and "0" means no such record is present.

-
-
-
memberof
-

EntryDetail

-
-
-
-
-
- -

amount

-
amount: number
- -
-
-

Number of cents you are debiting/crediting this account

-
-
-
memberof
-

EntryDetail

-
-
-
-
-
- -

Optional category

-
category: undefined | string
- -
-
-

Category defines if the entry is a Forward, Return, or NOC

-
-
-
memberof
-

EntryDetail

-
-
-
-
-
- -

checkDigit

-
checkDigit: string
- -
-
-

Last digit in RDFI routing number.

-
-
-
memberof
-

EntryDetail

-
-
-
-
-
- -

Optional discretionaryData

-
discretionaryData: undefined | string
- -
-
-

DiscretionaryData allows ODFIs to include codes, of significance only to them, to enable specialized handling of the entry. There will be no standardized interpretation for the value of this field. It can either be a single two-character code, or two distinct one-character codes, according to the needs of the ODFI and/or Originator involved. This field must be returned intact for any returned entry. WEB uses the Discretionary Data Field as the Payment Type Code

-
-
-
memberof
-

EntryDetail

-
-
-
-
-
- -

Optional identificationNumber

-
identificationNumber: undefined | string
- -
-
-

Internal identification (alphanumeric) that you use to uniquely identify this Entry Detail Record

-
-
-
memberof
-

EntryDetail

-
-
-
-
-
- -

individualName

-
individualName: string
- -
-
-

The name of the receiver, usually the name on the bank account

-
-
-
memberof
-

EntryDetail

-
-
-
-
-
- -

Optional traceNumber

-
traceNumber: undefined | number
- -
-
-

TraceNumber assigned by the ODFI in ascending sequence, is included in each Entry Detail Record, Corporate Entry Detail Record, and addenda Record. Trace Numbers uniquely identify each entry within a batch in an ACH input file. In association with the Batch Number, transmission (File Creation) Date, and File ID Modifier, the Trace Number uniquely identifies an entry within a given file. For addenda Records, the Trace Number will be identical to the Trace Number in the associated Entry Detail Record, since the Trace Number is associated with an entry or item rather than a physical record.

-
-
-
memberof
-

EntryDetail

-
-
-
-
-
- -

transactionCode

-
transactionCode: number
- -
-
-

transactionCode if the receivers account is: Credit (deposit) to checking account 22 Prenote for credit to checking account 23 Debit (withdrawal) to checking account 27 Prenote for debit to checking account 28 Credit to savings account 32 Prenote for credit to savings account 33 Debit to savings account 37 Prenote for debit to savings account 38

-
-
-
memberof
-

EntryDetail

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.filecontrol.html b/docs/interfaces/_api_.filecontrol.html deleted file mode 100644 index d6514cc..0000000 --- a/docs/interfaces/_api_.filecontrol.html +++ /dev/null @@ -1,444 +0,0 @@ - - - - - - FileControl | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface FileControl

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

FileControl

-
-
-
-
-
-

Hierarchy

-
    -
  • - FileControl -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional ID

-
ID: undefined | string
- -
-
-

Moov API File ID

-
-
-
memberof
-

FileControl

-
-
-
-
-
- -

Optional batchCount

-
batchCount: undefined | number
- -
-
-

Count of Batches in the File

-
-
-
memberof
-

FileControl

-
-
-
-
-
- -

Optional blockCount

-
blockCount: undefined | number
- -
-
-

BlockCount total number of records in the file (include all headers and trailer) divided by 10 (This number must be evenly divisible by 10. If not, additional records consisting of all 9's are added to the file after the initial '9' record to fill out the block 10.)

-
-
-
memberof
-

FileControl

-
-
-
-
-
- -

Optional entryAddendaCount

-
entryAddendaCount: undefined | number
- -
-
-

Total detail and addenda records in the file

-
-
-
memberof
-

FileControl

-
-
-
-
-
- -

Optional entryHash

-
entryHash: undefined | number
- -
-
-

EntryHash calculated in the same manner as the batch has total but includes total from entire file

-
-
-
memberof
-

FileControl

-
-
-
-
-
- -

Optional totalCredit

-
totalCredit: undefined | number
- -
-
-

Accumulated Batch credit totals within the file.

-
-
-
memberof
-

FileControl

-
-
-
-
-
- -

Optional totalDebit

-
totalDebit: undefined | number
- -
-
-

Accumulated Batch debit totals within the file.

-
-
-
memberof
-

FileControl

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.fileheader.html b/docs/interfaces/_api_.fileheader.html deleted file mode 100644 index 213e86e..0000000 --- a/docs/interfaces/_api_.fileheader.html +++ /dev/null @@ -1,444 +0,0 @@ - - - - - - FileHeader | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface FileHeader

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

FileHeader

-
-
-
-
-
-

Hierarchy

-
    -
  • - FileHeader -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional fileCreationDate

-
fileCreationDate: undefined | string
- -
-
-

The File Creation Time is the time when the file was prepared by an ODFI. (Format YYMMDD - Y=Year, M=Month, D=Day)

-
-
-
memberof
-

FileHeader

-
-
-
-
-
- -

Optional fileCreationTime

-
fileCreationTime: undefined | string
- -
-
-

The File Creation Date is the date when the file was prepared by an ODFI. (Format HHmm - H=Hour, m=Minute)

-
-
-
memberof
-

FileHeader

-
-
-
-
-
- -

Optional fileIDModifier

-
fileIDModifier: undefined | string
- -
-
-

Incremented value for each file for RDFI's.

-
-
-
memberof
-

FileHeader

-
-
-
-
-
- -

immediateDestination

-
immediateDestination: string
- -
-
-

contains the Routing Number of the ACH Operator or receiving point to which the file is being sent

-
-
-
memberof
-

FileHeader

-
-
-
-
-
- -

immediateDestinationName

-
immediateDestinationName: string
- -
-
-

The name of the ACH or receiving point for which that file is destined.

-
-
-
memberof
-

FileHeader

-
-
-
-
-
- -

immediateOrigin

-
immediateOrigin: string
- -
-
-

contains the Routing Number of the ACH Operator or sending point that is sending the file.

-
-
-
memberof
-

FileHeader

-
-
-
-
-
- -

immediateOriginName

-
immediateOriginName: string
- -
-
-

The name of the ACH operator or sending point that is sending the file.

-
-
-
memberof
-

FileHeader

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.fileid.html b/docs/interfaces/_api_.fileid.html deleted file mode 100644 index cb30195..0000000 --- a/docs/interfaces/_api_.fileid.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - - FileID | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface FileID

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

FileID

-
-
-
-
-
-

Hierarchy

-
    -
  • - FileID -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional ID

-
ID: undefined | string
- -
-
-

File ID

-
-
-
memberof
-

FileID

-
-
-
-
-
- -

Optional error

-
error: undefined | string
- -
-
-

An error message describing the problem intended for humans.

-
-
-
memberof
-

FileID

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.iatbatch.html b/docs/interfaces/_api_.iatbatch.html deleted file mode 100644 index 2455cbb..0000000 --- a/docs/interfaces/_api_.iatbatch.html +++ /dev/null @@ -1,363 +0,0 @@ - - - - - - IATBatch | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface IATBatch

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

IATBatch

-
-
-
-
-
-

Hierarchy

-
    -
  • - IATBatch -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional IATBatchHeader

-
IATBatchHeader: IATBatchHeader
- -
-
-
memberof
-

IATBatch

-
-
-
-
-
- -

Optional IATEntryDetails

-
IATEntryDetails: Array<IATEntryDetail>
- -
-
-
memberof
-

IATBatch

-
-
-
-
-
- -

Optional ID

-
ID: undefined | string
- -
-
-

Client defined string used as a reference to this record.

-
-
-
memberof
-

IATBatch

-
-
-
-
-
- -

Optional batchControl

-
batchControl: BatchControl
- -
-
-
memberof
-

IATBatch

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.iatbatchheader.html b/docs/interfaces/_api_.iatbatchheader.html deleted file mode 100644 index 3779356..0000000 --- a/docs/interfaces/_api_.iatbatchheader.html +++ /dev/null @@ -1,660 +0,0 @@ - - - - - - IATBatchHeader | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface IATBatchHeader

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

IATBatchHeader

-
-
-
-
-
-

Hierarchy

-
    -
  • - IATBatchHeader -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional IATIndicator

-
IATIndicator: undefined | string
- -
-
-

Leave Blank. Only used for corrected IAT entries

-
-
-
memberof
-

IATBatchHeader

-
-
-
-
-
- -

Optional ID

-
ID: undefined | string
- -
-
-

ID is a client defined string used as a reference to this record.

-
-
-
memberof
-

IATBatchHeader

-
-
-
-
-
- -

Optional ISODestinationCountryCode

-
ISODestinationCountryCode: undefined | string
- -
-
-

Two-character code, as approved by the International Organization for Standardization (ISO), to identify the country in which the entry is to be received. For United States use US.

-
-
-
memberof
-

IATBatchHeader

-
-
-
-
-
- -

Optional ISODestinationCurrencyCode

-
ISODestinationCurrencyCode: undefined | string
- -
-
-

ISODestinationCurrencyCode is the three-character code, as approved by the International Organization for Standardization (ISO), to identify the currency denomination in which the entry will ultimately be settled. If the final destination of funds is within the territorial jurisdiction of the U.S., enter "USD", otherwise refer to International Organization for Standardization website for value: www.iso.org

-
-
-
memberof
-

IATBatchHeader

-
-
-
-
-
- -

Optional ISOOriginatingCurrencyCode

-
ISOOriginatingCurrencyCode: undefined | string
- -
-
-

Three-character code, as approved by the International Organization for Standardization (ISO), to identify the currency denomination in which the entry was first originated. If the source of funds is within the territorial jurisdiction of the U.S., enter 'USD', otherwise refer to International Organization for Standardization website for value: www.iso.org

-
-
-
memberof
-

IATBatchHeader

-
-
-
-
-
- -

Optional ODFIIdentification

-
ODFIIdentification: undefined | string
- -
-
-

ODFIIdentification First 8 digits of the originating DFI transit routing number for Inbound IAT Entries, this field contains the routing number of the U.S. Gateway Operator. For Outbound IAT Entries, this field contains the standard routing number, as assigned by Accuity, that identifies the U.S. ODFI initiating the Entry. Format - TTTTAAAA

-
-
-
memberof
-

IATBatchHeader

-
-
-
-
-
- -

Optional batchNumber

-
batchNumber: undefined | number
- -
-
-

BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.

-
-
-
memberof
-

IATBatchHeader

-
-
-
-
-
- -

Optional companyEntryDescription

-
companyEntryDescription: undefined | string
- -
-
-

A description of the entries contained in the batch The Originator establishes the value of this field to provide a description of the purpose of the entry to be displayed back to the receive For example, "GAS BILL," "REG. SALARY," "INS. PREM," "SOC. SEC.," "DTC," "TRADE PAY," "PURCHASE," etc. This field must contain the word "REVERSAL" (left justified) when the batch contains reversing entries. This field must contain the word "RECLAIM" (left justified) when the batch contains reclamation entries. This field must contain the word "NONSETTLED" (left justified) when the batch contains entries which could not settle.

-
-
-
memberof
-

IATBatchHeader

-
-
-
-
-
- -

Optional effectiveEntryDate

-
effectiveEntryDate: undefined | string
- -
-
-

EffectiveEntryDate the date on which the entries are to settle format YYMMDD (Y=Year, M=Month, D=Day)

-
-
-
memberof
-

IATBatchHeader

-
-
-
-
-
- -

Optional foreignExchangeIndicator

-
foreignExchangeIndicator: undefined | string
- -
-
-

Code indicating currency conversion. FV Fixed-to-Variable – Entry is originated in a fixed-value amount and is to be received in a variable amount resulting from the execution of the foreign exchange conversion. VF Variable-to-Fixed – Entry is originated in a variable-value amount based on a specific foreign exchange rate for conversion to a fixed-value amount in which the entry is to be received. FF Fixed-to-Fixed – Entry is originated in a fixed-value amount and is to be received in the same fixed-value amount in the same currency denomination. There is no foreign exchange conversion for entries transmitted using this code. For entries originated in a fixed value amount, the foreign Exchange Reference Field will be space filled.

-
-
-
memberof
-

IATBatchHeader

-
-
-
-
-
- -

Optional foreignExchangeReference

-
foreignExchangeReference: undefined | string
- -
-
-

Contains either the foreign exchange rate used to execute the foreign exchange conversion of a cross-border entry or another reference to the foreign exchange transaction.

-
-
-
memberof
-

IATBatchHeader

-
-
-
-
-
- -

Optional foreignExchangeReferenceIndicator

-
foreignExchangeReferenceIndicator: undefined | number
- -
-
-

Code used to indicate the content of the Foreign Exchange Reference Field and is filled by the gateway operator. Valid entries are 1 - Foreign Exchange Rate; 2 - Foreign Exchange Reference Number; or 3 - Space Filled

-
-
-
memberof
-

IATBatchHeader

-
-
-
-
-
- -

Optional originatorIdentification

-
originatorIdentification: undefined | string
- -
-
-

For U.S. entities: the number assigned will be your tax ID (often Social Security Number) For non-U.S. entities: the number assigned will be your DDA number, or the last 9 characters of your account number if it exceeds 9 characters

-
-
-
memberof
-

IATBatchHeader

-
-
-
-
-
- -

Optional originatorStatusCode

-
originatorStatusCode: undefined | number
- -
-
-

SettlementDate Leave blank, this field is inserted by the ACH operator settlementDate string OriginatorStatusCode refers to the ODFI initiating the Entry. 0 ADV File prepared by an ACH Operator. 1 This code identifies the Originator as a depository financial institution. 2 This code identifies the Originator as a Federal Government entity or agency.

-
-
-
memberof
-

IATBatchHeader

-
-
-
-
-
- -

Optional serviceClassCode

-
serviceClassCode: undefined | number
- -
-
-

ServiceClassCode ACH Mixed Debits and Credits '200' ACH Credits Only '220' ACH Debits Only '225'

-
-
-
memberof
-

IATBatchHeader

-
-
-
-
-
- -

Optional standardEntryClassCode

-
standardEntryClassCode: undefined | string
- -
-
-

StandardEntryClassCode for consumer and non consumer international payments is IAT. Identifies the payment type (product) found within an ACH batch-using a 3-character code. The SEC Code pertains to all items within batch. Determines format of the detail records. Determines addenda records (required or optional PLUS one or up to 9,999 records). Determines rules to follow (return time frames). Some SEC codes require specific data in predetermined fields within the ACH record

-
-
-
memberof
-

IATBatchHeader

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.iatentrydetail.html b/docs/interfaces/_api_.iatentrydetail.html deleted file mode 100644 index a43fa0b..0000000 --- a/docs/interfaces/_api_.iatentrydetail.html +++ /dev/null @@ -1,795 +0,0 @@ - - - - - - IATEntryDetail | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface IATEntryDetail

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

IATEntryDetail

-
-
-
-
-
-

Hierarchy

-
    -
  • - IATEntryDetail -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional AddendaRecords

-
AddendaRecords: undefined | number
- -
-
-

Number of Addenda Records

-
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional DFIAccountNumber

-
DFIAccountNumber: undefined | string
- -
-
-

The receiver's bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so its space padded, no zero padded

-
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional ID

-
ID: undefined | string
- -
-
-

Entry Detail ID

-
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional OFACScreeningIndicator

-
OFACScreeningIndicator: undefined | string
- -
-
-

Signifies if the record has been screened against OFAC records

-
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional RDFIIdentification

-
RDFIIdentification: undefined | string
- -
-
-

RDFI's routing number without the last digit.

-
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional SecondaryOFACScreeningIndicator

-
SecondaryOFACScreeningIndicator: undefined | string
- -
-
-

Signifies if the record has been screened against OFAC records by a secondary entry

-
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional addenda10

-
addenda10: Addenda10
- -
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional addenda11

-
addenda11: Addenda11
- -
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional addenda12

-
addenda12: Addenda12
- -
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional addenda13

-
addenda13: Addenda13
- -
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional addenda14

-
addenda14: Addenda14
- -
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional addenda15

-
addenda15: Addenda15
- -
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional addenda16

-
addenda16: Addenda16
- -
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional addenda17

-
addenda17: Addenda17
- -
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional addenda18

-
addenda18: Addenda18
- -
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional addenda98

-
addenda98: Addenda98
- -
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional addenda99

-
addenda99: Addenda99
- -
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional addendaRecordIndicator

-
addendaRecordIndicator: undefined | number
- -
-
-

AddendaRecordIndicator indicates the existence of an Addenda Record. A value of "1" indicates that one ore more addenda records follow, and "0" means no such record is present.

-
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional amount

-
amount: undefined | number
- -
-
-

Number of cents you are debiting/crediting this account

-
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional category

-
category: undefined | string
- -
-
-

Category defines if the entry is a Forward, Return, or NOC

-
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional checkDigit

-
checkDigit: undefined | string
- -
-
-

Last digit in RDFI routing number.

-
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional traceNumber

-
traceNumber: undefined | string
- -
-
-

Matches the Entry Detail Trace Number of the entry being returned.

-
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
- -

Optional transactionCode

-
transactionCode: undefined | number
- -
-
-

TransactionCode if the receivers account is Credit (deposit) to checking account '22' Prenote for credit to checking account '23' Debit (withdrawal) to checking account '27' Prenote for debit to checking account '28' Credit to savings account '32' Prenote for credit to savings account '33' Debit to savings account '37' Prenote for debit to savings account '38'

-
-
-
memberof
-

IATEntryDetail

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.modelerror.html b/docs/interfaces/_api_.modelerror.html deleted file mode 100644 index a6ef328..0000000 --- a/docs/interfaces/_api_.modelerror.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - - ModelError | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface ModelError

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

ModelError

-
-
-
-
-
-

Hierarchy

-
    -
  • - ModelError -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

error

-
error: string
- -
-
-

An error message describing the problem intended for humans.

-
-
-
memberof
-

ModelError

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.modelfile.html b/docs/interfaces/_api_.modelfile.html deleted file mode 100644 index 0114b26..0000000 --- a/docs/interfaces/_api_.modelfile.html +++ /dev/null @@ -1,426 +0,0 @@ - - - - - - ModelFile | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface ModelFile

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

ModelFile

-
-
-
-
-
-

Hierarchy

-
    -
  • - ModelFile -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional IATBatches

-
IATBatches: Array<IATBatch>
- -
-
-
memberof
-

ModelFile

-
-
-
-
-
- -

Optional ID

-
ID: undefined | string
- -
-
-

File ID

-
-
-
memberof
-

ModelFile

-
-
-
-
-
- -

Optional NotificationOfChange

-
NotificationOfChange: Array<Batch>
- -
-
-
memberof
-

ModelFile

-
-
-
-
-
- -

Optional ReturnEntries

-
ReturnEntries: Array<Batch>
- -
-
-
memberof
-

ModelFile

-
-
-
-
-
- -

Optional batches

-
batches: Array<Batch>
- -
-
-
memberof
-

ModelFile

-
-
-
-
-
- -

Optional fileControl

-
fileControl: FileControl
- -
-
-
memberof
-

ModelFile

-
-
-
-
-
- -

Optional fileHeader

-
fileHeader: FileHeader
- -
-
-
memberof
-

ModelFile

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.offset.html b/docs/interfaces/_api_.offset.html deleted file mode 100644 index 193e3fd..0000000 --- a/docs/interfaces/_api_.offset.html +++ /dev/null @@ -1,372 +0,0 @@ - - - - - - Offset | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface Offset

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

Offset

-
-
-
-
-
-

Hierarchy

-
    -
  • - Offset -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional accountNumber

-
accountNumber: undefined | string
- -
-
-

Account number used to offset records

-
-
-
memberof
-

Offset

-
-
-
-
-
- -

Optional accountType

-
accountType: OffsetAccountTypeEnum
- -
-
-

Account type used in offset record

-
-
-
memberof
-

Offset

-
-
-
-
-
- -

Optional description

-
description: undefined | string
- -
-
-

Memo for Offset EntryDetail record

-
-
-
memberof
-

Offset

-
-
-
-
-
- -

Optional routingNumber

-
routingNumber: undefined | string
- -
-
-

ABA routing number

-
-
-
memberof
-

Offset

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.segmentedfiles.html b/docs/interfaces/_api_.segmentedfiles.html deleted file mode 100644 index d76ccc0..0000000 --- a/docs/interfaces/_api_.segmentedfiles.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - - SegmentedFiles | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface SegmentedFiles

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

SegmentedFiles

-
-
-
-
-
-

Hierarchy

-
    -
  • - SegmentedFiles -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional creditFileID

-
creditFileID: undefined | string
- -
-
-

File ID

-
-
-
memberof
-

SegmentedFiles

-
-
-
-
-
- -

Optional debitFileID

-
debitFileID: undefined | string
- -
-
-

File ID

-
-
-
memberof
-

SegmentedFiles

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_api_.validateopts.html b/docs/interfaces/_api_.validateopts.html deleted file mode 100644 index ebfe2fc..0000000 --- a/docs/interfaces/_api_.validateopts.html +++ /dev/null @@ -1,348 +0,0 @@ - - - - - - ValidateOpts | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface ValidateOpts

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

ValidateOpts

-
-
-
-
-
-

Hierarchy

-
    -
  • - ValidateOpts -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional bypassDestinationValidation

-
bypassDestinationValidation: undefined | false | true
- -
-
-

Skip ImmediateDestination validation steps.

-
-
-
memberof
-

ValidateOpts

-
-
-
-
-
- -

Optional bypassOriginValidation

-
bypassOriginValidation: undefined | false | true
- -
-
-

Skip ImmediateOrigin validation steps.

-
-
-
memberof
-

ValidateOpts

-
-
-
-
-
- -

Optional requireABAOrigin

-
requireABAOrigin: undefined | false | true
- -
-
-

Require that the FileHeader ImmediateOrigin routing number which checksum matches.

-
-
-
memberof
-

ValidateOpts

-
-
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_base_.requestargs.html b/docs/interfaces/_base_.requestargs.html deleted file mode 100644 index 40dbe96..0000000 --- a/docs/interfaces/_base_.requestargs.html +++ /dev/null @@ -1,211 +0,0 @@ - - - - - - RequestArgs | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface RequestArgs

-
-
-
-
-
-
-
-
-
-
export
-
-
interface
-

RequestArgs

-
-
-
-
-
-

Hierarchy

-
    -
  • - RequestArgs -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

options

-
options: any
- -
-
- -

url

-
url: string
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/_configuration_.configurationparameters.html b/docs/interfaces/_configuration_.configurationparameters.html deleted file mode 100644 index 846c4d6..0000000 --- a/docs/interfaces/_configuration_.configurationparameters.html +++ /dev/null @@ -1,259 +0,0 @@ - - - - - - ConfigurationParameters | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Interface ConfigurationParameters

-
-
-
-
-
-
-
-
-
-

ACH API - Moov ACH (Automated Clearing House) implements an HTTP API for creating, parsing and validating ACH files. ACH is the primary method of electronic money movement throughout the United States.

-
-

The version of the OpenAPI document: v1

-

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - https://openapi-generator.tech - Do not edit the class manually.

-
-
-
-

Hierarchy

-
    -
  • - ConfigurationParameters -
    • -
-
-
-

Index

-
-
-
-

Properties

- -
-
-
-
-
-

Properties

-
- -

Optional accessToken

-
accessToken: string | ((name?: undefined | string, scopes?: string[]) => string)
- -
-
- -

Optional apiKey

-
apiKey: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>)
- -
-
- -

Optional baseOptions

-
baseOptions: any
- -
-
- -

Optional basePath

-
basePath: undefined | string
- -
-
- -

Optional password

-
password: undefined | string
- -
-
- -

Optional username

-
username: undefined | string
- -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Interface
    • -
  • Property
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/interfaces/api.ADVBatchControl.html b/docs/interfaces/api.ADVBatchControl.html new file mode 100644 index 0000000..596399b --- /dev/null +++ b/docs/interfaces/api.ADVBatchControl.html @@ -0,0 +1,29 @@ +ADVBatchControl | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ADVBatchControl

export
interface

ADVBatchControl

+

Hierarchy

  • ADVBatchControl

Index

Properties

Properties

Optional ID

ID?: string
+

Batch ID

+
memberof

ADVBatchControl

+

ODFIIdentification

ODFIIdentification: string
+

The routing number is used to identify the DFI originating entries within a given branch.

+
memberof

ADVBatchControl

+

achOperatorData

achOperatorData: string
+

Alphanumeric code used to identify an ACH Operator

+
memberof

ADVBatchControl

+

batchNumber

batchNumber: number
+

BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.

+
memberof

ADVBatchControl

+

entryAddendaCount

entryAddendaCount: number
+

EntryAddendaCount is a tally of each Entry Detail Record and each Addenda Record processed, within either the batch or file as appropriate.

+
memberof

ADVBatchControl

+

entryHash

entryHash: number
+

Validate the Receiving DFI Identification in each Entry Detail Record is hashed to provide a check against inadvertent alteration of data contents due to hardware failure or program error. In this context the Entry Hash is the sum of the corresponding fields in the Entry Detail Records on the file.

+
memberof

ADVBatchControl

+

serviceClassCode

serviceClassCode: number
+

Same as ServiceClassCode in BatchHeader record

+
memberof

ADVBatchControl

+

totalCredit

totalCredit: number
+

Contains accumulated Entry credit totals within the batch.

+
memberof

ADVBatchControl

+

totalDebit

totalDebit: number
+

Contains accumulated Entry debit totals within the batch.

+
memberof

ADVBatchControl

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.ADVEntryDetail.html b/docs/interfaces/api.ADVEntryDetail.html new file mode 100644 index 0000000..21e9f1a --- /dev/null +++ b/docs/interfaces/api.ADVEntryDetail.html @@ -0,0 +1,53 @@ +ADVEntryDetail | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ADVEntryDetail

export
interface

ADVEntryDetail

+

Hierarchy

  • ADVEntryDetail

Index

Properties

Properties

DFIAccountNumber

DFIAccountNumber: string
+

The receiver's bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so it's space padded, not zero padded

+
memberof

ADVEntryDetail

+

Optional ID

ID?: string
+

Entry Detail ID

+
memberof

ADVEntryDetail

+

RDFIIdentification

RDFIIdentification: string
+

RDFI's routing number without the last digit.

+
memberof

ADVEntryDetail

+

Optional achOperatorData

achOperatorData?: string
+

Information related to the ACH opreator

+
memberof

ADVEntryDetail

+

achOperatorRoutingNumber

achOperatorRoutingNumber: string
+

Routing number for ACH Operator

+
memberof

ADVEntryDetail

+

Optional addenda99

addenda99?: Addenda99[]
+

Addenda99 record for the ADV Entry Detail

+
memberof

ADVEntryDetail

+

Optional addendaRecordIndicator

addendaRecordIndicator?: number
+

AddendaRecordIndicator indicates the existence of an Addenda Record. A value of "1" indicates that one or more addenda records follow, and "0" means no such record is present.

+
memberof

ADVEntryDetail

+

adviceRoutingNumber

adviceRoutingNumber: string
+

Suggested routing number to use

+
memberof

ADVEntryDetail

+

amount

amount: number
+

Number of cents you are debiting/crediting this account

+
memberof

ADVEntryDetail

+

Optional category

category?: string
+

Category defines if the entry is a Forward, Return, or NOC

+
memberof

ADVEntryDetail

+

checkDigit

checkDigit: string
+

Last digit in RDFI routing number.

+
memberof

ADVEntryDetail

+

Optional discretionaryData

discretionaryData?: string
+

DiscretionaryData allows ODFIs to include codes, of significance only to them, to enable specialized handling of the entry. There will be no standardized interpretation for the value of this field. It can either be a single two-character code, or two distinct one-character codes, according to the needs of the ODFI and/or Originator involved. This field must be returned intact for any returned entry. WEB uses the Discretionary Data Field as the Payment Type Code.

+
memberof

ADVEntryDetail

+

Optional fileIdentification

fileIdentification?: string
+

Unique identifier for the File

+
memberof

ADVEntryDetail

+

individualName

individualName: string
+

The name of the receiver, usually the name on the bank account

+
memberof

ADVEntryDetail

+

Optional julianDay

julianDay?: number
+

Julian Day of the year

+
memberof

ADVEntryDetail

+

sequenceNumber

sequenceNumber: number
+

SequenceNumber is consecutively assigned to each Addenda05 Record following an Entry Detail Record. The first Addenda05 sequence number must always be a 1.

+
memberof

ADVEntryDetail

+

transactionCode

transactionCode: number
+

TransactionCode representing Accounting Entries: 81 - Credit for ACH debits originated | 82 - Debit for ACH credits originated | 83 - Credit for ACH credits received | 84 - Debit for ACH debits received | 85 - Credit for ACH credits in rejected batches | 86 - Debit for ACH debits in rejected batches | 87 - Summary credit for respondent ACH activity | 88 - Summary debit for respondent ACH activity

+
memberof

ADVEntryDetail

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.ADVFileControl.html b/docs/interfaces/api.ADVFileControl.html new file mode 100644 index 0000000..39c2fc5 --- /dev/null +++ b/docs/interfaces/api.ADVFileControl.html @@ -0,0 +1,23 @@ +ADVFileControl | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ADVFileControl

export
interface

ADVFileControl

+

Hierarchy

  • ADVFileControl

Index

Properties

Properties

ID

ID: string
+

ADV File Control Record

+
memberof

ADVFileControl

+

batchCount

batchCount: number
+

Count of Batches in the File

+
memberof

ADVFileControl

+

blockCount

blockCount: number
+

Total number of records in the file (include all headers and trailer) divided by 10 (This number must be evenly divisible by 10. If not, additional records consisting of all 9's are added to the file after the initial '9' record to fill out the block 10.)

+
memberof

ADVFileControl

+

entryAddendaCount

entryAddendaCount: number
+

Total detail and addenda records in the file

+
memberof

ADVFileControl

+

entryHash

entryHash: number
+

Calculated in the same manner as the batch total but includes total from entire file

+
memberof

ADVFileControl

+

totalCredit

totalCredit: number
+

Accumulated Batch credit totals within the file.

+
memberof

ADVFileControl

+

totalDebit

totalDebit: number
+

Accumulated Batch debit totals within the file.

+
memberof

ADVFileControl

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.Addenda02.html b/docs/interfaces/api.Addenda02.html new file mode 100644 index 0000000..1e82ce6 --- /dev/null +++ b/docs/interfaces/api.Addenda02.html @@ -0,0 +1,38 @@ +Addenda02 | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Addenda02

export
interface

Addenda02

+

Hierarchy

  • Addenda02

Index

Properties

Properties

Optional authorizationCodeOrExpireDate

authorizationCodeOrExpireDate?: string
+

Indicates the code that a card authorization center has furnished to the merchant.

+
memberof

Addenda02

+

Optional id

id?: string
+

Client-defined string used as a reference to this record.

+
memberof

Addenda02

+

Optional referenceInformationOne

referenceInformationOne?: string
+

ReferenceInformationOne may be used for additional reference numbers, identification numbers, or codes that the merchant needs to identify the particular transaction or customer.

+
memberof

Addenda02

+

Optional referenceInformationTwo

referenceInformationTwo?: string
+

ReferenceInformationTwo may be used for additional reference numbers, identification numbers, or codes that the merchant needs to identify the particular transaction or customer.

+
memberof

Addenda02

+

terminalCity

terminalCity: string
+

Identifies the city in which the electronic terminal is located.

+
memberof

Addenda02

+

terminalIdentificationCode

terminalIdentificationCode: string
+

TerminalIdentificationCode identifies an Electronic terminal with a unique code that allows a terminal owner and/or switching network to identify the terminal at which an Entry originated.

+
memberof

Addenda02

+

terminalLocation

terminalLocation: string
+

Identifies the specific location of a terminal (i.e., street names of an intersection, address, etc.) in accordance with the requirements of Regulation E.

+
memberof

Addenda02

+

terminalState

terminalState: string
+

Identifies the state in which the electronic terminal is located.

+
memberof

Addenda02

+

Optional traceNumber

traceNumber?: string
+

Entry Detail Trace Number

+
memberof

Addenda02

+

transactionDate

transactionDate: string
+

Timestamp identifies the date on which the transaction occurred. (Format MMDD - M=Month, D=Day)

+
memberof

Addenda02

+

transactionSerialNumber

transactionSerialNumber: string
+

TransactionSerialNumber is assigned by the terminal at the time the transaction is originated. The number, with the Terminal Identification Code, serves as an audit trail for the transaction and is usually assigned in ascending sequence.

+
memberof

Addenda02

+

typeCode

typeCode: string
+

02 - NACHA regulations

+
memberof

Addenda02

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.Addenda05.html b/docs/interfaces/api.Addenda05.html new file mode 100644 index 0000000..2559261 --- /dev/null +++ b/docs/interfaces/api.Addenda05.html @@ -0,0 +1,17 @@ +Addenda05 | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Addenda05

export
interface

Addenda05

+

Hierarchy

  • Addenda05

Index

Properties

Properties

entryDetailSequenceNumber

entryDetailSequenceNumber: number
+

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

+
memberof

Addenda05

+

Optional id

id?: string
+

Client-defined string used as a reference to this record.

+
memberof

Addenda05

+

paymentRelatedInformation

paymentRelatedInformation: string
+

Text for describing the related payment

+
memberof

Addenda05

+

sequenceNumber

sequenceNumber: number
+

SequenceNumber is consecutively assigned to each Addenda05 Record following an Entry Detail Record. The first Addenda05 sequence number must always be a 1.

+
memberof

Addenda05

+

typeCode

typeCode: string
+

05 - NACHA regulations

+
memberof

Addenda05

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.Addenda10.html b/docs/interfaces/api.Addenda10.html new file mode 100644 index 0000000..9f09bab --- /dev/null +++ b/docs/interfaces/api.Addenda10.html @@ -0,0 +1,23 @@ +Addenda10 | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Addenda10

export
interface

Addenda10

+

Hierarchy

  • Addenda10

Index

Properties

Properties

entryDetailSequenceNumber

entryDetailSequenceNumber: number
+

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

+
memberof

Addenda10

+

foreignPaymentAmount

foreignPaymentAmount: number
+

For inbound IAT payments this field should contain the USD amount or may be blank.

+
memberof

Addenda10

+

Optional foreignTraceNumber

foreignTraceNumber?: string
+

Trace number

+
memberof

Addenda10

+

Optional id

id?: string
+

Client-defined string used as a reference to this record.

+
memberof

Addenda10

+

name

name: string
+

Receiving Company Name/Individual Name

+
memberof

Addenda10

+

Optional transactionTypeCode

transactionTypeCode?: string
+

Describes the type of payment: 'ANN' = Annuity | 'BUS' = Business/Commercial | 'DEP' = Deposit | 'LOA' = Loan | 'MIS' = Miscellaneous | 'MOR' = Mortgage | 'PEN' = Pension | 'RLS' = Rent/Lease | 'REM' = Remittance2 | 'SAL' = Salary/Payroll | 'TAX' = Tax | 'TEL' = Telephone-Initiated Transaction | 'WEB' = Internet-Initiated Transaction | 'ARC' = Accounts Receivable Entry | 'BOC' = Back Office Conversion Entry | 'POP' = Point of Purchase Entry | 'RCK' = Re-presented Check Entry

+
memberof

Addenda10

+

typeCode

typeCode: string
+

10 - NACHA regulations

+
memberof

Addenda10

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.Addenda11.html b/docs/interfaces/api.Addenda11.html new file mode 100644 index 0000000..6ef7e2c --- /dev/null +++ b/docs/interfaces/api.Addenda11.html @@ -0,0 +1,17 @@ +Addenda11 | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Addenda11

export
interface

Addenda11

+

Hierarchy

  • Addenda11

Index

Properties

Properties

entryDetailSequenceNumber

entryDetailSequenceNumber: number
+

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

+
memberof

Addenda11

+

Optional id

id?: string
+

Client-defined string used as a reference to this record.

+
memberof

Addenda11

+

originatorName

originatorName: string
+

Originator's name (your company name / name)

+
memberof

Addenda11

+

originatorStreetAddress

originatorStreetAddress: string
+

Originator's street address

+
memberof

Addenda11

+

typeCode

typeCode: string
+

11 - NACHA regulations

+
memberof

Addenda11

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.Addenda12.html b/docs/interfaces/api.Addenda12.html new file mode 100644 index 0000000..069660f --- /dev/null +++ b/docs/interfaces/api.Addenda12.html @@ -0,0 +1,17 @@ +Addenda12 | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Addenda12

export
interface

Addenda12

+

Hierarchy

  • Addenda12

Index

Properties

Properties

entryDetailSequenceNumber

entryDetailSequenceNumber: number
+

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

+
memberof

Addenda12

+

Optional id

id?: string
+

Client-defined string used as a reference to this record.

+
memberof

Addenda12

+

originatorCityStateProvince

originatorCityStateProvince: string
+

Originator City & State / Province Data elements City and State / Province should be separated with an asterisk (*) as a delimiter and the field should end with a backslash (\\).

+
memberof

Addenda12

+

originatorCountryPostalCode

originatorCountryPostalCode: string
+

Originator Country & Postal Code Data elements must be separated by an asterisk (*) and must end with a backslash (\\).

+
memberof

Addenda12

+

typeCode

typeCode: string
+

12 - NACHA regulations

+
memberof

Addenda12

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.Addenda13.html b/docs/interfaces/api.Addenda13.html new file mode 100644 index 0000000..0f1dadd --- /dev/null +++ b/docs/interfaces/api.Addenda13.html @@ -0,0 +1,20 @@ +Addenda13 | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Addenda13

export
interface

Addenda13

+

Hierarchy

  • Addenda13

Index

Properties

Properties

ODFIBranchCountryCode

ODFIBranchCountryCode: string
+

Originating DFI Branch Country Code: USb = United States //("b" indicates a blank space) For Inbound IATs: This 3 position field contains a 2-character code as approved by the International Organization for Standardization (ISO) used to identify the country in which the branch of the bank that originated the entry is located. Values for other countries can be found on the International Organization for Standardization website: www.iso.org.

+
memberof

Addenda13

+

ODFIIDNumberQualifier

ODFIIDNumberQualifier: string
+

Originating DFI Identification Number Qualifier. For Inbound IATs: The 2-digit code that identifies the numbering scheme used in the Foreign DFI Identification Number field: '01' = National Clearing System | '02' = BIC Code | '03' = IBAN Code

+
memberof

Addenda13

+

ODFIName

ODFIName: string
+

Originating DFI Name For Outbound IAT Entries, this field must contain the name of the U.S. ODFI. For Inbound IATs: Name of the foreign bank providing funding for the payment transaction

+
memberof

Addenda13

+

entryDetailSequenceNumber

entryDetailSequenceNumber: number
+

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

+
memberof

Addenda13

+

Optional id

id?: string
+

Client-defined string used as a reference to this record.

+
memberof

Addenda13

+

typeCode

typeCode: string
+

13 - NACHA regulations

+
memberof

Addenda13

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.Addenda14.html b/docs/interfaces/api.Addenda14.html new file mode 100644 index 0000000..d0f6148 --- /dev/null +++ b/docs/interfaces/api.Addenda14.html @@ -0,0 +1,23 @@ +Addenda14 | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Addenda14

export
interface

Addenda14

+

Hierarchy

  • Addenda14

Index

Properties

Properties

RDFIBranchCountryCode

RDFIBranchCountryCode: string
+

Receiving DFI Branch Country Code USb" = United States ("b" indicates a blank space) This 3 position field contains a 2-character code as approved by the International Organization for Standardization (ISO) used to identify the country in which the branch of the bank that receives the entry is located. Values for other countries can be found on the International Organization for Standardization website: www.iso.org

+
memberof

Addenda14

+

RDFIIDNumberQualifier

RDFIIDNumberQualifier: string
+

Receiving DFI Identification Number Qualifier. The 2-digit code that identifies the numbering scheme used in the Receiving DFI Identification Number field: '01' = National Clearing System | '02' = BIC Code | '03' = IBAN Code

+
memberof

Addenda14

+

RDFIIdentification

RDFIIdentification: string
+

This field contains the bank identification number of the DFI at which the Receiver maintains his account.

+
memberof

Addenda14

+

RDFIName

RDFIName: string
+

Name of the Receiver bank

+
memberof

Addenda14

+

entryDetailSequenceNumber

entryDetailSequenceNumber: number
+

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

+
memberof

Addenda14

+

Optional id

id?: string
+

Client-defined string used as a reference to this record.

+
memberof

Addenda14

+

typeCode

typeCode: string
+

14 - NACHA regulations

+
memberof

Addenda14

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.Addenda15.html b/docs/interfaces/api.Addenda15.html new file mode 100644 index 0000000..12684bb --- /dev/null +++ b/docs/interfaces/api.Addenda15.html @@ -0,0 +1,17 @@ +Addenda15 | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Addenda15

export
interface

Addenda15

+

Hierarchy

  • Addenda15

Index

Properties

Properties

entryDetailSequenceNumber

entryDetailSequenceNumber: number
+

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

+
memberof

Addenda15

+

Optional id

id?: string
+

Client-defined string used as a reference to this record.

+
memberof

Addenda15

+

Optional receiverIDNumber

receiverIDNumber?: string
+

Receiver Identification Number contains the accounting number by which the Originator is known to the Receiver for descriptive purposes. NACHA Rules recommend but do not require the RDFI to print the contents of this field on the receiver's statement.

+
memberof

Addenda15

+

receiverStreetAddress

receiverStreetAddress: string
+

Receiver's physical address

+
memberof

Addenda15

+

typeCode

typeCode: string
+

15 - NACHA regulations

+
memberof

Addenda15

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.Addenda16.html b/docs/interfaces/api.Addenda16.html new file mode 100644 index 0000000..157106f --- /dev/null +++ b/docs/interfaces/api.Addenda16.html @@ -0,0 +1,17 @@ +Addenda16 | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Addenda16

export
interface

Addenda16

+

Hierarchy

  • Addenda16

Index

Properties

Properties

entryDetailSequenceNumber

entryDetailSequenceNumber: number
+

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

+
memberof

Addenda16

+

Optional id

id?: string
+

Client-defined string used as a reference to this record.

+
memberof

Addenda16

+

receiverCityStateProvince

receiverCityStateProvince: string
+

Receiver City & State / Province Data elements City and State / Province should be separated with an asterisk (*) as a delimiter and the field should end with a backslash (\\).

+
memberof

Addenda16

+

receiverCountryPostalCode

receiverCountryPostalCode: string
+

Receiver Country & Postal Code Data elements must be separated by an asterisk (*) and must end with a backslash (\\).

+
memberof

Addenda16

+

typeCode

typeCode: string
+

16 - NACHA regulations

+
memberof

Addenda16

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.Addenda17.html b/docs/interfaces/api.Addenda17.html new file mode 100644 index 0000000..2907a41 --- /dev/null +++ b/docs/interfaces/api.Addenda17.html @@ -0,0 +1,17 @@ +Addenda17 | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Addenda17

export
interface

Addenda17

+

Hierarchy

  • Addenda17

Index

Properties

Properties

entryDetailSequenceNumber

entryDetailSequenceNumber: number
+

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

+
memberof

Addenda17

+

Optional id

id?: string
+

Client-defined string used as a reference to this record.

+
memberof

Addenda17

+

paymentRelatedInformation

paymentRelatedInformation: string
+

Additional information related to the payment

+
memberof

Addenda17

+

sequenceNumber

sequenceNumber: number
+

SequenceNumber is consecutively assigned to each Addenda17 Record following an Entry Detail Record. The first Addenda17 sequence number must always be a 1.

+
memberof

Addenda17

+

typeCode

typeCode: string
+

17 - NACHA regulations

+
memberof

Addenda17

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.Addenda18.html b/docs/interfaces/api.Addenda18.html new file mode 100644 index 0000000..75b3322 --- /dev/null +++ b/docs/interfaces/api.Addenda18.html @@ -0,0 +1,26 @@ +Addenda18 | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Addenda18

export
interface

Addenda18

+

Hierarchy

  • Addenda18

Index

Properties

Properties

entryDetailSequenceNumber

entryDetailSequenceNumber: number
+

EntryDetailSequenceNumber contains the ascending sequence number section of the Entry Detail or Corporate Entry Detail Record's trace number. This number is the same as the last seven digits of the trace number of the related Entry Detail Record or Corporate Entry Detail Record.

+
memberof

Addenda18

+

foreignCorrespondentBankBranchCountryCode

foreignCorrespondentBankBranchCountryCode: string
+

Foreign Correspondent Bank Branch Country Code contains the two-character code, as approved by the International Organization for Standardization (ISO), to identify the country in which the branch of the Foreign Correspondent Bank is located. Values can be found on the International Organization for Standardization website: www.iso.org

+
memberof

Addenda18

+

foreignCorrespondentBankIDNumber

foreignCorrespondentBankIDNumber: string
+

Foreign Correspondent Bank Identification Number contains the bank ID number of the Foreign Correspondent Bank

+
memberof

Addenda18

+

Optional foreignCorrespondentBankIDNumberQualifier

foreignCorrespondentBankIDNumberQualifier?: string
+

Foreign Correspondent Bank Identification Number Qualifier contains a 2-digit code that identifies the numbering scheme used in the Foreign Correspondent Bank Identification Number field. Code values for this field are: "01" = National Clearing System | "02" = BIC Code | "03" = IBAN Code

+
memberof

Addenda18

+

foreignCorrespondentBankName

foreignCorrespondentBankName: string
+

Name of the Foreign Correspondent Bank

+
memberof

Addenda18

+

Optional id

id?: string
+

Client-defined string used as a reference to this record.

+
memberof

Addenda18

+

sequenceNumber

sequenceNumber: number
+

SequenceNumber is consecutively assigned to each Addenda17 Record following an Entry Detail Record. The first Addenda17 sequence number must always be a 1.

+
memberof

Addenda18

+

typeCode

typeCode: string
+

18 - NACHA regulations

+
memberof

Addenda18

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.Addenda98.html b/docs/interfaces/api.Addenda98.html new file mode 100644 index 0000000..8fc1b50 --- /dev/null +++ b/docs/interfaces/api.Addenda98.html @@ -0,0 +1,23 @@ +Addenda98 | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Addenda98

export
interface

Addenda98

+

Hierarchy

  • Addenda98

Index

Properties

Properties

changeCode

changeCode: string
+

ChangeCode field contains a standard code used by an ACH Operator or RDFI to describe the reason for a change Entry.

+
memberof

Addenda98

+

correctedData

correctedData: string
+

Correct field value of what changeCode references

+
memberof

Addenda98

+

Optional id

id?: string
+

Client-defined string used as a reference to this record.

+
memberof

Addenda98

+

originalDFI

originalDFI: string
+

The Receiving DFI Identification (addenda.RDFIIdentification) as originally included on the forward Entry or Prenotification that the RDFI is returning or correcting.

+
memberof

Addenda98

+

originalTrace

originalTrace: string
+

OriginalTrace This field contains the Trace Number as originally included on the forward Entry or Prenotification. The RDFI must include the Original Entry Trace Number in the Addenda Record of an Entry being returned to an ODFI, in the Addenda Record of an 98, within an Acknowledgment Entry, or with an RDFI request for a copy of an authorization.

+
memberof

Addenda98

+

Optional traceNumber

traceNumber?: string
+

Entry Detail Trace Number

+
memberof

Addenda98

+

typeCode

typeCode: string
+

98 - NACHA regulations

+
memberof

Addenda98

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.Addenda99.html b/docs/interfaces/api.Addenda99.html new file mode 100644 index 0000000..7ee3f17 --- /dev/null +++ b/docs/interfaces/api.Addenda99.html @@ -0,0 +1,26 @@ +Addenda99 | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Addenda99

export
interface

Addenda99

+

Hierarchy

  • Addenda99

Index

Properties

Properties

Optional addendaInformation

addendaInformation?: string
+

Information related to the return

+
memberof

Addenda99

+

dateOfDeath

dateOfDeath: string
+

The field date of death is to be supplied on Entries being returned for reason of death (return reason codes R14 and R15). (Format YYMMDD - Y=Year, M=Month, D=Day)

+
memberof

Addenda99

+

Optional id

id?: string
+

Client-defined string used as a reference to this record.

+
memberof

Addenda99

+

originalDFI

originalDFI: string
+

Contains the Receiving DFI Identification (addenda.RDFIIdentification) as originally included on the forward Entry or Prenotification that the RDFI is returning or correcting.

+
memberof

Addenda99

+

originalTrace

originalTrace: string
+

OriginalTrace This field contains the Trace Number as originally included on the forward Entry or Prenotification. The RDFI must include the Original Entry Trace Number in the Addenda Record of an Entry being returned to an ODFI, in the Addenda Record of an 98, within an Acknowledgment Entry, or with an RDFI request for a copy of an authorization.

+
memberof

Addenda99

+

returnCode

returnCode: string
+

Standard code used by an ACH Operator or RDFI to describe the reason for returning an Entry.

+
memberof

Addenda99

+

Optional traceNumber

traceNumber?: string
+

Matches the Entry Detail Trace Number of the entry being returned.

+
memberof

Addenda99

+

typeCode

typeCode: string
+

99 - NACHA regulations

+
memberof

Addenda99

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.Addenda99Contested.html b/docs/interfaces/api.Addenda99Contested.html new file mode 100644 index 0000000..0231fbe --- /dev/null +++ b/docs/interfaces/api.Addenda99Contested.html @@ -0,0 +1,32 @@ +Addenda99Contested | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Addenda99Contested

export
interface

Addenda99Contested

+

Hierarchy

  • Addenda99Contested

Index

Properties

Properties

addendaInformation

addendaInformation: string
+

Additional information of the Contested Dishonored Return

+
memberof

Addenda99Contested

+

dishonoredReturnReasonCode

dishonoredReturnReasonCode: string
+

Return reason code of the Dishonored Return

+
memberof

Addenda99Contested

+

Optional id

id?: string
+

Client-defined string used as a reference to this record.

+
memberof

Addenda99Contested

+

originalEntryTraceNumber

originalEntryTraceNumber: string
+

Trace Number of the original entry being returned.

+
memberof

Addenda99Contested

+

originalReceivingDFIIdentification

originalReceivingDFIIdentification: string
+

Identification of the Original Receiving Depository Institution (ODFI)

+
memberof

Addenda99Contested

+

returnReasonCode

returnReasonCode: string
+

Return reason code

+
memberof

Addenda99Contested

+

returnSettlementDate

returnSettlementDate: string
+

Return settlement date

+
memberof

Addenda99Contested

+

returnTraceNumber

returnTraceNumber: string
+

Return trace number

+
memberof

Addenda99Contested

+

traceNumber

traceNumber: string
+

Unique Trace Number for the contested dishonored return

+
memberof

Addenda99Contested

+

typeCode

typeCode: string
+

99 - NACHA regulations

+
memberof

Addenda99Contested

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.Addenda99Dishonored.html b/docs/interfaces/api.Addenda99Dishonored.html new file mode 100644 index 0000000..0d779b8 --- /dev/null +++ b/docs/interfaces/api.Addenda99Dishonored.html @@ -0,0 +1,44 @@ +Addenda99Dishonored | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Addenda99Dishonored

export
interface

Addenda99Dishonored

+

Hierarchy

  • Addenda99Dishonored

Index

Properties

Properties

contestedReturnCode

contestedReturnCode: string
+

return code explaining the contested dishonorment

+
memberof

Addenda99Dishonored

+

dateOriginalEntryReturned

dateOriginalEntryReturned: string
+

Date original entry was returned

+
memberof

Addenda99Dishonored

+

dishonoredReturnReasonCode

dishonoredReturnReasonCode: string
+

Return reason code of the Dishonored Return

+
memberof

Addenda99Dishonored

+

dishonoredReturnSettlementDate

dishonoredReturnSettlementDate: string
+

Settlement date of the Dishonored Return

+
memberof

Addenda99Dishonored

+

dishonoredReturnTraceNumber

dishonoredReturnTraceNumber: string
+

Trace number from Dishonored Return

+
memberof

Addenda99Dishonored

+

Optional id

id?: string
+

Client-defined string used as a reference to this record.

+
memberof

Addenda99Dishonored

+

originalEntryTraceNumber

originalEntryTraceNumber: string
+

Trace Number of the original entry being returned.

+
memberof

Addenda99Dishonored

+

originalReceivingDFIIdentification

originalReceivingDFIIdentification: string
+

Identification of the Original Receiving Depository Institution (ODFI)

+
memberof

Addenda99Dishonored

+

originalSettlementDate

originalSettlementDate: string
+

Original date of settlement

+
memberof

Addenda99Dishonored

+

returnReasonCode

returnReasonCode: string
+

Return reason code

+
memberof

Addenda99Dishonored

+

returnSettlementDate

returnSettlementDate: string
+

Return settlement date

+
memberof

Addenda99Dishonored

+

returnTraceNumber

returnTraceNumber: string
+

Return trace number

+
memberof

Addenda99Dishonored

+

Optional traceNumber

traceNumber?: string
+

Matches the Entry Detail Trace Number of the entry being returned.

+
memberof

Addenda99Dishonored

+

typeCode

typeCode: string
+

99 - NACHA regulations

+
memberof

Addenda99Dishonored

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.Batch.html b/docs/interfaces/api.Batch.html new file mode 100644 index 0000000..9308307 --- /dev/null +++ b/docs/interfaces/api.Batch.html @@ -0,0 +1,6 @@ +Batch | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Batch

export
interface

Batch

+

Hierarchy

  • Batch

Index

Properties

Properties

batchControl

batchControl: BatchControl
memberof

Batch

+

batchHeader

batchHeader: BatchHeader
memberof

Batch

+

entryDetails

entryDetails: EntryDetail[]
memberof

Batch

+

offset

offset: Offset
memberof

Batch

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.BatchControl.html b/docs/interfaces/api.BatchControl.html new file mode 100644 index 0000000..737169e --- /dev/null +++ b/docs/interfaces/api.BatchControl.html @@ -0,0 +1,32 @@ +BatchControl | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BatchControl

export
interface

BatchControl

+

Hierarchy

  • BatchControl

Index

Properties

Properties

Optional ID

ID?: string
+

Batch ID

+
memberof

BatchControl

+

ODFIIdentification

ODFIIdentification: string
+

The routing number is used to identify the DFI originating entries within a given branch.

+
memberof

BatchControl

+

batchNumber

batchNumber: number
+

BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.

+
memberof

BatchControl

+

companyIdentification

companyIdentification: string
+

Alphanumeric code used to identify an Originator. The Company Identification Field must be included on all prenotification records and on each entry initiated pursuant to such prenotification. The Company ID may begin with the ANSI one-digit Identification Code Designator (ICD), followed by the identification number. Possible ICDs are the IRS Employer Identification Number (EIN) "1", Data Universal Numbering Systems (DUNS) "3", and User Assigned Number "9".

+
memberof

BatchControl

+

entryAddendaCount

entryAddendaCount: number
+

EntryAddendaCount is a tally of each Entry Detail Record and each Addenda Record processed, within either the batch or file as appropriate.

+
memberof

BatchControl

+

entryHash

entryHash: number
+

Validate the Receiving DFI Identification in each Entry Detail Record is hashed to provide a check against inadvertent alteration of data contents due to hardware failure or program error. In this context the Entry Hash is the sum of the corresponding fields in the Entry Detail Records on the file.

+
memberof

BatchControl

+

Optional messageAuthentication

messageAuthentication?: string
+

MAC is an eight character code derived from a special key used in conjunction with the DES algorithm. The purpose of the MAC is to validate the authenticity of ACH entries. The DES algorithm and key message standards must be in accordance with standards adopted by the American National Standards Institute. The remaining eleven characters of this field are blank.

+
memberof

BatchControl

+

serviceClassCode

serviceClassCode: number
+

Same as ServiceClassCode in BatchHeaderRecord

+
memberof

BatchControl

+

totalCredit

totalCredit: number
+

Contains accumulated Entry credit totals within the batch.

+
memberof

BatchControl

+

totalDebit

totalDebit: number
+

Contains accumulated Entry debit totals within the batch.

+
memberof

BatchControl

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.BatchHeader.html b/docs/interfaces/api.BatchHeader.html new file mode 100644 index 0000000..c809d6a --- /dev/null +++ b/docs/interfaces/api.BatchHeader.html @@ -0,0 +1,38 @@ +BatchHeader | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BatchHeader

export
interface

BatchHeader

+

Hierarchy

  • BatchHeader

Index

Properties

Properties

Optional ID

ID?: string
+

A client-defined ID used as a reference to this batch

+
memberof

BatchHeader

+

ODFIIdentification

ODFIIdentification: string
+

First 8 digits of the originating DFI transit routing number

+
memberof

BatchHeader

+

batchNumber

batchNumber: number
+

BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.

+
memberof

BatchHeader

+

Optional companyDescriptiveDate

companyDescriptiveDate?: string
+

The Originator establishes this field as the date it would like to see displayed to the receiver for descriptive purposes. This field is never used to control timing of any computer or manual operation. It is solely for descriptive purposes. The RDFI should not assume any specific format.

+
memberof

BatchHeader

+

Optional companyDiscretionaryData

companyDiscretionaryData?: string
+

The 9 digit FEIN number (proceeded by a predetermined alpha or numeric character) of the entity in the company name field

+
memberof

BatchHeader

+

Optional companyEntryDescription

companyEntryDescription?: string
+

A description of the entries contained in the batch. The Originator establishes the value of this field to provide a description of the purpose of the entry to be displayed back to the receiver. For example, "GAS BILL," "REG. SALARY," "INS. PREM,", "SOC. SEC.," "DTC," "TRADE PAY," "PURCHASE," etc. This field must contain the word "REVERSAL" (left justified) when the batch contains reversing entries. This field must contain the word "RECLAIM" (left justified) when the batch contains reclamation entries. This field must contain the word "NONSETTLED" (left justified) when the batch contains entries which could not settle.

+
memberof

BatchHeader

+

companyIdentification

companyIdentification: string
+

Alphanumeric code used to identify an Originator. The Company Identification Field must be included on all prenotification records and on each entry initiated pursuant to such prenotification. The Company ID may begin with the ANSI one-digit Identification Code Designator (ICD), followed by the identification number. Possible ICDs are the IRS Employer Identification Number (EIN) "1", Data Universal Numbering Systems (DUNS) "3", or User Assigned Number "9".

+
memberof

BatchHeader

+

companyName

companyName: string
+

Company originating the entries in the batch

+
memberof

BatchHeader

+

Optional effectiveEntryDate

effectiveEntryDate?: string
+

Date on which the entries are to settle. (Format YYMMDD - Y=Year, M=Month, D=Day)

+
memberof

BatchHeader

+

Optional originatorStatusCode

originatorStatusCode?: number
+

ODFI initiating the Entry. | 0 - ADV File prepared by an ACH Operator. | 1 - This code identifies the Originator as a depository financial institution. | 2 - This code identifies the Originator as a Federal Government entity or agency.

+
memberof

BatchHeader

+

serviceClassCode

serviceClassCode: number
+

Service Class Code - Mixed Debits and Credits '200', ACH Credits Only '220', or ACH Debits Only '225'

+
memberof

BatchHeader

+

standardEntryClassCode

standardEntryClassCode: string
+

Identifies the payment type (product) found within an ACH batch using a 3-character code.

+
memberof

BatchHeader

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.CreateFile.html b/docs/interfaces/api.CreateFile.html new file mode 100644 index 0000000..92b33b4 --- /dev/null +++ b/docs/interfaces/api.CreateFile.html @@ -0,0 +1,11 @@ +CreateFile | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateFile

export
interface

CreateFile

+

Hierarchy

  • CreateFile

Index

Properties

Properties

Optional IATBatches

IATBatches?: IATBatch[]
memberof

CreateFile

+

Optional ID

ID?: string
+

File ID

+
memberof

CreateFile

+

Optional advBatchControl

advBatchControl?: ADVBatchControl
memberof

CreateFile

+

Optional advEntryDetails

advEntryDetails?: ADVEntryDetail[]
memberof

CreateFile

+

Optional batches

batches?: Batch[]
memberof

CreateFile

+

Optional fileControl

fileControl?: FileControl
memberof

CreateFile

+

fileHeader

fileHeader: FileHeader
memberof

CreateFile

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.EntryDetail.html b/docs/interfaces/api.EntryDetail.html new file mode 100644 index 0000000..5e2776a --- /dev/null +++ b/docs/interfaces/api.EntryDetail.html @@ -0,0 +1,46 @@ +EntryDetail | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EntryDetail

export
interface

EntryDetail

+

Hierarchy

  • EntryDetail

Index

Properties

Properties

DFIAccountNumber

DFIAccountNumber: string
+

The receiver's bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so it's space padded, not zero padded

+
memberof

EntryDetail

+

Optional ID

ID?: string
+

Entry Detail ID

+
memberof

EntryDetail

+

RDFIIdentification

RDFIIdentification: string
+

RDFI's routing number without the last digit.

+
memberof

EntryDetail

+

Optional addenda02

addenda02?: Addenda02
memberof

EntryDetail

+

Optional addenda05

addenda05?: Addenda05[]
+

List of Addenda05 records

+
memberof

EntryDetail

+

Optional addenda98

addenda98?: Addenda98
memberof

EntryDetail

+

Optional addenda99

addenda99?: Addenda99
memberof

EntryDetail

+

Optional addenda99Contested

addenda99Contested?: Addenda99Contested
memberof

EntryDetail

+

Optional addenda99Dishonored

addenda99Dishonored?: Addenda99Dishonored
memberof

EntryDetail

+

Optional addendaRecordIndicator

addendaRecordIndicator?: number
+

AddendaRecordIndicator indicates the existence of an Addenda Record. A value of "1" indicates that one or more addenda records follow, and "0" means no such record is present.

+
memberof

EntryDetail

+

amount

amount: number
+

Number of cents you are debiting/crediting this account

+
memberof

EntryDetail

+

Optional category

category?: string
+

Category defines if the entry is a Forward, Return, or NOC

+
memberof

EntryDetail

+

checkDigit

checkDigit: string
+

Last digit in RDFI routing number.

+
memberof

EntryDetail

+

Optional discretionaryData

discretionaryData?: string
+

DiscretionaryData allows ODFIs to include codes, of significance only to them, to enable specialized handling of the entry. There will be no standardized interpretation for the value of this field. It can either be a single two-character code, or two distinct one-character codes, according to the needs of the ODFI and/or Originator involved. This field must be returned intact for any returned entry. WEB uses the Discretionary Data Field as the Payment Type Code.

+
memberof

EntryDetail

+

Optional identificationNumber

identificationNumber?: string
+

Internal identification (alphanumeric) that you use to uniquely identify this Entry Detail Record

+
memberof

EntryDetail

+

individualName

individualName: string
+

The name of the receiver, usually the name on the bank account

+
memberof

EntryDetail

+

Optional traceNumber

traceNumber?: string
+

TraceNumber assigned by the ODFI in ascending sequence, is included in each Entry Detail Record, Corporate Entry Detail Record, and Addenda Record. Trace Numbers uniquely identify each entry within a batch in an ACH input file. In association with the Batch Number, transmission (File Creation) Date, and File ID Modifier, the Trace Number uniquely identifies an entry within a given file. For Addenda Records, the Trace Number will be identical to the Trace Number in the associated Entry Detail Record, since the Trace Number is associated with an entry or item rather than a physical record.

+
memberof

EntryDetail

+

transactionCode

transactionCode: number
+

Based on transaction type: 22 - Credit (deposit) to checking account | 23 - Prenote for credit to checking account | 27 - Debit (withdrawal) to checking account | 28 - Prenote for debit to checking account | 32 - Credit to savings account | 33 - Prenote for credit to savings account | 37 - Debit to savings account | 38 - Prenote for debit to savings account

+
memberof

EntryDetail

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.FileControl.html b/docs/interfaces/api.FileControl.html new file mode 100644 index 0000000..ffabfee --- /dev/null +++ b/docs/interfaces/api.FileControl.html @@ -0,0 +1,23 @@ +FileControl | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileControl

export
interface

FileControl

+

Hierarchy

  • FileControl

Index

Properties

Properties

ID

ID: string
+

File ID

+
memberof

FileControl

+

batchCount

batchCount: number
+

Count of Batches in the File

+
memberof

FileControl

+

blockCount

blockCount: number
+

Total number of records in the file (include all headers and trailer) divided by 10 (This number must be evenly divisible by 10. If not, additional records consisting of all 9's are added to the file after the initial '9' record to fill out the block 10.)

+
memberof

FileControl

+

entryAddendaCount

entryAddendaCount: number
+

Total detail and addenda records in the file

+
memberof

FileControl

+

entryHash

entryHash: number
+

Calculated in the same manner as the batch total but includes total from entire file

+
memberof

FileControl

+

totalCredit

totalCredit: number
+

Accumulated Batch credit totals within the file.

+
memberof

FileControl

+

totalDebit

totalDebit: number
+

Accumulated Batch debit totals within the file.

+
memberof

FileControl

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.FileHeader.html b/docs/interfaces/api.FileHeader.html new file mode 100644 index 0000000..1a3d74b --- /dev/null +++ b/docs/interfaces/api.FileHeader.html @@ -0,0 +1,29 @@ +FileHeader | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileHeader

export
interface

FileHeader

+

Hierarchy

  • FileHeader

Index

Properties

Properties

Optional ID

ID?: string
+

File ID

+
memberof

FileHeader

+

fileCreationDate

fileCreationDate: string
+

The File Creation Date is the date when the file was prepared by an ODFI. (Format YYMMDD - Y=Year, M=Month, D=Day)

+
memberof

FileHeader

+

fileCreationTime

fileCreationTime: string
+

The File Creation Time is the time when the file was prepared by an ODFI. (Format HHmm - H=Hour, m=Minute)

+
memberof

FileHeader

+

Optional fileIDModifier

fileIDModifier?: string
+

Incremented value for each file for RDFIs.

+
memberof

FileHeader

+

immediateDestination

immediateDestination: string
+

Contains the Routing Number of the ACH Operator or receiving point to which the file is being sent.

+
memberof

FileHeader

+

immediateDestinationName

immediateDestinationName: string
+

The name of the ACH Operator or receiving point to which the file is being sent.

+
memberof

FileHeader

+

immediateOrigin

immediateOrigin: string
+

Contains the Routing Number of the ACH Operator or sending point that is sending the file.

+
memberof

FileHeader

+

immediateOriginName

immediateOriginName: string
+

The name of the ACH Operator or sending point that is sending the file.

+
memberof

FileHeader

+

Optional referenceCode

referenceCode?: string
+

Reserved field for information pertinent to the Originator.

+
memberof

FileHeader

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.FileID.html b/docs/interfaces/api.FileID.html new file mode 100644 index 0000000..8d5d841 --- /dev/null +++ b/docs/interfaces/api.FileID.html @@ -0,0 +1,8 @@ +FileID | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileID

export
interface

FileID

+

Hierarchy

  • FileID

Index

Properties

Properties

Optional ID

ID?: string
+

File ID

+
memberof

FileID

+

Optional error

error?: string
+

An error message describing the problem intended for humans.

+
memberof

FileID

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.IATBatch.html b/docs/interfaces/api.IATBatch.html new file mode 100644 index 0000000..8e40a88 --- /dev/null +++ b/docs/interfaces/api.IATBatch.html @@ -0,0 +1,8 @@ +IATBatch | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IATBatch

export
interface

IATBatch

+

Hierarchy

  • IATBatch

Index

Properties

Properties

IATBatchHeader

IATBatchHeader: IATBatchHeader
memberof

IATBatch

+

IATEntryDetails

IATEntryDetails: IATEntryDetail[]
memberof

IATBatch

+

Optional ID

ID?: string
+

Client-defined string used as a reference to this record.

+
memberof

IATBatch

+

batchControl

batchControl: BatchControl
memberof

IATBatch

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.IATBatchHeader.html b/docs/interfaces/api.IATBatchHeader.html new file mode 100644 index 0000000..cdff3e7 --- /dev/null +++ b/docs/interfaces/api.IATBatchHeader.html @@ -0,0 +1,50 @@ +IATBatchHeader | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IATBatchHeader

export
interface

IATBatchHeader

+

Hierarchy

  • IATBatchHeader

Index

Properties

Properties

Optional IATIndicator

IATIndicator?: string
+

Leave Blank. Only used for corrected IAT entries

+
memberof

IATBatchHeader

+

Optional ID

ID?: string
+

ID is a client-defined string used as a reference to this record.

+
memberof

IATBatchHeader

+

ISODestinationCountryCode

ISODestinationCountryCode: string
+

Two-character code, as approved by the International Organization for Standardization (ISO), to identify the country in which the entry is to be received. For United States use US.

+
memberof

IATBatchHeader

+

ISODestinationCurrencyCode

ISODestinationCurrencyCode: string
+

ISODestinationCurrencyCode is the three-character code, as approved by the International Organization for Standardization (ISO), to identify the currency denomination in which the entry will ultimately be settled. If the final destination of funds is within the territorial jurisdiction of the U.S., enter "USD", otherwise refer to International Organization for Standardization website for value: www.iso.org

+
memberof

IATBatchHeader

+

ISOOriginatingCurrencyCode

ISOOriginatingCurrencyCode: string
+

Three-character code, as approved by the International Organization for Standardization (ISO), to identify the currency denomination in which the entry was first originated. If the source of funds is within the territorial jurisdiction of the U.S., enter 'USD', otherwise refer to International Organization for Standardization website for value: www.iso.org

+
memberof

IATBatchHeader

+

ODFIIdentification

ODFIIdentification: string
+

First 8 digits of the originating DFI transit routing number. For Inbound IAT Entries, this field contains the routing number of the U.S. Gateway Operator. For Outbound IAT Entries, this field contains the standard routing number, as assigned by Accuity, that identifies the U.S. ODFI initiating the Entry. (Format TTTTAAAA - T=Federal Reserve Routing Symbol, A=ABA Institution Identifier)

+
memberof

IATBatchHeader

+

batchNumber

batchNumber: number
+

BatchNumber is assigned in ascending sequence to each batch by the ODFI or its Sending Point in a given file of entries. Since the batch number in the Batch Header Record and the Batch Control Record is the same, the ascending sequence number should be assigned by batch and not by record.

+
memberof

IATBatchHeader

+

Optional companyEntryDescription

companyEntryDescription?: string
+

A description of the entries contained in the batch The Originator establishes the value of this field to provide a description of the purpose of the entry to be displayed back to the receiver. For example, "GAS BILL," "REG. SALARY," "INS. PREM," "SOC. SEC.," "DTC," "TRADE PAY," "PURCHASE," etc. This field must contain the word "REVERSAL" (left justified) when the batch contains reversing entries. This field must contain the word "RECLAIM" (left justified) when the batch contains reclamation entries. This field must contain the word "NONSETTLED" (left justified) when the batch contains entries which could not settle.

+
memberof

IATBatchHeader

+

Optional effectiveEntryDate

effectiveEntryDate?: string
+

EffectiveEntryDate the date on which the entries are to settle. Format YYMMDD (Y=Year, M=Month, D=Day)

+
memberof

IATBatchHeader

+

foreignExchangeIndicator

foreignExchangeIndicator: string
+

Code indicating currency conversion: 'FV' (Fixed-to-Variable) – Entry is originated in a fixed-value amount and is to be received in a variable amount resulting from the execution of the foreign exchange conversion. | 'VF' (Variable-to-Fixed) – Entry is originated in a variable-value amount based on a specific foreign exchange rate for conversion to a fixed-value amount in which the entry is to be received. | 'FF' (Fixed-to-Fixed) – Entry is originated in a fixed-value amount and is to be received in the same fixed-value amount in the same currency denomination. There is no foreign exchange conversion for entries transmitted using this code. For entries originated in a fixed value amount, the foreign Exchange Reference Field will be space filled.

+
memberof

IATBatchHeader

+

foreignExchangeReference

foreignExchangeReference: string
+

Contains either the foreign exchange rate used to execute the foreign exchange conversion of a cross-border entry or another reference to the foreign exchange transaction.

+
memberof

IATBatchHeader

+

foreignExchangeReferenceIndicator

foreignExchangeReferenceIndicator: number
+

Code used to indicate the content of the Foreign Exchange Reference Field and is filled by the gateway operator. Valid entries are 1 - Foreign Exchange Rate | 2 - Foreign Exchange Reference Number | 3 - Space Filled

+
memberof

IATBatchHeader

+

originatorIdentification

originatorIdentification: string
+

For U.S. entities: the number assigned will be your tax ID (often Social Security Number) For non-U.S. entities: the number assigned will be your DDA number, or the last 9 characters of your account number if it exceeds 9 characters

+
memberof

IATBatchHeader

+

Optional originatorStatusCode

originatorStatusCode?: number
+

ODFI initiating the Entry. | 0 - ADV File prepared by an ACH Operator. | 1 - This code identifies the Originator as a depository financial institution. | 2 - This code identifies the Originator as a Federal Government entity or agency.

+
memberof

IATBatchHeader

+

serviceClassCode

serviceClassCode: number
+

Service Class Code - Mixed Debits and Credits '200', ACH Credits Only '220', or ACH Debits Only '225'

+
memberof

IATBatchHeader

+

standardEntryClassCode

standardEntryClassCode: string
+

StandardEntryClassCode for consumer and non consumer international payments is IAT. Identifies the payment type (product) found within an ACH batch using a 3-character code. The SEC Code pertains to all items within batch. Determines format of the detail records. Determines addenda records (required or optional PLUS one or up to 9,999 records). Determines rules to follow (return time frames). Some SEC codes require specific data in predetermined fields within the ACH record.

+
memberof

IATBatchHeader

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.IATEntryDetail.html b/docs/interfaces/api.IATEntryDetail.html new file mode 100644 index 0000000..ae52641 --- /dev/null +++ b/docs/interfaces/api.IATEntryDetail.html @@ -0,0 +1,49 @@ +IATEntryDetail | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IATEntryDetail

export
interface

IATEntryDetail

+

Hierarchy

  • IATEntryDetail

Index

Properties

Properties

DFIAccountNumber

DFIAccountNumber: string
+

The receiver's bank account number you are crediting/debiting. It important to note that this is an alphanumeric field, so it's space padded, not zero padded

+
memberof

IATEntryDetail

+

Optional ID

ID?: string
+

Entry Detail ID

+
memberof

IATEntryDetail

+

OFACScreeningIndicator

OFACScreeningIndicator: string
+

Signifies if the record has been screened against OFAC records

+
memberof

IATEntryDetail

+

RDFIIdentification

RDFIIdentification: string
+

RDFI's routing number without the last digit.

+
memberof

IATEntryDetail

+

addenda10

addenda10: Addenda10
memberof

IATEntryDetail

+

addenda11

addenda11: Addenda11
memberof

IATEntryDetail

+

addenda12

addenda12: Addenda12
memberof

IATEntryDetail

+

addenda13

addenda13: Addenda13
memberof

IATEntryDetail

+

addenda14

addenda14: Addenda14
memberof

IATEntryDetail

+

addenda15

addenda15: Addenda15
memberof

IATEntryDetail

+

addenda16

addenda16: Addenda16
memberof

IATEntryDetail

+

Optional addenda17

addenda17?: Addenda17
memberof

IATEntryDetail

+

Optional addenda18

addenda18?: Addenda18
memberof

IATEntryDetail

+

Optional addenda98

addenda98?: Addenda98
memberof

IATEntryDetail

+

Optional addenda99

addenda99?: Addenda99
memberof

IATEntryDetail

+

addendaRecordIndicator

addendaRecordIndicator: number
+

AddendaRecordIndicator indicates the existence of an Addenda Record. A value of "1" indicates that one or more addenda records follow, and "0" means no such record is present.

+
memberof

IATEntryDetail

+

addendaRecords

addendaRecords: number
+

Number of Addenda Records

+
memberof

IATEntryDetail

+

amount

amount: number
+

Number of cents you are debiting/crediting this account

+
memberof

IATEntryDetail

+

Optional category

category?: string
+

Category defines if the entry is a Forward, Return, or NOC

+
memberof

IATEntryDetail

+

checkDigit

checkDigit: string
+

Last digit in RDFI routing number.

+
memberof

IATEntryDetail

+

secondaryOFACScreeningIndicator

secondaryOFACScreeningIndicator: string
+

Signifies if the record has been screened against OFAC records by a secondary entry

+
memberof

IATEntryDetail

+

Optional traceNumber

traceNumber?: string
+

Matches the Entry Detail Trace Number of the entry being returned.

+
memberof

IATEntryDetail

+

transactionCode

transactionCode: number
+

Based on transaction type: 22 - Credit (deposit) to checking account | 23 - Prenote for credit to checking account | 27 - Debit (withdrawal) to checking account | 28 - Prenote for debit to checking account | 32 - Credit to savings account | 33 - Prenote for credit to savings account | 37 - Debit to savings account | 38 - Prenote for debit to savings account

+
memberof

IATEntryDetail

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.ModelError.html b/docs/interfaces/api.ModelError.html new file mode 100644 index 0000000..a44a4ab --- /dev/null +++ b/docs/interfaces/api.ModelError.html @@ -0,0 +1,5 @@ +ModelError | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ModelError

export
interface

ModelError

+

Hierarchy

  • ModelError

Index

Properties

Properties

error

error: string
+

An error message describing the problem intended for humans.

+
memberof

ModelError

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.ModelFile.html b/docs/interfaces/api.ModelFile.html new file mode 100644 index 0000000..f8bee51 --- /dev/null +++ b/docs/interfaces/api.ModelFile.html @@ -0,0 +1,12 @@ +ModelFile | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ModelFile

export
interface

ModelFile

+

Hierarchy

  • ModelFile

Index

Properties

Properties

Optional IATBatches

IATBatches?: IATBatch[]
memberof

ModelFile

+

ID

ID: string
+

File ID

+
memberof

ModelFile

+

Optional NotificationOfChange

NotificationOfChange?: null | Batch[]
memberof

ModelFile

+

Optional ReturnEntries

ReturnEntries?: null | Batch[]
memberof

ModelFile

+

Optional batches

batches?: Batch[]
memberof

ModelFile

+

Optional fileADVControl

fileADVControl?: ADVFileControl
memberof

ModelFile

+

fileControl

fileControl: FileControl
memberof

ModelFile

+

fileHeader

fileHeader: FileHeader
memberof

ModelFile

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.Offset.html b/docs/interfaces/api.Offset.html new file mode 100644 index 0000000..b253a6e --- /dev/null +++ b/docs/interfaces/api.Offset.html @@ -0,0 +1,14 @@ +Offset | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Offset

export
interface

Offset

+

Hierarchy

  • Offset

Index

Properties

Properties

accountNumber

accountNumber: string
+

Account number used to offset records

+
memberof

Offset

+

accountType

accountType: OffsetAccountTypeEnum
+

Account type used in offset record

+
memberof

Offset

+

description

description: string
+

Memo for Offset EntryDetail record

+
memberof

Offset

+

routingNumber

routingNumber: string
+

ABA routing number

+
memberof

Offset

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.SegmentedFiles.html b/docs/interfaces/api.SegmentedFiles.html new file mode 100644 index 0000000..af04853 --- /dev/null +++ b/docs/interfaces/api.SegmentedFiles.html @@ -0,0 +1,8 @@ +SegmentedFiles | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SegmentedFiles

export
interface

SegmentedFiles

+

Hierarchy

  • SegmentedFiles

Index

Properties

Properties

Optional creditFileID

creditFileID?: string
+

File ID

+
memberof

SegmentedFiles

+

Optional debitFileID

debitFileID?: string
+

File ID

+
memberof

SegmentedFiles

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/api.ValidateOpts.html b/docs/interfaces/api.ValidateOpts.html new file mode 100644 index 0000000..4f34969 --- /dev/null +++ b/docs/interfaces/api.ValidateOpts.html @@ -0,0 +1,11 @@ +ValidateOpts | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ValidateOpts

export
interface

ValidateOpts

+

Hierarchy

  • ValidateOpts

Index

Properties

Properties

Optional bypassDestinationValidation

bypassDestinationValidation?: boolean
+

Skip ImmediateDestination validation steps.

+
memberof

ValidateOpts

+

Optional bypassOriginValidation

bypassOriginValidation?: boolean
+

Skip ImmediateOrigin validation steps.

+
memberof

ValidateOpts

+

Optional requireABAOrigin

requireABAOrigin?: boolean
+

Require that the FileHeader ImmediateOrigin routing number which checksum matches.

+
memberof

ValidateOpts

+

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/base.RequestArgs.html b/docs/interfaces/base.RequestArgs.html new file mode 100644 index 0000000..164d8a0 --- /dev/null +++ b/docs/interfaces/base.RequestArgs.html @@ -0,0 +1,2 @@ +RequestArgs | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RequestArgs

export
interface

RequestArgs

+

Hierarchy

  • RequestArgs

Index

Properties

Properties

options

options: AxiosRequestConfig

url

url: string

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/configuration.ConfigurationParameters.html b/docs/interfaces/configuration.ConfigurationParameters.html new file mode 100644 index 0000000..8c03d91 --- /dev/null +++ b/docs/interfaces/configuration.ConfigurationParameters.html @@ -0,0 +1,8 @@ +ConfigurationParameters | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ConfigurationParameters

+

ACH API +Moov ACH (Automated Clearing House) implements an HTTP API for creating, parsing, and validating ACH files. ACH is the primary method of electronic money movement throughout the United States.

+

The version of the OpenAPI document: v1

+

NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). +https://openapi-generator.tech +Do not edit the class manually.

+

Hierarchy

  • ConfigurationParameters

Index

Properties

Properties

Optional accessToken

accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>)

Optional apiKey

apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>)

Optional baseOptions

baseOptions?: any

Optional basePath

basePath?: string

Optional formDataCtor

formDataCtor?: (new () => any)

Type declaration

    • new (): any

    • Returns any

Optional password

password?: string

Optional username

username?: string

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/url.Url.html b/docs/interfaces/url.Url.html new file mode 100644 index 0000000..b65f3e9 --- /dev/null +++ b/docs/interfaces/url.Url.html @@ -0,0 +1 @@ +Url | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Url

Hierarchy

  • Url

Index

Properties

Properties

Optional hostname

hostname?: string

Optional pathname

pathname?: string

Optional protocol

protocol?: string

query

query: object

search

search: string

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Property
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html new file mode 100644 index 0000000..93f0011 --- /dev/null +++ b/docs/modules.html @@ -0,0 +1 @@ +ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

ach-node-sdk

Index

Modules

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/_api_.html b/docs/modules/_api_.html deleted file mode 100644 index 3b9277d..0000000 --- a/docs/modules/_api_.html +++ /dev/null @@ -1,2323 +0,0 @@ - - - - - - "api" | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Module "api"

-
-
-
-
-
-
-
-

Index

-
-
-
-

Enumerations

- -
-
-

Classes

- -
-
-

Interfaces

- -
-
-

Functions

- -
-
-
-
-
-

Functions

-
- -

Const ACHFilesApiAxiosParamCreator

-
    -
  • ACHFilesApiAxiosParamCreator(configuration?: Configuration): { addBatchToFile: any; checkFile: any; createFile: any; deleteACHFile: any; deleteFileBatch: any; flattenFile: any; getFileBatch: any; getFileBatches: any; getFileByID: any; getFileContents: any; getFiles: any; ping: any; segmentFile: any; validateFile: any }
    • -
-
    -
  • - -
    -
    -

    ACHFilesApi - axios parameter creator

    -
    -
    -
    export
    -
    -
    -
    -

    Parameters

    - -

    Returns { addBatchToFile: any; checkFile: any; createFile: any; deleteACHFile: any; deleteFileBatch: any; flattenFile: any; getFileBatch: any; getFileBatches: any; getFileByID: any; getFileContents: any; getFiles: any; ping: any; segmentFile: any; validateFile: any }

    -
      -
    • -
      addBatchToFile: function
      -
        -
      • addBatchToFile(fileID: string, batch: Batch, xRequestID?: undefined | string, xIdempotencyKey?: undefined | string, options?: any): Promise<RequestArgs>
        • -
      -
        -
      • - -
        -
        -

        Append a Batch record to the specified file

        -
        -
        -
        summary
        -

        Add Batch to File

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -
          -

          File ID

          -
          -
          -
          • -
        • -
          batch: Batch
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional xIdempotencyKey: undefined | string
          -
          • -
        • -
          Default value options: any = {}
          -
          • -
        -

        Returns Promise<RequestArgs>

        -
        • -
      -
      • -
    • -
      checkFile: function
      -
        -
      • checkFile(fileID: string, xRequestID?: undefined | string, options?: any): Promise<RequestArgs>
        • -
      -
        -
      • - -
        -
        -

        Validates the existing file. You need only supply the unique File identifier that was returned upon creation.

        -
        -
        -
        summary
        -

        Validate file

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -
          -

          File ID

          -
          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Default value options: any = {}
          -
          • -
        -

        Returns Promise<RequestArgs>

        -
        • -
      -
      • -
    • -
      createFile: function
      -
        -
      • createFile(createFile: CreateFile, xRequestID?: undefined | string, xIdempotencyKey?: undefined | string, options?: any): Promise<RequestArgs>
        • -
      -
        -
      • - -
        -
        -

        Create a new File object from either the plaintext or JSON representation.

        -
        -

        Content of the ACH file (in json or raw text)

        -
        -
        summary
        -

        Create File

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          createFile: CreateFile
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional xIdempotencyKey: undefined | string
          -
          • -
        • -
          Default value options: any = {}
          -
          • -
        -

        Returns Promise<RequestArgs>

        -
        • -
      -
      • -
    • -
      deleteACHFile: function
      -
        -
      • deleteACHFile(fileID: string, xRequestID?: undefined | string, options?: any): Promise<RequestArgs>
        • -
      -
        -
      • - -
        -
        -

        Permanently deletes a File and associated Batches. It cannot be undone.

        -
        -
        -
        summary
        -

        Delete file

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -
          -

          File ID

          -
          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Default value options: any = {}
          -
          • -
        -

        Returns Promise<RequestArgs>

        -
        • -
      -
      • -
    • -
      deleteFileBatch: function
      -
        -
      • deleteFileBatch(fileID: string, batchID: string, xRequestID?: undefined | string, options?: any): Promise<RequestArgs>
        • -
      -
        -
      • - -
        -
        -

        Delete a Batch from a File

        -
        -
        -
        summary
        -

        Delete batch

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -
          -

          File ID

          -
          -
          -
          • -
        • -
          batchID: string
          -
          -
          -

          Batch ID

          -
          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Default value options: any = {}
          -
          • -
        -

        Returns Promise<RequestArgs>

        -
        • -
      -
      • -
    • -
      flattenFile: function
      -
        -
      • flattenFile(fileID: string, xRequestID?: undefined | string, xIdempotencyKey?: undefined | string, options?: any): Promise<RequestArgs>
        • -
      -
        -
      • - -
        -
        -

        Consolidate batches and entries into the minimum number of batches needed.

        -
        -
        -
        summary
        -

        Flatten batches

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -
          -

          File ID

          -
          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional xIdempotencyKey: undefined | string
          -
          • -
        • -
          Default value options: any = {}
          -
          • -
        -

        Returns Promise<RequestArgs>

        -
        • -
      -
      • -
    • -
      getFileBatch: function
      -
        -
      • getFileBatch(fileID: string, batchID: string, xRequestID?: undefined | string, options?: any): Promise<RequestArgs>
        • -
      -
        -
      • - -
        -
        -

        Get a specific Batch on a File

        -
        -
        -
        summary
        -

        Get Batch

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -
          -

          File ID

          -
          -
          -
          • -
        • -
          batchID: string
          -
          -
          -

          Batch ID

          -
          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Default value options: any = {}
          -
          • -
        -

        Returns Promise<RequestArgs>

        -
        • -
      -
      • -
    • -
      getFileBatches: function
      -
        -
      • getFileBatches(fileID: string, xRequestID?: undefined | string, options?: any): Promise<RequestArgs>
        • -
      - -
      • -
    • -
      getFileByID: function
      -
        -
      • getFileByID(fileID: string, xRequestID?: undefined | string, options?: any): Promise<RequestArgs>
        • -
      -
        -
      • - -
        -
        -

        Get the details of an existing File using the unique File identifier that was returned upon creation.

        -
        -
        -
        summary
        -

        Retrieve a file

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -
          -

          File ID

          -
          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Default value options: any = {}
          -
          • -
        -

        Returns Promise<RequestArgs>

        -
        • -
      -
      • -
    • -
      getFileContents: function
      -
        -
      • getFileContents(fileID: string, xRequestID?: undefined | string, options?: any): Promise<RequestArgs>
        • -
      -
        -
      • - -
        -
        -

        Assembles the existing file (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.

        -
        -
        -
        summary
        -

        Get file contents

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -
          -

          File ID

          -
          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Default value options: any = {}
          -
          • -
        -

        Returns Promise<RequestArgs>

        -
        • -
      -
      • -
    • -
      getFiles: function
      -
        -
      • getFiles(xRequestID?: undefined | string, options?: any): Promise<RequestArgs>
        • -
      -
        -
      • - -
        -
        -

        List all ACH files created with the ACH service. These files are not persisted through multiple runs of the service.

        -
        -
        -
        summary
        -

        Get ACH files

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Default value options: any = {}
          -
          • -
        -

        Returns Promise<RequestArgs>

        -
        • -
      -
      • -
    • -
      ping: function
      - - -
      • -
    • -
      segmentFile: function
      -
        -
      • segmentFile(fileID: string, xRequestID?: undefined | string, xIdempotencyKey?: undefined | string, options?: any): Promise<RequestArgs>
        • -
      -
        -
      • - -
        -
        -

        Split one file into two. One with only debits and one with only credits.

        -
        -
        -
        summary
        -

        Segment file

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -
          -

          File ID

          -
          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional xIdempotencyKey: undefined | string
          -
          • -
        • -
          Default value options: any = {}
          -
          • -
        -

        Returns Promise<RequestArgs>

        -
        • -
      -
      • -
    • -
      validateFile: function
      -
        -
      • validateFile(fileID: string, xRequestID?: undefined | string, validateOpts?: ValidateOpts, options?: any): Promise<RequestArgs>
        • -
      -
        -
      • - -
        -
        -

        Validates the existing file. You need only supply the unique File identifier that was returned upon creation.

        -
        -
        -
        summary
        -

        Validate file

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -
          -

          File ID

          -
          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional validateOpts: ValidateOpts
          -
          • -
        • -
          Default value options: any = {}
          -
          • -
        -

        Returns Promise<RequestArgs>

        -
        • -
      -
      • -
    -
    • -
-
-
- -

Const ACHFilesApiFactory

-
    -
  • ACHFilesApiFactory(configuration?: Configuration, basePath?: undefined | string, axios?: AxiosInstance): { addBatchToFile: any; checkFile: any; createFile: any; deleteACHFile: any; deleteFileBatch: any; flattenFile: any; getFileBatch: any; getFileBatches: any; getFileByID: any; getFileContents: any; getFiles: any; ping: any; segmentFile: any; validateFile: any }
    • -
-
    -
  • - -
    -
    -

    ACHFilesApi - factory interface

    -
    -
    -
    export
    -
    -
    -
    -

    Parameters

    -
      -
    • -
      Optional configuration: Configuration
      -
      • -
    • -
      Optional basePath: undefined | string
      -
      • -
    • -
      Optional axios: AxiosInstance
      -
      • -
    -

    Returns { addBatchToFile: any; checkFile: any; createFile: any; deleteACHFile: any; deleteFileBatch: any; flattenFile: any; getFileBatch: any; getFileBatches: any; getFileByID: any; getFileContents: any; getFiles: any; ping: any; segmentFile: any; validateFile: any }

    -
      -
    • -
      addBatchToFile: function
      -
        -
      • addBatchToFile(fileID: string, batch: Batch, xRequestID?: undefined | string, xIdempotencyKey?: undefined | string, options?: any): AxiosPromise<void>
        • -
      -
        -
      • - -
        -
        -

        Append a Batch record to the specified file

        -
        -
        -
        summary
        -

        Add Batch to File

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          batch: Batch
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional xIdempotencyKey: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns AxiosPromise<void>

        -
        • -
      -
      • -
    • -
      checkFile: function
      -
        -
      • checkFile(fileID: string, xRequestID?: undefined | string, options?: any): AxiosPromise<Error>
        • -
      -
        -
      • - -
        -
        -

        Validates the existing file. You need only supply the unique File identifier that was returned upon creation.

        -
        -
        -
        summary
        -

        Validate file

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns AxiosPromise<Error>

        -
        • -
      -
      • -
    • -
      createFile: function
      -
        -
      • createFile(createFile: CreateFile, xRequestID?: undefined | string, xIdempotencyKey?: undefined | string, options?: any): AxiosPromise<FileID>
        • -
      -
        -
      • - -
        -
        -

        Create a new File object from either the plaintext or JSON representation.

        -
        -
        -
        summary
        -

        Create File

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          createFile: CreateFile
          -
          -

          Content of the ACH file (in json or raw text)

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional xIdempotencyKey: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns AxiosPromise<FileID>

        -
        • -
      -
      • -
    • -
      deleteACHFile: function
      -
        -
      • deleteACHFile(fileID: string, xRequestID?: undefined | string, options?: any): AxiosPromise<void>
        • -
      -
        -
      • - -
        -
        -

        Permanently deletes a File and associated Batches. It cannot be undone.

        -
        -
        -
        summary
        -

        Delete file

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns AxiosPromise<void>

        -
        • -
      -
      • -
    • -
      deleteFileBatch: function
      -
        -
      • deleteFileBatch(fileID: string, batchID: string, xRequestID?: undefined | string, options?: any): AxiosPromise<void>
        • -
      -
        -
      • - -
        -
        -

        Delete a Batch from a File

        -
        -
        -
        summary
        -

        Delete batch

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          batchID: string
          -
          -

          Batch ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns AxiosPromise<void>

        -
        • -
      -
      • -
    • -
      flattenFile: function
      -
        -
      • flattenFile(fileID: string, xRequestID?: undefined | string, xIdempotencyKey?: undefined | string, options?: any): AxiosPromise<FileID>
        • -
      -
        -
      • - -
        -
        -

        Consolidate batches and entries into the minimum number of batches needed.

        -
        -
        -
        summary
        -

        Flatten batches

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional xIdempotencyKey: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns AxiosPromise<FileID>

        -
        • -
      -
      • -
    • -
      getFileBatch: function
      -
        -
      • getFileBatch(fileID: string, batchID: string, xRequestID?: undefined | string, options?: any): AxiosPromise<Batch>
        • -
      -
        -
      • - -
        -
        -

        Get a specific Batch on a File

        -
        -
        -
        summary
        -

        Get Batch

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          batchID: string
          -
          -

          Batch ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns AxiosPromise<Batch>

        -
        • -
      -
      • -
    • -
      getFileBatches: function
      -
        -
      • getFileBatches(fileID: string, xRequestID?: undefined | string, options?: any): AxiosPromise<Array<Batch>>
        • -
      -
        -
      • - -
        -
        -

        Get the batches on a File.

        -
        -
        -
        summary
        -

        Get batches

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns AxiosPromise<Array<Batch>>

        -
        • -
      -
      • -
    • -
      getFileByID: function
      -
        -
      • getFileByID(fileID: string, xRequestID?: undefined | string, options?: any): AxiosPromise<any>
        • -
      -
        -
      • - -
        -
        -

        Get the details of an existing File using the unique File identifier that was returned upon creation.

        -
        -
        -
        summary
        -

        Retrieve a file

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns AxiosPromise<any>

        -
        • -
      -
      • -
    • -
      getFileContents: function
      -
        -
      • getFileContents(fileID: string, xRequestID?: undefined | string, options?: any): AxiosPromise<string>
        • -
      -
        -
      • - -
        -
        -

        Assembles the existing file (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.

        -
        -
        -
        summary
        -

        Get file contents

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns AxiosPromise<string>

        -
        • -
      -
      • -
    • -
      getFiles: function
      -
        -
      • getFiles(xRequestID?: undefined | string, options?: any): AxiosPromise<Array<any>>
        • -
      -
        -
      • - -
        -
        -

        List all ACH files created with the ACH service. These files are not persisted through multiple runs of the service.

        -
        -
        -
        summary
        -

        Get ACH files

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns AxiosPromise<Array<any>>

        -
        • -
      -
      • -
    • -
      ping: function
      -
        -
      • ping(options?: any): AxiosPromise<void>
        • -
      - -
      • -
    • -
      segmentFile: function
      -
        -
      • segmentFile(fileID: string, xRequestID?: undefined | string, xIdempotencyKey?: undefined | string, options?: any): AxiosPromise<SegmentedFiles>
        • -
      -
        -
      • - -
        -
        -

        Split one file into two. One with only debits and one with only credits.

        -
        -
        -
        summary
        -

        Segment file

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional xIdempotencyKey: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns AxiosPromise<SegmentedFiles>

        -
        • -
      -
      • -
    • -
      validateFile: function
      -
        -
      • validateFile(fileID: string, xRequestID?: undefined | string, validateOpts?: ValidateOpts, options?: any): AxiosPromise<Error>
        • -
      -
        -
      • - -
        -
        -

        Validates the existing file. You need only supply the unique File identifier that was returned upon creation.

        -
        -
        -
        summary
        -

        Validate file

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional validateOpts: ValidateOpts
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns AxiosPromise<Error>

        -
        • -
      -
      • -
    -
    • -
-
-
- -

Const ACHFilesApiFp

-
    -
  • ACHFilesApiFp(configuration?: Configuration): { addBatchToFile: any; checkFile: any; createFile: any; deleteACHFile: any; deleteFileBatch: any; flattenFile: any; getFileBatch: any; getFileBatches: any; getFileByID: any; getFileContents: any; getFiles: any; ping: any; segmentFile: any; validateFile: any }
    • -
-
    -
  • - -
    -
    -

    ACHFilesApi - functional programming interface

    -
    -
    -
    export
    -
    -
    -
    -

    Parameters

    - -

    Returns { addBatchToFile: any; checkFile: any; createFile: any; deleteACHFile: any; deleteFileBatch: any; flattenFile: any; getFileBatch: any; getFileBatches: any; getFileByID: any; getFileContents: any; getFiles: any; ping: any; segmentFile: any; validateFile: any }

    -
      -
    • -
      addBatchToFile: function
      -
        -
      • addBatchToFile(fileID: string, batch: Batch, xRequestID?: undefined | string, xIdempotencyKey?: undefined | string, options?: any): Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<void>>
        • -
      -
        -
      • - -
        -
        -

        Append a Batch record to the specified file

        -
        -
        -
        summary
        -

        Add Batch to File

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          batch: Batch
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional xIdempotencyKey: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<void>>

        -
        • -
      -
      • -
    • -
      checkFile: function
      -
        -
      • checkFile(fileID: string, xRequestID?: undefined | string, options?: any): Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<Error>>
        • -
      -
        -
      • - -
        -
        -

        Validates the existing file. You need only supply the unique File identifier that was returned upon creation.

        -
        -
        -
        summary
        -

        Validate file

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<Error>>

        -
        • -
      -
      • -
    • -
      createFile: function
      -
        -
      • createFile(createFile: CreateFile, xRequestID?: undefined | string, xIdempotencyKey?: undefined | string, options?: any): Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<FileID>>
        • -
      -
        -
      • - -
        -
        -

        Create a new File object from either the plaintext or JSON representation.

        -
        -
        -
        summary
        -

        Create File

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          createFile: CreateFile
          -
          -

          Content of the ACH file (in json or raw text)

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional xIdempotencyKey: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<FileID>>

        -
        • -
      -
      • -
    • -
      deleteACHFile: function
      -
        -
      • deleteACHFile(fileID: string, xRequestID?: undefined | string, options?: any): Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<void>>
        • -
      -
        -
      • - -
        -
        -

        Permanently deletes a File and associated Batches. It cannot be undone.

        -
        -
        -
        summary
        -

        Delete file

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<void>>

        -
        • -
      -
      • -
    • -
      deleteFileBatch: function
      -
        -
      • deleteFileBatch(fileID: string, batchID: string, xRequestID?: undefined | string, options?: any): Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<void>>
        • -
      -
        -
      • - -
        -
        -

        Delete a Batch from a File

        -
        -
        -
        summary
        -

        Delete batch

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          batchID: string
          -
          -

          Batch ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<void>>

        -
        • -
      -
      • -
    • -
      flattenFile: function
      -
        -
      • flattenFile(fileID: string, xRequestID?: undefined | string, xIdempotencyKey?: undefined | string, options?: any): Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<FileID>>
        • -
      -
        -
      • - -
        -
        -

        Consolidate batches and entries into the minimum number of batches needed.

        -
        -
        -
        summary
        -

        Flatten batches

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional xIdempotencyKey: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<FileID>>

        -
        • -
      -
      • -
    • -
      getFileBatch: function
      -
        -
      • getFileBatch(fileID: string, batchID: string, xRequestID?: undefined | string, options?: any): Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<Batch>>
        • -
      -
        -
      • - -
        -
        -

        Get a specific Batch on a File

        -
        -
        -
        summary
        -

        Get Batch

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          batchID: string
          -
          -

          Batch ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<Batch>>

        -
        • -
      -
      • -
    • -
      getFileBatches: function
      -
        -
      • getFileBatches(fileID: string, xRequestID?: undefined | string, options?: any): Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<Array<Batch>>>
        • -
      -
        -
      • - -
        -
        -

        Get the batches on a File.

        -
        -
        -
        summary
        -

        Get batches

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<Array<Batch>>>

        -
        • -
      -
      • -
    • -
      getFileByID: function
      -
        -
      • getFileByID(fileID: string, xRequestID?: undefined | string, options?: any): Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<any>>
        • -
      -
        -
      • - -
        -
        -

        Get the details of an existing File using the unique File identifier that was returned upon creation.

        -
        -
        -
        summary
        -

        Retrieve a file

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<any>>

        -
        • -
      -
      • -
    • -
      getFileContents: function
      -
        -
      • getFileContents(fileID: string, xRequestID?: undefined | string, options?: any): Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<string>>
        • -
      -
        -
      • - -
        -
        -

        Assembles the existing file (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.

        -
        -
        -
        summary
        -

        Get file contents

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<string>>

        -
        • -
      -
      • -
    • -
      getFiles: function
      -
        -
      • getFiles(xRequestID?: undefined | string, options?: any): Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<Array<any>>>
        • -
      -
        -
      • - -
        -
        -

        List all ACH files created with the ACH service. These files are not persisted through multiple runs of the service.

        -
        -
        -
        summary
        -

        Get ACH files

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<Array<any>>>

        -
        • -
      -
      • -
    • -
      ping: function
      -
        -
      • ping(options?: any): Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<void>>
        • -
      -
        -
      • - -
        -
        -

        Check the ACH service to check if running

        -
        -
        -
        summary
        -

        Ping ACH service

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          Optional options: any
          -
          • -
        -

        Returns Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<void>>

        -
        • -
      -
      • -
    • -
      segmentFile: function
      -
        -
      • segmentFile(fileID: string, xRequestID?: undefined | string, xIdempotencyKey?: undefined | string, options?: any): Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<SegmentedFiles>>
        • -
      -
        -
      • - -
        -
        -

        Split one file into two. One with only debits and one with only credits.

        -
        -
        -
        summary
        -

        Segment file

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional xIdempotencyKey: undefined | string
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<SegmentedFiles>>

        -
        • -
      -
      • -
    • -
      validateFile: function
      -
        -
      • validateFile(fileID: string, xRequestID?: undefined | string, validateOpts?: ValidateOpts, options?: any): Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<Error>>
        • -
      -
        -
      • - -
        -
        -

        Validates the existing file. You need only supply the unique File identifier that was returned upon creation.

        -
        -
        -
        summary
        -

        Validate file

        -
        -
        throws
        -

        {RequiredError}

        -
        -
        -
        -

        Parameters

        -
          -
        • -
          fileID: string
          -
          -

          File ID

          -
          -
          • -
        • -
          Optional xRequestID: undefined | string
          -
          • -
        • -
          Optional validateOpts: ValidateOpts
          -
          • -
        • -
          Optional options: any
          -
          • -
        -

        Returns Promise<(axios?: AxiosInstance, basePath?: undefined | string) => AxiosPromise<Error>>

        -
        • -
      -
      • -
    -
    • -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/modules/_base_.html b/docs/modules/_base_.html deleted file mode 100644 index 930eb29..0000000 --- a/docs/modules/_base_.html +++ /dev/null @@ -1,243 +0,0 @@ - - - - - - "base" | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Module "base"

-
-
-
-
-
-
-
-

Index

-
-
-
-

Classes

- -
-
-

Interfaces

- -
-
-

Variables

- -
-
-

Object literals

- -
-
-
-
-
-

Variables

-
- -

Const BASE_PATH

-
BASE_PATH: string = "http://localhost:8080".replace(/\/+$/, "")
- -
-
-
-

Object literals

-
- -

Const COLLECTION_FORMATS

-
COLLECTION_FORMATS: object
- -
-
-
export
-
-
-
-
- -

csv

-
csv: string = ","
- -
-
- -

pipes

-
pipes: string = "|"
- -
-
- -

ssv

-
ssv: string = " "
- -
-
- -

tsv

-
tsv: string = " "
- -
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/modules/_configuration_.html b/docs/modules/_configuration_.html deleted file mode 100644 index 29daba1..0000000 --- a/docs/modules/_configuration_.html +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - "configuration" | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Module "configuration"

-
-
-
-
-
-
-
-

Index

-
-
-
-

Classes

- -
-
-

Interfaces

- -
-
-
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/modules/_index_.html b/docs/modules/_index_.html deleted file mode 100644 index 3c636d3..0000000 --- a/docs/modules/_index_.html +++ /dev/null @@ -1,481 +0,0 @@ - - - - - - "index" | ach-node-sdk - - - - - -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - - - -
-
- Menu -
-
-
-
-
-
- -

Module "index"

-
-
-
-
-
-
-
-

Index

-
-
-
-

References

- -
-
-
-
-
-

References

-
- -

ACHFilesApi

- Re-exports ACHFilesApi -
-
- -

ACHFilesApiAxiosParamCreator

- Re-exports ACHFilesApiAxiosParamCreator -
-
- -

ACHFilesApiFactory

- Re-exports ACHFilesApiFactory -
-
- -

ACHFilesApiFp

- Re-exports ACHFilesApiFp -
-
- -

ADVBatchControl

- Re-exports ADVBatchControl -
-
- -

ADVEntryDetail

- Re-exports ADVEntryDetail -
-
- -

Addenda02

- Re-exports Addenda02 -
-
- -

Addenda05

- Re-exports Addenda05 -
-
- -

Addenda10

- Re-exports Addenda10 -
-
- -

Addenda11

- Re-exports Addenda11 -
-
- -

Addenda12

- Re-exports Addenda12 -
-
- -

Addenda13

- Re-exports Addenda13 -
-
- -

Addenda14

- Re-exports Addenda14 -
-
- -

Addenda15

- Re-exports Addenda15 -
-
- -

Addenda16

- Re-exports Addenda16 -
-
- -

Addenda17

- Re-exports Addenda17 -
-
- -

Addenda18

- Re-exports Addenda18 -
-
- -

Addenda98

- Re-exports Addenda98 -
-
- -

Addenda99

- Re-exports Addenda99 -
-
- -

Batch

- Re-exports Batch -
-
- -

BatchControl

- Re-exports BatchControl -
-
- -

BatchHeader

- Re-exports BatchHeader -
-
- -

Configuration

- Re-exports Configuration -
-
- -

ConfigurationParameters

- Re-exports ConfigurationParameters -
-
- -

CreateFile

- Re-exports CreateFile -
-
- -

EntryDetail

- Re-exports EntryDetail -
-
- -

FileControl

- Re-exports FileControl -
-
- -

FileHeader

- Re-exports FileHeader -
-
- -

FileID

- Re-exports FileID -
-
- -

IATBatch

- Re-exports IATBatch -
-
- -

IATBatchHeader

- Re-exports IATBatchHeader -
-
- -

IATEntryDetail

- Re-exports IATEntryDetail -
-
- -

ModelError

- Re-exports ModelError -
-
- -

ModelFile

- Re-exports ModelFile -
-
- -

Offset

- Re-exports Offset -
-
- -

OffsetAccountTypeEnum

- Re-exports OffsetAccountTypeEnum -
-
- -

SegmentedFiles

- Re-exports SegmentedFiles -
-
- -

ValidateOpts

- Re-exports ValidateOpts -
-
-
-
- - -
-
-
-
-
-

Legend

-
-
    -
  • Object literal
    • -
  • Variable
    • -
  • Function
    • -
-
    -
  • Enumeration
    • -
-
    -
  • Interface
    • -
-
    -
  • Class
    • -
-
-
-
-
-

Generated using TypeDoc

-
-
- - - \ No newline at end of file diff --git a/docs/modules/api.html b/docs/modules/api.html new file mode 100644 index 0000000..54476a9 --- /dev/null +++ b/docs/modules/api.html @@ -0,0 +1,277 @@ +api | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module api

Index

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

OffsetAccountTypeEnum

OffsetAccountTypeEnum: typeof OffsetAccountTypeEnum[keyof typeof OffsetAccountTypeEnum]

Variables

Const OffsetAccountTypeEnum

OffsetAccountTypeEnum: { Checking: "checking"; Savings: "savings" } = ...

Type declaration

  • Checking: "checking"
  • Savings: "savings"

Functions

ACHFilesApiAxiosParamCreator

  • ACHFilesApiAxiosParamCreator(configuration?: Configuration): { addBatchToFile: ((fileID: string, batch: Batch, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); buildFile: ((fileID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); checkFile: ((fileID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); createFile: ((body: string, xRequestID?: string, xIdempotencyKey?: string, requireABAOrigin?: boolean, bypassOrigin?: boolean, bypassDestination?: boolean, customTraceNumbers?: boolean, allowZeroBatches?: boolean, allowMissingFileHeader?: boolean, allowMissingFileControl?: boolean, bypassCompanyIdentificationMatch?: boolean, customReturnCodes?: boolean, unequalServiceClassCode?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>); deleteACHFile: ((fileID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); deleteFileBatch: ((fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); flattenFile: ((fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); getFileBatch: ((fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); getFileBatches: ((fileID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); getFileByID: ((fileID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); getFileContents: ((fileID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); getFiles: ((xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); ping: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); segmentFile: ((fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); validateFile: ((fileID: string, xRequestID?: string, validateOpts?: ValidateOpts, options?: AxiosRequestConfig) => Promise<RequestArgs>) }
  • +

    ACHFilesApi - axios parameter creator

    +
    export

    Parameters

    Returns { addBatchToFile: ((fileID: string, batch: Batch, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); buildFile: ((fileID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); checkFile: ((fileID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); createFile: ((body: string, xRequestID?: string, xIdempotencyKey?: string, requireABAOrigin?: boolean, bypassOrigin?: boolean, bypassDestination?: boolean, customTraceNumbers?: boolean, allowZeroBatches?: boolean, allowMissingFileHeader?: boolean, allowMissingFileControl?: boolean, bypassCompanyIdentificationMatch?: boolean, customReturnCodes?: boolean, unequalServiceClassCode?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>); deleteACHFile: ((fileID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); deleteFileBatch: ((fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); flattenFile: ((fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); getFileBatch: ((fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); getFileBatches: ((fileID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); getFileByID: ((fileID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); getFileContents: ((fileID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); getFiles: ((xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); ping: ((options?: AxiosRequestConfig) => Promise<RequestArgs>); segmentFile: ((fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>); validateFile: ((fileID: string, xRequestID?: string, validateOpts?: ValidateOpts, options?: AxiosRequestConfig) => Promise<RequestArgs>) }

    • addBatchToFile: ((fileID: string, batch: Batch, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (fileID: string, batch: Batch, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • +

          Append a Batch record to the specified File.

          +
          summary

          Append Batch to File

          +
          throws

          {RequiredError}

          +

          Parameters

          • fileID: string
            +

            File ID

            +
          • batch: Batch
          • Optional xRequestID: string
          • Optional xIdempotencyKey: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • buildFile: ((fileID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • +

          Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file.

          +
          summary

          Build File

          +
          throws

          {RequiredError}

          +

          Parameters

          • fileID: string
            +

            File ID

            +
          • Optional xRequestID: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • checkFile: ((fileID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • +

          Validates the existing File. You need only supply the unique File identifier that was returned upon creation.

          +
          summary

          Validate File

          +
          throws

          {RequiredError}

          +

          Parameters

          • fileID: string
            +

            File ID

            +
          • Optional xRequestID: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • createFile: ((body: string, xRequestID?: string, xIdempotencyKey?: string, requireABAOrigin?: boolean, bypassOrigin?: boolean, bypassDestination?: boolean, customTraceNumbers?: boolean, allowZeroBatches?: boolean, allowMissingFileHeader?: boolean, allowMissingFileControl?: boolean, bypassCompanyIdentificationMatch?: boolean, customReturnCodes?: boolean, unequalServiceClassCode?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (body: string, xRequestID?: string, xIdempotencyKey?: string, requireABAOrigin?: boolean, bypassOrigin?: boolean, bypassDestination?: boolean, customTraceNumbers?: boolean, allowZeroBatches?: boolean, allowMissingFileHeader?: boolean, allowMissingFileControl?: boolean, bypassCompanyIdentificationMatch?: boolean, customReturnCodes?: boolean, unequalServiceClassCode?: boolean, options?: AxiosRequestConfig): Promise<RequestArgs>
        • +

          Create a new File object from either the plaintext or JSON representation.

          +
          summary

          Create File

          +
          throws

          {RequiredError}

          +

          Parameters

          • body: string
            +

            Content of the ACH file (in json or raw text)

            +
          • Optional xRequestID: string
          • Optional xIdempotencyKey: string
          • Optional requireABAOrigin: boolean
          • Optional bypassOrigin: boolean
          • Optional bypassDestination: boolean
          • Optional customTraceNumbers: boolean
          • Optional allowZeroBatches: boolean
          • Optional allowMissingFileHeader: boolean
          • Optional allowMissingFileControl: boolean
          • Optional bypassCompanyIdentificationMatch: boolean
          • Optional customReturnCodes: boolean
          • Optional unequalServiceClassCode: boolean
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • deleteACHFile: ((fileID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • +

          Permanently deletes a File and associated Batches. It cannot be undone.

          +
          summary

          Delete File

          +
          throws

          {RequiredError}

          +

          Parameters

          • fileID: string
            +

            File ID

            +
          • Optional xRequestID: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • deleteFileBatch: ((fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • +

          Delete a Batch from a File.

          +
          summary

          Delete Batch

          +
          throws

          {RequiredError}

          +

          Parameters

          • fileID: string
            +

            File ID

            +
          • batchID: string
            +

            Batch ID

            +
          • Optional xRequestID: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • flattenFile: ((fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • +

          Consolidate Batches and Entries into the minimum number of Batches needed.

          +
          summary

          Flatten Batches

          +
          throws

          {RequiredError}

          +

          Parameters

          • fileID: string
            +

            File ID

            +
          • Optional xRequestID: string
          • Optional xIdempotencyKey: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • getFileBatch: ((fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • +

          Get a specific Batch on a File.

          +
          summary

          Get Batch

          +
          throws

          {RequiredError}

          +

          Parameters

          • fileID: string
            +

            File ID

            +
          • batchID: string
            +

            Batch ID

            +
          • Optional xRequestID: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • getFileBatches: ((fileID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • +

          Get the Batches on a File.

          +
          summary

          Get Batches

          +
          throws

          {RequiredError}

          +

          Parameters

          • fileID: string
            +

            File ID

            +
          • Optional xRequestID: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • getFileByID: ((fileID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • +

          Get the details of an existing File using the unique File identifier that was returned upon creation.

          +
          summary

          Retrieve File

          +
          throws

          {RequiredError}

          +

          Parameters

          • fileID: string
            +

            File ID

            +
          • Optional xRequestID: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • getFileContents: ((fileID: string, xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • +

          Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.

          +
          summary

          Get File Contents

          +
          throws

          {RequiredError}

          +

          Parameters

          • fileID: string
            +

            File ID

            +
          • Optional xRequestID: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • getFiles: ((xRequestID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (xRequestID?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • +

          List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service.

          +
          summary

          List Files

          +
          throws

          {RequiredError}

          +

          Parameters

          • Optional xRequestID: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • ping: ((options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • +

          Check if the ACH service is running.

          +
          summary

          Ping ACH service

          +
          throws

          {RequiredError}

          +

          Parameters

          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • segmentFile: ((fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<RequestArgs>
        • +

          Split one File into two. One with only debits and one with only credits.

          +
          summary

          Segment File

          +
          throws

          {RequiredError}

          +

          Parameters

          • fileID: string
            +

            File ID

            +
          • Optional xRequestID: string
          • Optional xIdempotencyKey: string
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

    • validateFile: ((fileID: string, xRequestID?: string, validateOpts?: ValidateOpts, options?: AxiosRequestConfig) => Promise<RequestArgs>)
        • (fileID: string, xRequestID?: string, validateOpts?: ValidateOpts, options?: AxiosRequestConfig): Promise<RequestArgs>
        • +

          Validates the existing File. You need only supply the unique File identifier that was returned upon creation.

          +
          summary

          Validate File (Custom)

          +
          throws

          {RequiredError}

          +

          Parameters

          • fileID: string
            +

            File ID

            +
          • Optional xRequestID: string
          • Optional validateOpts: ValidateOpts
          • options: AxiosRequestConfig = {}

          Returns Promise<RequestArgs>

ACHFilesApiFactory

  • ACHFilesApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { addBatchToFile: any; buildFile: any; checkFile: any; createFile: any; deleteACHFile: any; deleteFileBatch: any; flattenFile: any; getFileBatch: any; getFileBatches: any; getFileByID: any; getFileContents: any; getFiles: any; ping: any; segmentFile: any; validateFile: any }
  • +

    ACHFilesApi - factory interface

    +
    export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns { addBatchToFile: any; buildFile: any; checkFile: any; createFile: any; deleteACHFile: any; deleteFileBatch: any; flattenFile: any; getFileBatch: any; getFileBatches: any; getFileByID: any; getFileContents: any; getFiles: any; ping: any; segmentFile: any; validateFile: any }

    • addBatchToFile:function
      • addBatchToFile(fileID: string, batch: Batch, xRequestID?: string, xIdempotencyKey?: string, options?: any): AxiosPromise<void>
      • +

        Append a Batch record to the specified File.

        +
        summary

        Append Batch to File

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • batch: Batch
        • Optional xRequestID: string
        • Optional xIdempotencyKey: string
        • Optional options: any

        Returns AxiosPromise<void>

    • buildFile:function
      • buildFile(fileID: string, xRequestID?: string, options?: any): AxiosPromise<any>
      • +

        Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file.

        +
        summary

        Build File

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • Optional xRequestID: string
        • Optional options: any

        Returns AxiosPromise<any>

    • checkFile:function
      • checkFile(fileID: string, xRequestID?: string, options?: any): AxiosPromise<Error>
      • +

        Validates the existing File. You need only supply the unique File identifier that was returned upon creation.

        +
        summary

        Validate File

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • Optional xRequestID: string
        • Optional options: any

        Returns AxiosPromise<Error>

    • createFile:function
      • createFile(body: string, xRequestID?: string, xIdempotencyKey?: string, requireABAOrigin?: boolean, bypassOrigin?: boolean, bypassDestination?: boolean, customTraceNumbers?: boolean, allowZeroBatches?: boolean, allowMissingFileHeader?: boolean, allowMissingFileControl?: boolean, bypassCompanyIdentificationMatch?: boolean, customReturnCodes?: boolean, unequalServiceClassCode?: boolean, options?: any): AxiosPromise<FileID>
      • +

        Create a new File object from either the plaintext or JSON representation.

        +
        summary

        Create File

        +
        throws

        {RequiredError}

        +

        Parameters

        • body: string
          +

          Content of the ACH file (in json or raw text)

          +
        • Optional xRequestID: string
        • Optional xIdempotencyKey: string
        • Optional requireABAOrigin: boolean
        • Optional bypassOrigin: boolean
        • Optional bypassDestination: boolean
        • Optional customTraceNumbers: boolean
        • Optional allowZeroBatches: boolean
        • Optional allowMissingFileHeader: boolean
        • Optional allowMissingFileControl: boolean
        • Optional bypassCompanyIdentificationMatch: boolean
        • Optional customReturnCodes: boolean
        • Optional unequalServiceClassCode: boolean
        • Optional options: any

        Returns AxiosPromise<FileID>

    • deleteACHFile:function
      • deleteACHFile(fileID: string, xRequestID?: string, options?: any): AxiosPromise<void>
      • +

        Permanently deletes a File and associated Batches. It cannot be undone.

        +
        summary

        Delete File

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • Optional xRequestID: string
        • Optional options: any

        Returns AxiosPromise<void>

    • deleteFileBatch:function
      • deleteFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: any): AxiosPromise<void>
      • +

        Delete a Batch from a File.

        +
        summary

        Delete Batch

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • batchID: string
          +

          Batch ID

          +
        • Optional xRequestID: string
        • Optional options: any

        Returns AxiosPromise<void>

    • flattenFile:function
      • flattenFile(fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: any): AxiosPromise<FileID>
      • +

        Consolidate Batches and Entries into the minimum number of Batches needed.

        +
        summary

        Flatten Batches

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • Optional xRequestID: string
        • Optional xIdempotencyKey: string
        • Optional options: any

        Returns AxiosPromise<FileID>

    • getFileBatch:function
      • getFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: any): AxiosPromise<Batch>
      • +

        Get a specific Batch on a File.

        +
        summary

        Get Batch

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • batchID: string
          +

          Batch ID

          +
        • Optional xRequestID: string
        • Optional options: any

        Returns AxiosPromise<Batch>

    • getFileBatches:function
      • getFileBatches(fileID: string, xRequestID?: string, options?: any): AxiosPromise<Batch[]>
      • +

        Get the Batches on a File.

        +
        summary

        Get Batches

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • Optional xRequestID: string
        • Optional options: any

        Returns AxiosPromise<Batch[]>

    • getFileByID:function
      • getFileByID(fileID: string, xRequestID?: string, options?: any): AxiosPromise<any>
      • +

        Get the details of an existing File using the unique File identifier that was returned upon creation.

        +
        summary

        Retrieve File

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • Optional xRequestID: string
        • Optional options: any

        Returns AxiosPromise<any>

    • getFileContents:function
      • getFileContents(fileID: string, xRequestID?: string, options?: any): AxiosPromise<string>
      • +

        Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.

        +
        summary

        Get File Contents

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • Optional xRequestID: string
        • Optional options: any

        Returns AxiosPromise<string>

    • getFiles:function
      • getFiles(xRequestID?: string, options?: any): AxiosPromise<any[]>
      • +

        List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service.

        +
        summary

        List Files

        +
        throws

        {RequiredError}

        +

        Parameters

        • Optional xRequestID: string
        • Optional options: any

        Returns AxiosPromise<any[]>

    • ping:function
      • ping(options?: any): AxiosPromise<void>
      • +

        Check if the ACH service is running.

        +
        summary

        Ping ACH service

        +
        throws

        {RequiredError}

        +

        Parameters

        • Optional options: any

        Returns AxiosPromise<void>

    • segmentFile:function
      • segmentFile(fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: any): AxiosPromise<SegmentedFiles>
      • +

        Split one File into two. One with only debits and one with only credits.

        +
        summary

        Segment File

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • Optional xRequestID: string
        • Optional xIdempotencyKey: string
        • Optional options: any

        Returns AxiosPromise<SegmentedFiles>

    • validateFile:function
      • validateFile(fileID: string, xRequestID?: string, validateOpts?: ValidateOpts, options?: any): AxiosPromise<Error>
      • +

        Validates the existing File. You need only supply the unique File identifier that was returned upon creation.

        +
        summary

        Validate File (Custom)

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • Optional xRequestID: string
        • Optional validateOpts: ValidateOpts
        • Optional options: any

        Returns AxiosPromise<Error>

ACHFilesApiFp

  • ACHFilesApiFp(configuration?: Configuration): { addBatchToFile: any; buildFile: any; checkFile: any; createFile: any; deleteACHFile: any; deleteFileBatch: any; flattenFile: any; getFileBatch: any; getFileBatches: any; getFileByID: any; getFileContents: any; getFiles: any; ping: any; segmentFile: any; validateFile: any }
  • +

    ACHFilesApi - functional programming interface

    +
    export

    Parameters

    Returns { addBatchToFile: any; buildFile: any; checkFile: any; createFile: any; deleteACHFile: any; deleteFileBatch: any; flattenFile: any; getFileBatch: any; getFileBatches: any; getFileByID: any; getFileContents: any; getFiles: any; ping: any; segmentFile: any; validateFile: any }

    • addBatchToFile:function
      • addBatchToFile(fileID: string, batch: Batch, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • +

        Append a Batch record to the specified File.

        +
        summary

        Append Batch to File

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • batch: Batch
        • Optional xRequestID: string
        • Optional xIdempotencyKey: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • buildFile:function
      • buildFile(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>)>
      • +

        Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns JSON formatted file.

        +
        summary

        Build File

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • Optional xRequestID: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>)>

    • checkFile:function
      • checkFile(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Error>)>
      • +

        Validates the existing File. You need only supply the unique File identifier that was returned upon creation.

        +
        summary

        Validate File

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • Optional xRequestID: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Error>)>

    • createFile:function
      • createFile(body: string, xRequestID?: string, xIdempotencyKey?: string, requireABAOrigin?: boolean, bypassOrigin?: boolean, bypassDestination?: boolean, customTraceNumbers?: boolean, allowZeroBatches?: boolean, allowMissingFileHeader?: boolean, allowMissingFileControl?: boolean, bypassCompanyIdentificationMatch?: boolean, customReturnCodes?: boolean, unequalServiceClassCode?: boolean, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileID>)>
      • +

        Create a new File object from either the plaintext or JSON representation.

        +
        summary

        Create File

        +
        throws

        {RequiredError}

        +

        Parameters

        • body: string
          +

          Content of the ACH file (in json or raw text)

          +
        • Optional xRequestID: string
        • Optional xIdempotencyKey: string
        • Optional requireABAOrigin: boolean
        • Optional bypassOrigin: boolean
        • Optional bypassDestination: boolean
        • Optional customTraceNumbers: boolean
        • Optional allowZeroBatches: boolean
        • Optional allowMissingFileHeader: boolean
        • Optional allowMissingFileControl: boolean
        • Optional bypassCompanyIdentificationMatch: boolean
        • Optional customReturnCodes: boolean
        • Optional unequalServiceClassCode: boolean
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileID>)>

    • deleteACHFile:function
      • deleteACHFile(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • +

        Permanently deletes a File and associated Batches. It cannot be undone.

        +
        summary

        Delete File

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • Optional xRequestID: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • deleteFileBatch:function
      • deleteFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • +

        Delete a Batch from a File.

        +
        summary

        Delete Batch

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • batchID: string
          +

          Batch ID

          +
        • Optional xRequestID: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • flattenFile:function
      • flattenFile(fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileID>)>
      • +

        Consolidate Batches and Entries into the minimum number of Batches needed.

        +
        summary

        Flatten Batches

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • Optional xRequestID: string
        • Optional xIdempotencyKey: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileID>)>

    • getFileBatch:function
      • getFileBatch(fileID: string, batchID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Batch>)>
      • +

        Get a specific Batch on a File.

        +
        summary

        Get Batch

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • batchID: string
          +

          Batch ID

          +
        • Optional xRequestID: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Batch>)>

    • getFileBatches:function
      • getFileBatches(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Batch[]>)>
      • +

        Get the Batches on a File.

        +
        summary

        Get Batches

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • Optional xRequestID: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Batch[]>)>

    • getFileByID:function
      • getFileByID(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>)>
      • +

        Get the details of an existing File using the unique File identifier that was returned upon creation.

        +
        summary

        Retrieve File

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • Optional xRequestID: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>)>

    • getFileContents:function
      • getFileContents(fileID: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>
      • +

        Assembles the existing File (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.

        +
        summary

        Get File Contents

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • Optional xRequestID: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>

    • getFiles:function
      • getFiles(xRequestID?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<any[]>)>
      • +

        List all ACH Files created with the ACH service. These Files are not persisted through multiple runs of the service.

        +
        summary

        List Files

        +
        throws

        {RequiredError}

        +

        Parameters

        • Optional xRequestID: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<any[]>)>

    • ping:function
      • ping(options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>
      • +

        Check if the ACH service is running.

        +
        summary

        Ping ACH service

        +
        throws

        {RequiredError}

        +

        Parameters

        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    • segmentFile:function
      • segmentFile(fileID: string, xRequestID?: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SegmentedFiles>)>
      • +

        Split one File into two. One with only debits and one with only credits.

        +
        summary

        Segment File

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • Optional xRequestID: string
        • Optional xIdempotencyKey: string
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<SegmentedFiles>)>

    • validateFile:function
      • validateFile(fileID: string, xRequestID?: string, validateOpts?: ValidateOpts, options?: AxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Error>)>
      • +

        Validates the existing File. You need only supply the unique File identifier that was returned upon creation.

        +
        summary

        Validate File (Custom)

        +
        throws

        {RequiredError}

        +

        Parameters

        • fileID: string
          +

          File ID

          +
        • Optional xRequestID: string
        • Optional validateOpts: ValidateOpts
        • Optional options: AxiosRequestConfig

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Error>)>

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/base.html b/docs/modules/base.html new file mode 100644 index 0000000..06ee5bf --- /dev/null +++ b/docs/modules/base.html @@ -0,0 +1 @@ +base | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module base

Index

Classes

Interfaces

Variables

Variables

Const BASE_PATH

BASE_PATH: string = ...

Const COLLECTION_FORMATS

COLLECTION_FORMATS: { csv: string; pipes: string; ssv: string; tsv: string } = ...
export

Type declaration

  • csv: string
  • pipes: string
  • ssv: string
  • tsv: string

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/common.html b/docs/modules/common.html new file mode 100644 index 0000000..4298a8c --- /dev/null +++ b/docs/modules/common.html @@ -0,0 +1,2 @@ +common | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module common

Index

Variables

Functions

Variables

Const DUMMY_BASE_URL

DUMMY_BASE_URL: "https://example.com" = 'https://example.com'
export

Functions

assertParamExists

  • assertParamExists(functionName: string, paramName: string, paramValue: unknown): void
  • throws

    {RequiredError}

    +
    export

    Parameters

    • functionName: string
    • paramName: string
    • paramValue: unknown

    Returns void

createRequestFunction

  • createRequestFunction(axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration): (<T, R>(axios?: AxiosInstance, basePath?: string) => Promise<R>)
  • export

    Parameters

    Returns (<T, R>(axios?: AxiosInstance, basePath?: string) => Promise<R>)

      • <T, R>(axios?: AxiosInstance, basePath?: string): Promise<R>

      • Type Parameters

        • T = unknown

        • R = AxiosResponse<T>

        Parameters

        • axios: AxiosInstance = globalAxios
        • basePath: string = BASE_PATH

        Returns Promise<R>

serializeDataIfNeeded

  • serializeDataIfNeeded(value: any, requestOptions: any, configuration?: Configuration): any
  • export

    Parameters

    • value: any
    • requestOptions: any
    • Optional configuration: Configuration

    Returns any

setApiKeyToObject

  • setApiKeyToObject(object: any, keyParamName: string, configuration?: Configuration): Promise<void>
  • export

    Parameters

    • object: any
    • keyParamName: string
    • Optional configuration: Configuration

    Returns Promise<void>

setBasicAuthToObject

  • setBasicAuthToObject(object: any, configuration?: Configuration): void
  • export

    Parameters

    Returns void

setBearerAuthToObject

  • setBearerAuthToObject(object: any, configuration?: Configuration): Promise<void>
  • export

    Parameters

    Returns Promise<void>

setOAuthToObject

  • setOAuthToObject(object: any, name: string, scopes: string[], configuration?: Configuration): Promise<void>
  • export

    Parameters

    • object: any
    • name: string
    • scopes: string[]
    • Optional configuration: Configuration

    Returns Promise<void>

setSearchParams

  • setSearchParams(url: URL, ...objects: any[]): void
  • export

    Parameters

    • url: URL
    • Rest ...objects: any[]

    Returns void

toPathString

  • toPathString(url: URL): string
  • export

    Parameters

    • url: URL

    Returns string

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/configuration.html b/docs/modules/configuration.html new file mode 100644 index 0000000..c2b85fc --- /dev/null +++ b/docs/modules/configuration.html @@ -0,0 +1 @@ +configuration | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module configuration

Index

Classes

Interfaces

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html new file mode 100644 index 0000000..717ebd4 --- /dev/null +++ b/docs/modules/index.html @@ -0,0 +1 @@ +index | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module index

Index

References

References

ACHFilesApi

Re-exports ACHFilesApi

ACHFilesApiAxiosParamCreator

Re-exports ACHFilesApiAxiosParamCreator

ACHFilesApiFactory

Re-exports ACHFilesApiFactory

ACHFilesApiFp

Re-exports ACHFilesApiFp

ADVBatchControl

Re-exports ADVBatchControl

ADVEntryDetail

Re-exports ADVEntryDetail

ADVFileControl

Re-exports ADVFileControl

Addenda02

Re-exports Addenda02

Addenda05

Re-exports Addenda05

Addenda10

Re-exports Addenda10

Addenda11

Re-exports Addenda11

Addenda12

Re-exports Addenda12

Addenda13

Re-exports Addenda13

Addenda14

Re-exports Addenda14

Addenda15

Re-exports Addenda15

Addenda16

Re-exports Addenda16

Addenda17

Re-exports Addenda17

Addenda18

Re-exports Addenda18

Addenda98

Re-exports Addenda98

Addenda99

Re-exports Addenda99

Addenda99Contested

Re-exports Addenda99Contested

Addenda99Dishonored

Re-exports Addenda99Dishonored

Batch

Re-exports Batch

BatchControl

Re-exports BatchControl

BatchHeader

Re-exports BatchHeader

Configuration

Re-exports Configuration

ConfigurationParameters

Re-exports ConfigurationParameters

CreateFile

Re-exports CreateFile

EntryDetail

Re-exports EntryDetail

FileControl

Re-exports FileControl

FileHeader

Re-exports FileHeader

FileID

Re-exports FileID

IATBatch

Re-exports IATBatch

IATBatchHeader

Re-exports IATBatchHeader

IATEntryDetail

Re-exports IATEntryDetail

ModelError

Re-exports ModelError

ModelFile

Re-exports ModelFile

Offset

Re-exports Offset

OffsetAccountTypeEnum

Re-exports OffsetAccountTypeEnum

SegmentedFiles

Re-exports SegmentedFiles

ValidateOpts

Re-exports ValidateOpts

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/url.html b/docs/modules/url.html new file mode 100644 index 0000000..56bca9e --- /dev/null +++ b/docs/modules/url.html @@ -0,0 +1 @@ +url | ach-node-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module url

Index

Interfaces

Functions

Functions

format

  • format(urlObj: object): string

  • Parameters

    • urlObj: object

    Returns string

parse

  • parse(urlStr: string, parseQueryString?: boolean, slashesDenoteHost?: boolean): Url

  • Parameters

    • urlStr: string
    • Optional parseQueryString: boolean
    • Optional slashesDenoteHost: boolean

    Returns Url

Legend

  • Variable
  • Function
  • Type alias
  • Interface
  • Class

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/git_push.sh b/git_push.sh index ced3be2..f53a75d 100644 --- a/git_push.sh +++ b/git_push.sh @@ -1,7 +1,7 @@ #!/bin/sh # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ # -# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com" +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" git_user_id=$1 git_repo_id=$2 @@ -38,14 +38,14 @@ git add . git commit -m "$release_note" # Sets the new remote -git_remote=`git remote` +git_remote=$(git remote) if [ "$git_remote" = "" ]; then # git remote not defined if [ "$GIT_TOKEN" = "" ]; then echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git else - git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git fi fi @@ -55,4 +55,3 @@ git pull origin master # Pushes (Forces) the changes in the local repository up to the remote repository echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" git push origin master 2>&1 | grep -v 'To https' - diff --git a/index.ts b/index.ts index ae20676..a7302ba 100644 --- a/index.ts +++ b/index.ts @@ -1,7 +1,8 @@ -// tslint:disable +/* tslint:disable */ +/* eslint-disable */ /** * ACH API - * Moov ACH ([Automated Clearing House](https://en.wikipedia.org/wiki/Automated_Clearing_House)) implements an HTTP API for creating, parsing and validating ACH files. ACH is the primary method of electronic money movement throughout the United States. + * Moov ACH ([Automated Clearing House](https://en.wikipedia.org/wiki/Automated_Clearing_House)) implements an HTTP API for creating, parsing, and validating ACH files. ACH is the primary method of electronic money movement throughout the United States. * * The version of the OpenAPI document: v1 * @@ -14,3 +15,4 @@ export * from "./api"; export * from "./configuration"; + diff --git a/makefile b/makefile index 3cb0e33..57bec92 100644 --- a/makefile +++ b/makefile @@ -8,7 +8,7 @@ client: # Checkout https://github.com/OpenAPITools/openapi-generator/releases @chmod +x ./openapi-generator @rm -rf ./client - OPENAPI_GENERATOR_VERSION=4.3.1 ./openapi-generator generate -i https://raw.githubusercontent.com/moov-io/ach/v1.4.3/openapi.yaml -g typescript-axios + OPENAPI_GENERATOR_VERSION=6.0.0 ./openapi-generator generate -i https://raw.githubusercontent.com/moov-io/ach/v1.18.1/openapi.yaml -g typescript-axios .PHONY: docs docs: