@ontemper/edi 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +321 -0
- package/dist/control-numbers.d.ts +20 -0
- package/dist/control-numbers.js +77 -0
- package/dist/edination-client/api/edi-model-api.d.ts +268 -0
- package/dist/edination-client/api/edi-model-api.js +326 -0
- package/dist/edination-client/api/edifact-api.d.ts +453 -0
- package/dist/edination-client/api/edifact-api.js +448 -0
- package/dist/edination-client/api/hl7-api.d.ts +294 -0
- package/dist/edination-client/api/hl7-api.js +315 -0
- package/dist/edination-client/api/ncpdp-api.d.ts +278 -0
- package/dist/edination-client/api/ncpdp-api.js +305 -0
- package/dist/edination-client/api/vda-api.d.ts +262 -0
- package/dist/edination-client/api/vda-api.js +295 -0
- package/dist/edination-client/api/x12-api.d.ts +437 -0
- package/dist/edination-client/api/x12-api.js +438 -0
- package/dist/edination-client/api.d.ts +17 -0
- package/dist/edination-client/api.js +35 -0
- package/dist/edination-client/base.d.ts +66 -0
- package/dist/edination-client/base.js +70 -0
- package/dist/edination-client/common.d.ts +65 -0
- package/dist/edination-client/common.js +142 -0
- package/dist/edination-client/configuration.d.ts +91 -0
- package/dist/edination-client/configuration.js +104 -0
- package/dist/edination-client/index.d.ts +14 -0
- package/dist/edination-client/index.js +32 -0
- package/dist/edination-client/model/batch-receiving-application.d.ts +36 -0
- package/dist/edination-client/model/batch-receiving-application.js +15 -0
- package/dist/edination-client/model/batch-receiving-facility.d.ts +36 -0
- package/dist/edination-client/model/batch-receiving-facility.js +15 -0
- package/dist/edination-client/model/batch-receiving-network-address.d.ts +36 -0
- package/dist/edination-client/model/batch-receiving-network-address.js +15 -0
- package/dist/edination-client/model/batch-sending-application.d.ts +36 -0
- package/dist/edination-client/model/batch-sending-application.js +15 -0
- package/dist/edination-client/model/batch-sending-facility.d.ts +36 -0
- package/dist/edination-client/model/batch-sending-facility.js +15 -0
- package/dist/edination-client/model/batch-sending-network-address.d.ts +36 -0
- package/dist/edination-client/model/batch-sending-network-address.js +15 -0
- package/dist/edination-client/model/bhs.d.ts +108 -0
- package/dist/edination-client/model/bhs.js +15 -0
- package/dist/edination-client/model/bts.d.ts +36 -0
- package/dist/edination-client/model/bts.js +15 -0
- package/dist/edination-client/model/edi-model.d.ts +37 -0
- package/dist/edination-client/model/edi-model.js +15 -0
- package/dist/edination-client/model/edifact-group.d.ts +38 -0
- package/dist/edination-client/model/edifact-group.js +15 -0
- package/dist/edination-client/model/edifact-interchange.d.ts +53 -0
- package/dist/edination-client/model/edifact-interchange.js +15 -0
- package/dist/edination-client/model/error-details.d.ts +30 -0
- package/dist/edination-client/model/error-details.js +15 -0
- package/dist/edination-client/model/fhs.d.ts +108 -0
- package/dist/edination-client/model/fhs.js +15 -0
- package/dist/edination-client/model/file-receiving-application.d.ts +36 -0
- package/dist/edination-client/model/file-receiving-application.js +15 -0
- package/dist/edination-client/model/file-receiving-facility.d.ts +36 -0
- package/dist/edination-client/model/file-receiving-facility.js +15 -0
- package/dist/edination-client/model/file-receiving-network-address.d.ts +36 -0
- package/dist/edination-client/model/file-receiving-network-address.js +15 -0
- package/dist/edination-client/model/file-sending-application.d.ts +36 -0
- package/dist/edination-client/model/file-sending-application.js +15 -0
- package/dist/edination-client/model/file-sending-facility.d.ts +36 -0
- package/dist/edination-client/model/file-sending-facility.js +15 -0
- package/dist/edination-client/model/file-sending-network-address.d.ts +36 -0
- package/dist/edination-client/model/file-sending-network-address.js +15 -0
- package/dist/edination-client/model/flat-message.d.ts +37 -0
- package/dist/edination-client/model/flat-message.js +15 -0
- package/dist/edination-client/model/fts.d.ts +30 -0
- package/dist/edination-client/model/fts.js +15 -0
- package/dist/edination-client/model/ge.d.ts +30 -0
- package/dist/edination-client/model/ge.js +15 -0
- package/dist/edination-client/model/gs.d.ts +66 -0
- package/dist/edination-client/model/gs.js +15 -0
- package/dist/edination-client/model/hl7-group.d.ts +38 -0
- package/dist/edination-client/model/hl7-group.js +15 -0
- package/dist/edination-client/model/hl7-interchange.d.ts +46 -0
- package/dist/edination-client/model/hl7-interchange.js +15 -0
- package/dist/edination-client/model/iea.d.ts +30 -0
- package/dist/edination-client/model/iea.js +15 -0
- package/dist/edination-client/model/index.d.ts +49 -0
- package/dist/edination-client/model/index.js +65 -0
- package/dist/edination-client/model/isa.d.ts +114 -0
- package/dist/edination-client/model/isa.js +15 -0
- package/dist/edination-client/model/link.d.ts +36 -0
- package/dist/edination-client/model/link.js +15 -0
- package/dist/edination-client/model/ncpdp-transmission.d.ts +45 -0
- package/dist/edination-client/model/ncpdp-transmission.js +15 -0
- package/dist/edination-client/model/operation-detail.d.ts +90 -0
- package/dist/edination-client/model/operation-detail.js +15 -0
- package/dist/edination-client/model/operation-result.d.ts +37 -0
- package/dist/edination-client/model/operation-result.js +15 -0
- package/dist/edination-client/model/s001.d.ts +42 -0
- package/dist/edination-client/model/s001.js +15 -0
- package/dist/edination-client/model/s002.d.ts +42 -0
- package/dist/edination-client/model/s002.js +15 -0
- package/dist/edination-client/model/s003.d.ts +42 -0
- package/dist/edination-client/model/s003.js +15 -0
- package/dist/edination-client/model/s004.d.ts +30 -0
- package/dist/edination-client/model/s004.js +15 -0
- package/dist/edination-client/model/s005.d.ts +30 -0
- package/dist/edination-client/model/s005.js +15 -0
- package/dist/edination-client/model/s006.d.ts +30 -0
- package/dist/edination-client/model/s006.js +15 -0
- package/dist/edination-client/model/s007.d.ts +30 -0
- package/dist/edination-client/model/s007.js +15 -0
- package/dist/edination-client/model/s008.d.ts +36 -0
- package/dist/edination-client/model/s008.js +15 -0
- package/dist/edination-client/model/ta1.d.ts +48 -0
- package/dist/edination-client/model/ta1.js +15 -0
- package/dist/edination-client/model/transmission-header.d.ts +66 -0
- package/dist/edination-client/model/transmission-header.js +15 -0
- package/dist/edination-client/model/transmission-trailer.d.ts +36 -0
- package/dist/edination-client/model/transmission-trailer.js +15 -0
- package/dist/edination-client/model/una.d.ts +54 -0
- package/dist/edination-client/model/una.js +15 -0
- package/dist/edination-client/model/unb.d.ts +89 -0
- package/dist/edination-client/model/unb.js +15 -0
- package/dist/edination-client/model/une.d.ts +30 -0
- package/dist/edination-client/model/une.js +15 -0
- package/dist/edination-client/model/ung.d.ts +70 -0
- package/dist/edination-client/model/ung.js +15 -0
- package/dist/edination-client/model/unz.d.ts +30 -0
- package/dist/edination-client/model/unz.js +15 -0
- package/dist/edination-client/model/x12-group.d.ts +38 -0
- package/dist/edination-client/model/x12-group.js +15 -0
- package/dist/edination-client/model/x12-interchange.d.ts +65 -0
- package/dist/edination-client/model/x12-interchange.js +15 -0
- package/dist/index.d.ts +45 -0
- package/dist/index.js +197 -0
- package/examples/node-edi.ts +58 -0
- package/package.json +49 -0
|
@@ -0,0 +1,437 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EdiNation API
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from 'axios';
|
|
13
|
+
import { BaseAPI, type RequestArgs } from '../base';
|
|
14
|
+
import type { Configuration } from '../configuration';
|
|
15
|
+
import type { OperationResult } from '../model';
|
|
16
|
+
import type { X12Interchange } from '../model';
|
|
17
|
+
/**
|
|
18
|
+
* X12Api - axios parameter creator
|
|
19
|
+
* @export
|
|
20
|
+
*/
|
|
21
|
+
export declare const X12ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @summary Generate X12 acknowledments
|
|
25
|
+
* @param {boolean} [basicSyntax] All data elements with alpha (A) or alphanumeric (AN) data types are validated against a syntax set of allowed characters. The default syntax set is the Extended, hence the default for this parameter is false. By setting this to true, validation will use the Basic syntax set.
|
|
26
|
+
* @param {string} [syntaxSet] In case you need to validate against a syntax set, different than Basic and Extended, populate this filed with all of the allowed symbols, url-escaped.
|
|
27
|
+
* @param {boolean} [detectDuplicates] If you need to detect duplicates as in functional groups or transactions with the same reference number, set this flag to true. The default is false.
|
|
28
|
+
* @param {number} [tranRefNumber] The default is 1. Set this to whatever the 997 or 999 X12Interchange.ST.TransactionSetControlNumber_02 needs to be. In case there are multiple acknowledgments (for multiple functional groups), this will be starting reference number and every subsequent acknowledgment will have the previous reference number incremented with 1.
|
|
29
|
+
* @param {number} [interchangeRefNumber] The default is 1. Set this to whatever the 997 or 999 X12Interchange.ISA.InterchangeControlNumber_13 needs to be.
|
|
30
|
+
* @param {boolean} [ackForValidTrans] The default is false. Set this to true if you need AK2 loops included for all valid transaction as well. By default AK2 loops are generated only for invalid transactions.
|
|
31
|
+
* @param {boolean} [batchAcks] The default is true. Set this to false if you need to generate separate X12Interchange for each acknowledgment. By default all acknowledgments are batched in the same X12Interchange.
|
|
32
|
+
* @param {string} [technicalAck] The default technical acknowledgment TA1 is generated according to X12Interchange.ISA.AcknowledgementRequested_14. You can either enforce it to always generate TA1s or supress it to never generate any TA1s. This will override the flag in X12Interchange.ISA.AcknowledgementRequested_14. The available values are: default, enforce, suppress.
|
|
33
|
+
* @param {string} [ack] The default value is 997. The type of acknowledgment being generated. Set this to 999 if you need to generate an implementation instead of functional acknowledgment. The available values are: 997, 999.
|
|
34
|
+
* @param {boolean} [ak901isP] The value of the AK9\'s first element. By default it is \"E\". Set this to true if you want this value to be \"P\" instead.
|
|
35
|
+
* @param {X12Interchange} [x12Interchange] The X12Interchange object to acknowledge.
|
|
36
|
+
* @param {*} [options] Override http request option.
|
|
37
|
+
* @throws {RequiredError}
|
|
38
|
+
*/
|
|
39
|
+
x12AckPost: (basicSyntax?: boolean, syntaxSet?: string, detectDuplicates?: boolean, tranRefNumber?: number, interchangeRefNumber?: number, ackForValidTrans?: boolean, batchAcks?: boolean, technicalAck?: string, ack?: string, ak901isP?: boolean, x12Interchange?: X12Interchange, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @summary Convert X12 files to JSON
|
|
43
|
+
* @param {boolean} [ignoreNullValues] Whether to ignore all null values in the response. The default is false.
|
|
44
|
+
* @param {boolean} [continueOnError] Whether to continue reading if a corrupt interchange is encountered. The default is false.
|
|
45
|
+
* @param {string} [charSet] The encoding of the file contents. The default is utf-8. The available values are: unicodeFFFE, utf-32, utf-32BE, us-ascii, iso-8859-1, utf-7, utf-8, utf-16.
|
|
46
|
+
* @param {string} [model] The model to use. By default, the API will infer the model based on the transaction and version identifiers.
|
|
47
|
+
* @param {File} [body]
|
|
48
|
+
* @param {*} [options] Override http request option.
|
|
49
|
+
* @throws {RequiredError}
|
|
50
|
+
*/
|
|
51
|
+
x12ReadPost: (ignoreNullValues?: boolean, continueOnError?: boolean, charSet?: string, model?: string, body?: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
|
+
/**
|
|
53
|
+
*
|
|
54
|
+
* @summary Validate X12 messages
|
|
55
|
+
* @param {boolean} [basicSyntax] All data elements with alpha (A) or alphanumeric (AN) data types are validated against a syntax set of allowed characters. The default syntax set is the Extended, hence the default for this parameter is false. By setting this to true, validation will use the Basic syntax set.
|
|
56
|
+
* @param {string} [syntaxSet] In case you need to validate against a syntax set, different than Basic and Extended, populate this filed with all of the allowed symbols, url-escaped.
|
|
57
|
+
* @param {boolean} [skipTrailer] You are allowed to validate an X12Interchange with missing interchange, functional group or transaction trailers (IEA, GE, SE). This is because these will be automatically applied during the Write oprtaion so you don\'t have to worry about counting the items. By default it is expected that all trailers are present when you validate the X12Interchange and by default, this is set to false. To skip all trailer validation, set this to true.
|
|
58
|
+
* @param {boolean} [structureOnly] This is equivalent to HIPAA Snip level 1, where only the structure and control segments are validated. By default, this is set to false, however if you want to not validate things such as data types, number of repeteitions or dates, set this to true.
|
|
59
|
+
* @param {X12Interchange} [x12Interchange] The X12Interchange object to validate.
|
|
60
|
+
* @param {*} [options] Override http request option.
|
|
61
|
+
* @throws {RequiredError}
|
|
62
|
+
*/
|
|
63
|
+
x12ValidatePost: (basicSyntax?: boolean, syntaxSet?: string, skipTrailer?: boolean, structureOnly?: boolean, x12Interchange?: X12Interchange, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
|
+
/**
|
|
65
|
+
*
|
|
66
|
+
* @summary Convert JSON to X12 files
|
|
67
|
+
* @param {boolean} [preserveWhitespace] Whether to preserve blank data elements so the output contains multiple delimiters instead of omitting any excess delimiters. The default is false.
|
|
68
|
+
* @param {string} [charSet] The encoding of the file contents. The default is utf-8. The available values are: unicodeFFFE, utf-32, utf-32BE, us-ascii, iso-8859-1, utf-7, utf-8, utf-16.
|
|
69
|
+
* @param {string} [postfix] The postfix to be applied at the end of each segment, just after the segment separator. This is usually a carriage return (CR), line feed (LF) or both. By default, there is no postfix.
|
|
70
|
+
* @param {X12Interchange} [x12Interchange] The X12Interchange object to translate to raw X12.
|
|
71
|
+
* @param {*} [options] Override http request option.
|
|
72
|
+
* @throws {RequiredError}
|
|
73
|
+
*/
|
|
74
|
+
x12WritePost: (preserveWhitespace?: boolean, charSet?: string, postfix?: string, x12Interchange?: X12Interchange, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
75
|
+
};
|
|
76
|
+
/**
|
|
77
|
+
* X12Api - functional programming interface
|
|
78
|
+
* @export
|
|
79
|
+
*/
|
|
80
|
+
export declare const X12ApiFp: (configuration?: Configuration) => {
|
|
81
|
+
/**
|
|
82
|
+
*
|
|
83
|
+
* @summary Generate X12 acknowledments
|
|
84
|
+
* @param {boolean} [basicSyntax] All data elements with alpha (A) or alphanumeric (AN) data types are validated against a syntax set of allowed characters. The default syntax set is the Extended, hence the default for this parameter is false. By setting this to true, validation will use the Basic syntax set.
|
|
85
|
+
* @param {string} [syntaxSet] In case you need to validate against a syntax set, different than Basic and Extended, populate this filed with all of the allowed symbols, url-escaped.
|
|
86
|
+
* @param {boolean} [detectDuplicates] If you need to detect duplicates as in functional groups or transactions with the same reference number, set this flag to true. The default is false.
|
|
87
|
+
* @param {number} [tranRefNumber] The default is 1. Set this to whatever the 997 or 999 X12Interchange.ST.TransactionSetControlNumber_02 needs to be. In case there are multiple acknowledgments (for multiple functional groups), this will be starting reference number and every subsequent acknowledgment will have the previous reference number incremented with 1.
|
|
88
|
+
* @param {number} [interchangeRefNumber] The default is 1. Set this to whatever the 997 or 999 X12Interchange.ISA.InterchangeControlNumber_13 needs to be.
|
|
89
|
+
* @param {boolean} [ackForValidTrans] The default is false. Set this to true if you need AK2 loops included for all valid transaction as well. By default AK2 loops are generated only for invalid transactions.
|
|
90
|
+
* @param {boolean} [batchAcks] The default is true. Set this to false if you need to generate separate X12Interchange for each acknowledgment. By default all acknowledgments are batched in the same X12Interchange.
|
|
91
|
+
* @param {string} [technicalAck] The default technical acknowledgment TA1 is generated according to X12Interchange.ISA.AcknowledgementRequested_14. You can either enforce it to always generate TA1s or supress it to never generate any TA1s. This will override the flag in X12Interchange.ISA.AcknowledgementRequested_14. The available values are: default, enforce, suppress.
|
|
92
|
+
* @param {string} [ack] The default value is 997. The type of acknowledgment being generated. Set this to 999 if you need to generate an implementation instead of functional acknowledgment. The available values are: 997, 999.
|
|
93
|
+
* @param {boolean} [ak901isP] The value of the AK9\'s first element. By default it is \"E\". Set this to true if you want this value to be \"P\" instead.
|
|
94
|
+
* @param {X12Interchange} [x12Interchange] The X12Interchange object to acknowledge.
|
|
95
|
+
* @param {*} [options] Override http request option.
|
|
96
|
+
* @throws {RequiredError}
|
|
97
|
+
*/
|
|
98
|
+
x12AckPost(basicSyntax?: boolean, syntaxSet?: string, detectDuplicates?: boolean, tranRefNumber?: number, interchangeRefNumber?: number, ackForValidTrans?: boolean, batchAcks?: boolean, technicalAck?: string, ack?: string, ak901isP?: boolean, x12Interchange?: X12Interchange, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<X12Interchange>>>;
|
|
99
|
+
/**
|
|
100
|
+
*
|
|
101
|
+
* @summary Convert X12 files to JSON
|
|
102
|
+
* @param {boolean} [ignoreNullValues] Whether to ignore all null values in the response. The default is false.
|
|
103
|
+
* @param {boolean} [continueOnError] Whether to continue reading if a corrupt interchange is encountered. The default is false.
|
|
104
|
+
* @param {string} [charSet] The encoding of the file contents. The default is utf-8. The available values are: unicodeFFFE, utf-32, utf-32BE, us-ascii, iso-8859-1, utf-7, utf-8, utf-16.
|
|
105
|
+
* @param {string} [model] The model to use. By default, the API will infer the model based on the transaction and version identifiers.
|
|
106
|
+
* @param {File} [body]
|
|
107
|
+
* @param {*} [options] Override http request option.
|
|
108
|
+
* @throws {RequiredError}
|
|
109
|
+
*/
|
|
110
|
+
x12ReadPost(ignoreNullValues?: boolean, continueOnError?: boolean, charSet?: string, model?: string, body?: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<X12Interchange>>>;
|
|
111
|
+
/**
|
|
112
|
+
*
|
|
113
|
+
* @summary Validate X12 messages
|
|
114
|
+
* @param {boolean} [basicSyntax] All data elements with alpha (A) or alphanumeric (AN) data types are validated against a syntax set of allowed characters. The default syntax set is the Extended, hence the default for this parameter is false. By setting this to true, validation will use the Basic syntax set.
|
|
115
|
+
* @param {string} [syntaxSet] In case you need to validate against a syntax set, different than Basic and Extended, populate this filed with all of the allowed symbols, url-escaped.
|
|
116
|
+
* @param {boolean} [skipTrailer] You are allowed to validate an X12Interchange with missing interchange, functional group or transaction trailers (IEA, GE, SE). This is because these will be automatically applied during the Write oprtaion so you don\'t have to worry about counting the items. By default it is expected that all trailers are present when you validate the X12Interchange and by default, this is set to false. To skip all trailer validation, set this to true.
|
|
117
|
+
* @param {boolean} [structureOnly] This is equivalent to HIPAA Snip level 1, where only the structure and control segments are validated. By default, this is set to false, however if you want to not validate things such as data types, number of repeteitions or dates, set this to true.
|
|
118
|
+
* @param {X12Interchange} [x12Interchange] The X12Interchange object to validate.
|
|
119
|
+
* @param {*} [options] Override http request option.
|
|
120
|
+
* @throws {RequiredError}
|
|
121
|
+
*/
|
|
122
|
+
x12ValidatePost(basicSyntax?: boolean, syntaxSet?: string, skipTrailer?: boolean, structureOnly?: boolean, x12Interchange?: X12Interchange, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OperationResult>>;
|
|
123
|
+
/**
|
|
124
|
+
*
|
|
125
|
+
* @summary Convert JSON to X12 files
|
|
126
|
+
* @param {boolean} [preserveWhitespace] Whether to preserve blank data elements so the output contains multiple delimiters instead of omitting any excess delimiters. The default is false.
|
|
127
|
+
* @param {string} [charSet] The encoding of the file contents. The default is utf-8. The available values are: unicodeFFFE, utf-32, utf-32BE, us-ascii, iso-8859-1, utf-7, utf-8, utf-16.
|
|
128
|
+
* @param {string} [postfix] The postfix to be applied at the end of each segment, just after the segment separator. This is usually a carriage return (CR), line feed (LF) or both. By default, there is no postfix.
|
|
129
|
+
* @param {X12Interchange} [x12Interchange] The X12Interchange object to translate to raw X12.
|
|
130
|
+
* @param {*} [options] Override http request option.
|
|
131
|
+
* @throws {RequiredError}
|
|
132
|
+
*/
|
|
133
|
+
x12WritePost(preserveWhitespace?: boolean, charSet?: string, postfix?: string, x12Interchange?: X12Interchange, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
134
|
+
};
|
|
135
|
+
/**
|
|
136
|
+
* X12Api - factory interface
|
|
137
|
+
* @export
|
|
138
|
+
*/
|
|
139
|
+
export declare const X12ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
140
|
+
/**
|
|
141
|
+
*
|
|
142
|
+
* @summary Generate X12 acknowledments
|
|
143
|
+
* @param {X12ApiX12AckPostRequest} requestParameters Request parameters.
|
|
144
|
+
* @param {*} [options] Override http request option.
|
|
145
|
+
* @throws {RequiredError}
|
|
146
|
+
*/
|
|
147
|
+
x12AckPost(requestParameters?: X12ApiX12AckPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<X12Interchange>>;
|
|
148
|
+
/**
|
|
149
|
+
*
|
|
150
|
+
* @summary Convert X12 files to JSON
|
|
151
|
+
* @param {X12ApiX12ReadPostRequest} requestParameters Request parameters.
|
|
152
|
+
* @param {*} [options] Override http request option.
|
|
153
|
+
* @throws {RequiredError}
|
|
154
|
+
*/
|
|
155
|
+
x12ReadPost(requestParameters?: X12ApiX12ReadPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<X12Interchange>>;
|
|
156
|
+
/**
|
|
157
|
+
*
|
|
158
|
+
* @summary Validate X12 messages
|
|
159
|
+
* @param {X12ApiX12ValidatePostRequest} requestParameters Request parameters.
|
|
160
|
+
* @param {*} [options] Override http request option.
|
|
161
|
+
* @throws {RequiredError}
|
|
162
|
+
*/
|
|
163
|
+
x12ValidatePost(requestParameters?: X12ApiX12ValidatePostRequest, options?: RawAxiosRequestConfig): AxiosPromise<OperationResult>;
|
|
164
|
+
/**
|
|
165
|
+
*
|
|
166
|
+
* @summary Convert JSON to X12 files
|
|
167
|
+
* @param {X12ApiX12WritePostRequest} requestParameters Request parameters.
|
|
168
|
+
* @param {*} [options] Override http request option.
|
|
169
|
+
* @throws {RequiredError}
|
|
170
|
+
*/
|
|
171
|
+
x12WritePost(requestParameters?: X12ApiX12WritePostRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
172
|
+
};
|
|
173
|
+
/**
|
|
174
|
+
* X12Api - interface
|
|
175
|
+
* @export
|
|
176
|
+
* @interface X12Api
|
|
177
|
+
*/
|
|
178
|
+
export interface X12ApiInterface {
|
|
179
|
+
/**
|
|
180
|
+
*
|
|
181
|
+
* @summary Generate X12 acknowledments
|
|
182
|
+
* @param {X12ApiX12AckPostRequest} requestParameters Request parameters.
|
|
183
|
+
* @param {*} [options] Override http request option.
|
|
184
|
+
* @throws {RequiredError}
|
|
185
|
+
* @memberof X12ApiInterface
|
|
186
|
+
*/
|
|
187
|
+
x12AckPost(requestParameters?: X12ApiX12AckPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<X12Interchange>>;
|
|
188
|
+
/**
|
|
189
|
+
*
|
|
190
|
+
* @summary Convert X12 files to JSON
|
|
191
|
+
* @param {X12ApiX12ReadPostRequest} requestParameters Request parameters.
|
|
192
|
+
* @param {*} [options] Override http request option.
|
|
193
|
+
* @throws {RequiredError}
|
|
194
|
+
* @memberof X12ApiInterface
|
|
195
|
+
*/
|
|
196
|
+
x12ReadPost(requestParameters?: X12ApiX12ReadPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<X12Interchange>>;
|
|
197
|
+
/**
|
|
198
|
+
*
|
|
199
|
+
* @summary Validate X12 messages
|
|
200
|
+
* @param {X12ApiX12ValidatePostRequest} requestParameters Request parameters.
|
|
201
|
+
* @param {*} [options] Override http request option.
|
|
202
|
+
* @throws {RequiredError}
|
|
203
|
+
* @memberof X12ApiInterface
|
|
204
|
+
*/
|
|
205
|
+
x12ValidatePost(requestParameters?: X12ApiX12ValidatePostRequest, options?: RawAxiosRequestConfig): AxiosPromise<OperationResult>;
|
|
206
|
+
/**
|
|
207
|
+
*
|
|
208
|
+
* @summary Convert JSON to X12 files
|
|
209
|
+
* @param {X12ApiX12WritePostRequest} requestParameters Request parameters.
|
|
210
|
+
* @param {*} [options] Override http request option.
|
|
211
|
+
* @throws {RequiredError}
|
|
212
|
+
* @memberof X12ApiInterface
|
|
213
|
+
*/
|
|
214
|
+
x12WritePost(requestParameters?: X12ApiX12WritePostRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
* Request parameters for x12AckPost operation in X12Api.
|
|
218
|
+
* @export
|
|
219
|
+
* @interface X12ApiX12AckPostRequest
|
|
220
|
+
*/
|
|
221
|
+
export interface X12ApiX12AckPostRequest {
|
|
222
|
+
/**
|
|
223
|
+
* All data elements with alpha (A) or alphanumeric (AN) data types are validated against a syntax set of allowed characters. The default syntax set is the Extended, hence the default for this parameter is false. By setting this to true, validation will use the Basic syntax set.
|
|
224
|
+
* @type {boolean}
|
|
225
|
+
* @memberof X12ApiX12AckPost
|
|
226
|
+
*/
|
|
227
|
+
readonly basicSyntax?: boolean;
|
|
228
|
+
/**
|
|
229
|
+
* In case you need to validate against a syntax set, different than Basic and Extended, populate this filed with all of the allowed symbols, url-escaped.
|
|
230
|
+
* @type {string}
|
|
231
|
+
* @memberof X12ApiX12AckPost
|
|
232
|
+
*/
|
|
233
|
+
readonly syntaxSet?: string;
|
|
234
|
+
/**
|
|
235
|
+
* If you need to detect duplicates as in functional groups or transactions with the same reference number, set this flag to true. The default is false.
|
|
236
|
+
* @type {boolean}
|
|
237
|
+
* @memberof X12ApiX12AckPost
|
|
238
|
+
*/
|
|
239
|
+
readonly detectDuplicates?: boolean;
|
|
240
|
+
/**
|
|
241
|
+
* The default is 1. Set this to whatever the 997 or 999 X12Interchange.ST.TransactionSetControlNumber_02 needs to be. In case there are multiple acknowledgments (for multiple functional groups), this will be starting reference number and every subsequent acknowledgment will have the previous reference number incremented with 1.
|
|
242
|
+
* @type {number}
|
|
243
|
+
* @memberof X12ApiX12AckPost
|
|
244
|
+
*/
|
|
245
|
+
readonly tranRefNumber?: number;
|
|
246
|
+
/**
|
|
247
|
+
* The default is 1. Set this to whatever the 997 or 999 X12Interchange.ISA.InterchangeControlNumber_13 needs to be.
|
|
248
|
+
* @type {number}
|
|
249
|
+
* @memberof X12ApiX12AckPost
|
|
250
|
+
*/
|
|
251
|
+
readonly interchangeRefNumber?: number;
|
|
252
|
+
/**
|
|
253
|
+
* The default is false. Set this to true if you need AK2 loops included for all valid transaction as well. By default AK2 loops are generated only for invalid transactions.
|
|
254
|
+
* @type {boolean}
|
|
255
|
+
* @memberof X12ApiX12AckPost
|
|
256
|
+
*/
|
|
257
|
+
readonly ackForValidTrans?: boolean;
|
|
258
|
+
/**
|
|
259
|
+
* The default is true. Set this to false if you need to generate separate X12Interchange for each acknowledgment. By default all acknowledgments are batched in the same X12Interchange.
|
|
260
|
+
* @type {boolean}
|
|
261
|
+
* @memberof X12ApiX12AckPost
|
|
262
|
+
*/
|
|
263
|
+
readonly batchAcks?: boolean;
|
|
264
|
+
/**
|
|
265
|
+
* The default technical acknowledgment TA1 is generated according to X12Interchange.ISA.AcknowledgementRequested_14. You can either enforce it to always generate TA1s or supress it to never generate any TA1s. This will override the flag in X12Interchange.ISA.AcknowledgementRequested_14. The available values are: default, enforce, suppress.
|
|
266
|
+
* @type {string}
|
|
267
|
+
* @memberof X12ApiX12AckPost
|
|
268
|
+
*/
|
|
269
|
+
readonly technicalAck?: string;
|
|
270
|
+
/**
|
|
271
|
+
* The default value is 997. The type of acknowledgment being generated. Set this to 999 if you need to generate an implementation instead of functional acknowledgment. The available values are: 997, 999.
|
|
272
|
+
* @type {string}
|
|
273
|
+
* @memberof X12ApiX12AckPost
|
|
274
|
+
*/
|
|
275
|
+
readonly ack?: string;
|
|
276
|
+
/**
|
|
277
|
+
* The value of the AK9\'s first element. By default it is \"E\". Set this to true if you want this value to be \"P\" instead.
|
|
278
|
+
* @type {boolean}
|
|
279
|
+
* @memberof X12ApiX12AckPost
|
|
280
|
+
*/
|
|
281
|
+
readonly ak901isP?: boolean;
|
|
282
|
+
/**
|
|
283
|
+
* The X12Interchange object to acknowledge.
|
|
284
|
+
* @type {X12Interchange}
|
|
285
|
+
* @memberof X12ApiX12AckPost
|
|
286
|
+
*/
|
|
287
|
+
readonly x12Interchange?: X12Interchange;
|
|
288
|
+
}
|
|
289
|
+
/**
|
|
290
|
+
* Request parameters for x12ReadPost operation in X12Api.
|
|
291
|
+
* @export
|
|
292
|
+
* @interface X12ApiX12ReadPostRequest
|
|
293
|
+
*/
|
|
294
|
+
export interface X12ApiX12ReadPostRequest {
|
|
295
|
+
/**
|
|
296
|
+
* Whether to ignore all null values in the response. The default is false.
|
|
297
|
+
* @type {boolean}
|
|
298
|
+
* @memberof X12ApiX12ReadPost
|
|
299
|
+
*/
|
|
300
|
+
readonly ignoreNullValues?: boolean;
|
|
301
|
+
/**
|
|
302
|
+
* Whether to continue reading if a corrupt interchange is encountered. The default is false.
|
|
303
|
+
* @type {boolean}
|
|
304
|
+
* @memberof X12ApiX12ReadPost
|
|
305
|
+
*/
|
|
306
|
+
readonly continueOnError?: boolean;
|
|
307
|
+
/**
|
|
308
|
+
* The encoding of the file contents. The default is utf-8. The available values are: unicodeFFFE, utf-32, utf-32BE, us-ascii, iso-8859-1, utf-7, utf-8, utf-16.
|
|
309
|
+
* @type {string}
|
|
310
|
+
* @memberof X12ApiX12ReadPost
|
|
311
|
+
*/
|
|
312
|
+
readonly charSet?: string;
|
|
313
|
+
/**
|
|
314
|
+
* The model to use. By default, the API will infer the model based on the transaction and version identifiers.
|
|
315
|
+
* @type {string}
|
|
316
|
+
* @memberof X12ApiX12ReadPost
|
|
317
|
+
*/
|
|
318
|
+
readonly model?: string;
|
|
319
|
+
/**
|
|
320
|
+
*
|
|
321
|
+
* @type {File}
|
|
322
|
+
* @memberof X12ApiX12ReadPost
|
|
323
|
+
*/
|
|
324
|
+
readonly body?: File;
|
|
325
|
+
}
|
|
326
|
+
/**
|
|
327
|
+
* Request parameters for x12ValidatePost operation in X12Api.
|
|
328
|
+
* @export
|
|
329
|
+
* @interface X12ApiX12ValidatePostRequest
|
|
330
|
+
*/
|
|
331
|
+
export interface X12ApiX12ValidatePostRequest {
|
|
332
|
+
/**
|
|
333
|
+
* All data elements with alpha (A) or alphanumeric (AN) data types are validated against a syntax set of allowed characters. The default syntax set is the Extended, hence the default for this parameter is false. By setting this to true, validation will use the Basic syntax set.
|
|
334
|
+
* @type {boolean}
|
|
335
|
+
* @memberof X12ApiX12ValidatePost
|
|
336
|
+
*/
|
|
337
|
+
readonly basicSyntax?: boolean;
|
|
338
|
+
/**
|
|
339
|
+
* In case you need to validate against a syntax set, different than Basic and Extended, populate this filed with all of the allowed symbols, url-escaped.
|
|
340
|
+
* @type {string}
|
|
341
|
+
* @memberof X12ApiX12ValidatePost
|
|
342
|
+
*/
|
|
343
|
+
readonly syntaxSet?: string;
|
|
344
|
+
/**
|
|
345
|
+
* You are allowed to validate an X12Interchange with missing interchange, functional group or transaction trailers (IEA, GE, SE). This is because these will be automatically applied during the Write oprtaion so you don\'t have to worry about counting the items. By default it is expected that all trailers are present when you validate the X12Interchange and by default, this is set to false. To skip all trailer validation, set this to true.
|
|
346
|
+
* @type {boolean}
|
|
347
|
+
* @memberof X12ApiX12ValidatePost
|
|
348
|
+
*/
|
|
349
|
+
readonly skipTrailer?: boolean;
|
|
350
|
+
/**
|
|
351
|
+
* This is equivalent to HIPAA Snip level 1, where only the structure and control segments are validated. By default, this is set to false, however if you want to not validate things such as data types, number of repeteitions or dates, set this to true.
|
|
352
|
+
* @type {boolean}
|
|
353
|
+
* @memberof X12ApiX12ValidatePost
|
|
354
|
+
*/
|
|
355
|
+
readonly structureOnly?: boolean;
|
|
356
|
+
/**
|
|
357
|
+
* The X12Interchange object to validate.
|
|
358
|
+
* @type {X12Interchange}
|
|
359
|
+
* @memberof X12ApiX12ValidatePost
|
|
360
|
+
*/
|
|
361
|
+
readonly x12Interchange?: X12Interchange;
|
|
362
|
+
}
|
|
363
|
+
/**
|
|
364
|
+
* Request parameters for x12WritePost operation in X12Api.
|
|
365
|
+
* @export
|
|
366
|
+
* @interface X12ApiX12WritePostRequest
|
|
367
|
+
*/
|
|
368
|
+
export interface X12ApiX12WritePostRequest {
|
|
369
|
+
/**
|
|
370
|
+
* Whether to preserve blank data elements so the output contains multiple delimiters instead of omitting any excess delimiters. The default is false.
|
|
371
|
+
* @type {boolean}
|
|
372
|
+
* @memberof X12ApiX12WritePost
|
|
373
|
+
*/
|
|
374
|
+
readonly preserveWhitespace?: boolean;
|
|
375
|
+
/**
|
|
376
|
+
* The encoding of the file contents. The default is utf-8. The available values are: unicodeFFFE, utf-32, utf-32BE, us-ascii, iso-8859-1, utf-7, utf-8, utf-16.
|
|
377
|
+
* @type {string}
|
|
378
|
+
* @memberof X12ApiX12WritePost
|
|
379
|
+
*/
|
|
380
|
+
readonly charSet?: string;
|
|
381
|
+
/**
|
|
382
|
+
* The postfix to be applied at the end of each segment, just after the segment separator. This is usually a carriage return (CR), line feed (LF) or both. By default, there is no postfix.
|
|
383
|
+
* @type {string}
|
|
384
|
+
* @memberof X12ApiX12WritePost
|
|
385
|
+
*/
|
|
386
|
+
readonly postfix?: string;
|
|
387
|
+
/**
|
|
388
|
+
* The X12Interchange object to translate to raw X12.
|
|
389
|
+
* @type {X12Interchange}
|
|
390
|
+
* @memberof X12ApiX12WritePost
|
|
391
|
+
*/
|
|
392
|
+
readonly x12Interchange?: X12Interchange;
|
|
393
|
+
}
|
|
394
|
+
/**
|
|
395
|
+
* X12Api - object-oriented interface
|
|
396
|
+
* @export
|
|
397
|
+
* @class X12Api
|
|
398
|
+
* @extends {BaseAPI}
|
|
399
|
+
*/
|
|
400
|
+
export declare class X12Api extends BaseAPI implements X12ApiInterface {
|
|
401
|
+
/**
|
|
402
|
+
*
|
|
403
|
+
* @summary Generate X12 acknowledments
|
|
404
|
+
* @param {X12ApiX12AckPostRequest} requestParameters Request parameters.
|
|
405
|
+
* @param {*} [options] Override http request option.
|
|
406
|
+
* @throws {RequiredError}
|
|
407
|
+
* @memberof X12Api
|
|
408
|
+
*/
|
|
409
|
+
x12AckPost(requestParameters?: X12ApiX12AckPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<X12Interchange[], any, {}>>;
|
|
410
|
+
/**
|
|
411
|
+
*
|
|
412
|
+
* @summary Convert X12 files to JSON
|
|
413
|
+
* @param {X12ApiX12ReadPostRequest} requestParameters Request parameters.
|
|
414
|
+
* @param {*} [options] Override http request option.
|
|
415
|
+
* @throws {RequiredError}
|
|
416
|
+
* @memberof X12Api
|
|
417
|
+
*/
|
|
418
|
+
x12ReadPost(requestParameters?: X12ApiX12ReadPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<X12Interchange[], any, {}>>;
|
|
419
|
+
/**
|
|
420
|
+
*
|
|
421
|
+
* @summary Validate X12 messages
|
|
422
|
+
* @param {X12ApiX12ValidatePostRequest} requestParameters Request parameters.
|
|
423
|
+
* @param {*} [options] Override http request option.
|
|
424
|
+
* @throws {RequiredError}
|
|
425
|
+
* @memberof X12Api
|
|
426
|
+
*/
|
|
427
|
+
x12ValidatePost(requestParameters?: X12ApiX12ValidatePostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OperationResult, any, {}>>;
|
|
428
|
+
/**
|
|
429
|
+
*
|
|
430
|
+
* @summary Convert JSON to X12 files
|
|
431
|
+
* @param {X12ApiX12WritePostRequest} requestParameters Request parameters.
|
|
432
|
+
* @param {*} [options] Override http request option.
|
|
433
|
+
* @throws {RequiredError}
|
|
434
|
+
* @memberof X12Api
|
|
435
|
+
*/
|
|
436
|
+
x12WritePost(requestParameters?: X12ApiX12WritePostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
437
|
+
}
|