@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,453 @@
|
|
|
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 { EdifactInterchange } from '../model';
|
|
16
|
+
import type { OperationResult } from '../model';
|
|
17
|
+
/**
|
|
18
|
+
* EdifactApi - axios parameter creator
|
|
19
|
+
* @export
|
|
20
|
+
*/
|
|
21
|
+
export declare const EdifactApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @summary Generate EDIFACT acknowledments
|
|
25
|
+
* @param {string} [syntaxSet] In case you need to validate against a syntax set, different than UNOA and UNOB, populate this filed with all of the allowed symbols, url-escaped. All data elements with alpha (A) or alphanumeric (AN) data types are validated against a syntax set of allowed characters. The supported syntax sets are UNOA and UNOB. The validator infers the correct syntax set from EdifactInterchange.UNB.SYNTAXIDENTIFIER_1.SyntaxIdentifier_1. The symbols added to this field will override the corresponding sets in both UNOA and UNOB.
|
|
26
|
+
* @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.
|
|
27
|
+
* @param {number} [tranRefNumber] The default is 1. Set this to whatever the CONTRL UNH.MessageReferenceNumber_01 needs to be.
|
|
28
|
+
* @param {number} [interchangeRefNumber] The default is 1. Set this to whatever the CONTRL EdifactInterchange.UNB.InterchangeControlReference_5 needs to be.
|
|
29
|
+
* @param {boolean} [ackForValidTrans] The default is false. Set this to true if you need UCM loops included for all valid transaction as well. By default UCM loops are generated only for invalid transactions.
|
|
30
|
+
* @param {boolean} [batchAcks] The default is true. Set this to false if you need to generate separate EdifactInterchange for each acknowledgment. By default all acknowledgments are batched in the same EdifactInterchange.
|
|
31
|
+
* @param {string} [technicalAck] The default technical acknowledgment CONTRL is generated according to EdifactInterchange.UNB.AcknowledgementRequest_9. You can either enforce it to always generate technical CONTRLs or supress it to never generate any technical CONTRLs. This will override the flag in EdifactInterchange.UNB.AcknowledgementRequest_9. The available values are: default, enforce, suppress.
|
|
32
|
+
* @param {boolean} [eancomS3] The default syntax for EANCOM transactions. By default all EANCOM transactions will be validated according to the rules of Syntax 4. Set this flag to true if you need Syntax 3 to be used.
|
|
33
|
+
* @param {EdifactInterchange} [edifactInterchange] The EdifactInterchange object to acknowledge.
|
|
34
|
+
* @param {*} [options] Override http request option.
|
|
35
|
+
* @throws {RequiredError}
|
|
36
|
+
*/
|
|
37
|
+
edifactAckPost: (syntaxSet?: string, detectDuplicates?: boolean, tranRefNumber?: number, interchangeRefNumber?: number, ackForValidTrans?: boolean, batchAcks?: boolean, technicalAck?: string, eancomS3?: boolean, edifactInterchange?: EdifactInterchange, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @summary Convert EDIFACT files to JSON
|
|
41
|
+
* @param {boolean} [ignoreNullValues] Whether to ignore all null values in the response. The default is false.
|
|
42
|
+
* @param {boolean} [continueOnError] Whether to continue reading if a corrupt interchange is encountered. The default is false.
|
|
43
|
+
* @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.
|
|
44
|
+
* @param {string} [model] The model to use. By default, the API will infer the model based on the transaction and version identifiers.
|
|
45
|
+
* @param {boolean} [eancomS3] The default syntax for EANCOM transactions. By default all EANCOM transactions will be translated and validated according to the rules of Syntax 4. Set this flag to true if you need Syntax 3 to be used.
|
|
46
|
+
* @param {File} [body]
|
|
47
|
+
* @param {*} [options] Override http request option.
|
|
48
|
+
* @throws {RequiredError}
|
|
49
|
+
*/
|
|
50
|
+
edifactReadPost: (ignoreNullValues?: boolean, continueOnError?: boolean, charSet?: string, model?: string, eancomS3?: boolean, body?: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @summary Validate EDIFACT messages
|
|
54
|
+
* @param {string} [syntaxSet] In case you need to validate against a syntax set, different than UNOA and UNOB, populate this filed with all of the allowed symbols, url-escaped. All data elements with alpha (A) or alphanumeric (AN) data types are validated against a syntax set of allowed characters. The supported syntax sets are UNOA and UNOB. The validator infers the correct syntax set from EdifactInterchange.UNB.SYNTAXIDENTIFIER_1.SyntaxIdentifier_1. The symbols added to this field will override the corresponding sets in both UNOA and UNOB.
|
|
55
|
+
* @param {boolean} [skipTrailer] You are allowed to validate an EdifactInterchange with missing interchange, functional group or transaction trailers (UNZ, UNE, UNT). 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 EdifactInterchange and by default, this is set to false. To skip all trailer validation, set this to true.
|
|
56
|
+
* @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.
|
|
57
|
+
* @param {string} [decimalPoint] This could be either point . (default) or comma ,.
|
|
58
|
+
* @param {boolean} [eancomS3] The default syntax for EANCOM transactions. By default all EANCOM transactions will be validated according to the rules of Syntax 4. Set this flag to true if you need Syntax 3 to be used.
|
|
59
|
+
* @param {EdifactInterchange} [edifactInterchange] The EdifactInterchange object to validate.
|
|
60
|
+
* @param {*} [options] Override http request option.
|
|
61
|
+
* @throws {RequiredError}
|
|
62
|
+
*/
|
|
63
|
+
edifactValidatePost: (syntaxSet?: string, skipTrailer?: boolean, structureOnly?: boolean, decimalPoint?: string, eancomS3?: boolean, edifactInterchange?: EdifactInterchange, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
|
+
/**
|
|
65
|
+
*
|
|
66
|
+
* @summary Convert JSON to EDIFACT 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 {boolean} [sameRepetionAndDataElement] Sometimes the same delimiter is used to denote data element separator and repetition separator as in IATA transactions. By default, this is false.
|
|
71
|
+
* @param {boolean} [eancomS3] The default syntax for EANCOM transactions. By default all EANCOM transactions will be translated and validated according to the rules of Syntax 4. Set this flag to true if you need Syntax 3 to be used.
|
|
72
|
+
* @param {EdifactInterchange} [edifactInterchange] The EdifactInterchange object to translate to raw EDIFACT.
|
|
73
|
+
* @param {*} [options] Override http request option.
|
|
74
|
+
* @throws {RequiredError}
|
|
75
|
+
*/
|
|
76
|
+
edifactWritePost: (preserveWhitespace?: boolean, charSet?: string, postfix?: string, sameRepetionAndDataElement?: boolean, eancomS3?: boolean, edifactInterchange?: EdifactInterchange, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
|
+
};
|
|
78
|
+
/**
|
|
79
|
+
* EdifactApi - functional programming interface
|
|
80
|
+
* @export
|
|
81
|
+
*/
|
|
82
|
+
export declare const EdifactApiFp: (configuration?: Configuration) => {
|
|
83
|
+
/**
|
|
84
|
+
*
|
|
85
|
+
* @summary Generate EDIFACT acknowledments
|
|
86
|
+
* @param {string} [syntaxSet] In case you need to validate against a syntax set, different than UNOA and UNOB, populate this filed with all of the allowed symbols, url-escaped. All data elements with alpha (A) or alphanumeric (AN) data types are validated against a syntax set of allowed characters. The supported syntax sets are UNOA and UNOB. The validator infers the correct syntax set from EdifactInterchange.UNB.SYNTAXIDENTIFIER_1.SyntaxIdentifier_1. The symbols added to this field will override the corresponding sets in both UNOA and UNOB.
|
|
87
|
+
* @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.
|
|
88
|
+
* @param {number} [tranRefNumber] The default is 1. Set this to whatever the CONTRL UNH.MessageReferenceNumber_01 needs to be.
|
|
89
|
+
* @param {number} [interchangeRefNumber] The default is 1. Set this to whatever the CONTRL EdifactInterchange.UNB.InterchangeControlReference_5 needs to be.
|
|
90
|
+
* @param {boolean} [ackForValidTrans] The default is false. Set this to true if you need UCM loops included for all valid transaction as well. By default UCM loops are generated only for invalid transactions.
|
|
91
|
+
* @param {boolean} [batchAcks] The default is true. Set this to false if you need to generate separate EdifactInterchange for each acknowledgment. By default all acknowledgments are batched in the same EdifactInterchange.
|
|
92
|
+
* @param {string} [technicalAck] The default technical acknowledgment CONTRL is generated according to EdifactInterchange.UNB.AcknowledgementRequest_9. You can either enforce it to always generate technical CONTRLs or supress it to never generate any technical CONTRLs. This will override the flag in EdifactInterchange.UNB.AcknowledgementRequest_9. The available values are: default, enforce, suppress.
|
|
93
|
+
* @param {boolean} [eancomS3] The default syntax for EANCOM transactions. By default all EANCOM transactions will be validated according to the rules of Syntax 4. Set this flag to true if you need Syntax 3 to be used.
|
|
94
|
+
* @param {EdifactInterchange} [edifactInterchange] The EdifactInterchange object to acknowledge.
|
|
95
|
+
* @param {*} [options] Override http request option.
|
|
96
|
+
* @throws {RequiredError}
|
|
97
|
+
*/
|
|
98
|
+
edifactAckPost(syntaxSet?: string, detectDuplicates?: boolean, tranRefNumber?: number, interchangeRefNumber?: number, ackForValidTrans?: boolean, batchAcks?: boolean, technicalAck?: string, eancomS3?: boolean, edifactInterchange?: EdifactInterchange, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EdifactInterchange>>>;
|
|
99
|
+
/**
|
|
100
|
+
*
|
|
101
|
+
* @summary Convert EDIFACT 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 {boolean} [eancomS3] The default syntax for EANCOM transactions. By default all EANCOM transactions will be translated and validated according to the rules of Syntax 4. Set this flag to true if you need Syntax 3 to be used.
|
|
107
|
+
* @param {File} [body]
|
|
108
|
+
* @param {*} [options] Override http request option.
|
|
109
|
+
* @throws {RequiredError}
|
|
110
|
+
*/
|
|
111
|
+
edifactReadPost(ignoreNullValues?: boolean, continueOnError?: boolean, charSet?: string, model?: string, eancomS3?: boolean, body?: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EdifactInterchange>>>;
|
|
112
|
+
/**
|
|
113
|
+
*
|
|
114
|
+
* @summary Validate EDIFACT messages
|
|
115
|
+
* @param {string} [syntaxSet] In case you need to validate against a syntax set, different than UNOA and UNOB, populate this filed with all of the allowed symbols, url-escaped. All data elements with alpha (A) or alphanumeric (AN) data types are validated against a syntax set of allowed characters. The supported syntax sets are UNOA and UNOB. The validator infers the correct syntax set from EdifactInterchange.UNB.SYNTAXIDENTIFIER_1.SyntaxIdentifier_1. The symbols added to this field will override the corresponding sets in both UNOA and UNOB.
|
|
116
|
+
* @param {boolean} [skipTrailer] You are allowed to validate an EdifactInterchange with missing interchange, functional group or transaction trailers (UNZ, UNE, UNT). 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 EdifactInterchange 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 {string} [decimalPoint] This could be either point . (default) or comma ,.
|
|
119
|
+
* @param {boolean} [eancomS3] The default syntax for EANCOM transactions. By default all EANCOM transactions will be validated according to the rules of Syntax 4. Set this flag to true if you need Syntax 3 to be used.
|
|
120
|
+
* @param {EdifactInterchange} [edifactInterchange] The EdifactInterchange object to validate.
|
|
121
|
+
* @param {*} [options] Override http request option.
|
|
122
|
+
* @throws {RequiredError}
|
|
123
|
+
*/
|
|
124
|
+
edifactValidatePost(syntaxSet?: string, skipTrailer?: boolean, structureOnly?: boolean, decimalPoint?: string, eancomS3?: boolean, edifactInterchange?: EdifactInterchange, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OperationResult>>;
|
|
125
|
+
/**
|
|
126
|
+
*
|
|
127
|
+
* @summary Convert JSON to EDIFACT files
|
|
128
|
+
* @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.
|
|
129
|
+
* @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.
|
|
130
|
+
* @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.
|
|
131
|
+
* @param {boolean} [sameRepetionAndDataElement] Sometimes the same delimiter is used to denote data element separator and repetition separator as in IATA transactions. By default, this is false.
|
|
132
|
+
* @param {boolean} [eancomS3] The default syntax for EANCOM transactions. By default all EANCOM transactions will be translated and validated according to the rules of Syntax 4. Set this flag to true if you need Syntax 3 to be used.
|
|
133
|
+
* @param {EdifactInterchange} [edifactInterchange] The EdifactInterchange object to translate to raw EDIFACT.
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
*/
|
|
137
|
+
edifactWritePost(preserveWhitespace?: boolean, charSet?: string, postfix?: string, sameRepetionAndDataElement?: boolean, eancomS3?: boolean, edifactInterchange?: EdifactInterchange, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
138
|
+
};
|
|
139
|
+
/**
|
|
140
|
+
* EdifactApi - factory interface
|
|
141
|
+
* @export
|
|
142
|
+
*/
|
|
143
|
+
export declare const EdifactApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
144
|
+
/**
|
|
145
|
+
*
|
|
146
|
+
* @summary Generate EDIFACT acknowledments
|
|
147
|
+
* @param {EdifactApiEdifactAckPostRequest} requestParameters Request parameters.
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
*/
|
|
151
|
+
edifactAckPost(requestParameters?: EdifactApiEdifactAckPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<EdifactInterchange>>;
|
|
152
|
+
/**
|
|
153
|
+
*
|
|
154
|
+
* @summary Convert EDIFACT files to JSON
|
|
155
|
+
* @param {EdifactApiEdifactReadPostRequest} requestParameters Request parameters.
|
|
156
|
+
* @param {*} [options] Override http request option.
|
|
157
|
+
* @throws {RequiredError}
|
|
158
|
+
*/
|
|
159
|
+
edifactReadPost(requestParameters?: EdifactApiEdifactReadPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<EdifactInterchange>>;
|
|
160
|
+
/**
|
|
161
|
+
*
|
|
162
|
+
* @summary Validate EDIFACT messages
|
|
163
|
+
* @param {EdifactApiEdifactValidatePostRequest} requestParameters Request parameters.
|
|
164
|
+
* @param {*} [options] Override http request option.
|
|
165
|
+
* @throws {RequiredError}
|
|
166
|
+
*/
|
|
167
|
+
edifactValidatePost(requestParameters?: EdifactApiEdifactValidatePostRequest, options?: RawAxiosRequestConfig): AxiosPromise<OperationResult>;
|
|
168
|
+
/**
|
|
169
|
+
*
|
|
170
|
+
* @summary Convert JSON to EDIFACT files
|
|
171
|
+
* @param {EdifactApiEdifactWritePostRequest} requestParameters Request parameters.
|
|
172
|
+
* @param {*} [options] Override http request option.
|
|
173
|
+
* @throws {RequiredError}
|
|
174
|
+
*/
|
|
175
|
+
edifactWritePost(requestParameters?: EdifactApiEdifactWritePostRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
176
|
+
};
|
|
177
|
+
/**
|
|
178
|
+
* EdifactApi - interface
|
|
179
|
+
* @export
|
|
180
|
+
* @interface EdifactApi
|
|
181
|
+
*/
|
|
182
|
+
export interface EdifactApiInterface {
|
|
183
|
+
/**
|
|
184
|
+
*
|
|
185
|
+
* @summary Generate EDIFACT acknowledments
|
|
186
|
+
* @param {EdifactApiEdifactAckPostRequest} requestParameters Request parameters.
|
|
187
|
+
* @param {*} [options] Override http request option.
|
|
188
|
+
* @throws {RequiredError}
|
|
189
|
+
* @memberof EdifactApiInterface
|
|
190
|
+
*/
|
|
191
|
+
edifactAckPost(requestParameters?: EdifactApiEdifactAckPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<EdifactInterchange>>;
|
|
192
|
+
/**
|
|
193
|
+
*
|
|
194
|
+
* @summary Convert EDIFACT files to JSON
|
|
195
|
+
* @param {EdifactApiEdifactReadPostRequest} requestParameters Request parameters.
|
|
196
|
+
* @param {*} [options] Override http request option.
|
|
197
|
+
* @throws {RequiredError}
|
|
198
|
+
* @memberof EdifactApiInterface
|
|
199
|
+
*/
|
|
200
|
+
edifactReadPost(requestParameters?: EdifactApiEdifactReadPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<EdifactInterchange>>;
|
|
201
|
+
/**
|
|
202
|
+
*
|
|
203
|
+
* @summary Validate EDIFACT messages
|
|
204
|
+
* @param {EdifactApiEdifactValidatePostRequest} requestParameters Request parameters.
|
|
205
|
+
* @param {*} [options] Override http request option.
|
|
206
|
+
* @throws {RequiredError}
|
|
207
|
+
* @memberof EdifactApiInterface
|
|
208
|
+
*/
|
|
209
|
+
edifactValidatePost(requestParameters?: EdifactApiEdifactValidatePostRequest, options?: RawAxiosRequestConfig): AxiosPromise<OperationResult>;
|
|
210
|
+
/**
|
|
211
|
+
*
|
|
212
|
+
* @summary Convert JSON to EDIFACT files
|
|
213
|
+
* @param {EdifactApiEdifactWritePostRequest} requestParameters Request parameters.
|
|
214
|
+
* @param {*} [options] Override http request option.
|
|
215
|
+
* @throws {RequiredError}
|
|
216
|
+
* @memberof EdifactApiInterface
|
|
217
|
+
*/
|
|
218
|
+
edifactWritePost(requestParameters?: EdifactApiEdifactWritePostRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
219
|
+
}
|
|
220
|
+
/**
|
|
221
|
+
* Request parameters for edifactAckPost operation in EdifactApi.
|
|
222
|
+
* @export
|
|
223
|
+
* @interface EdifactApiEdifactAckPostRequest
|
|
224
|
+
*/
|
|
225
|
+
export interface EdifactApiEdifactAckPostRequest {
|
|
226
|
+
/**
|
|
227
|
+
* In case you need to validate against a syntax set, different than UNOA and UNOB, populate this filed with all of the allowed symbols, url-escaped. All data elements with alpha (A) or alphanumeric (AN) data types are validated against a syntax set of allowed characters. The supported syntax sets are UNOA and UNOB. The validator infers the correct syntax set from EdifactInterchange.UNB.SYNTAXIDENTIFIER_1.SyntaxIdentifier_1. The symbols added to this field will override the corresponding sets in both UNOA and UNOB.
|
|
228
|
+
* @type {string}
|
|
229
|
+
* @memberof EdifactApiEdifactAckPost
|
|
230
|
+
*/
|
|
231
|
+
readonly syntaxSet?: string;
|
|
232
|
+
/**
|
|
233
|
+
* 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.
|
|
234
|
+
* @type {boolean}
|
|
235
|
+
* @memberof EdifactApiEdifactAckPost
|
|
236
|
+
*/
|
|
237
|
+
readonly detectDuplicates?: boolean;
|
|
238
|
+
/**
|
|
239
|
+
* The default is 1. Set this to whatever the CONTRL UNH.MessageReferenceNumber_01 needs to be.
|
|
240
|
+
* @type {number}
|
|
241
|
+
* @memberof EdifactApiEdifactAckPost
|
|
242
|
+
*/
|
|
243
|
+
readonly tranRefNumber?: number;
|
|
244
|
+
/**
|
|
245
|
+
* The default is 1. Set this to whatever the CONTRL EdifactInterchange.UNB.InterchangeControlReference_5 needs to be.
|
|
246
|
+
* @type {number}
|
|
247
|
+
* @memberof EdifactApiEdifactAckPost
|
|
248
|
+
*/
|
|
249
|
+
readonly interchangeRefNumber?: number;
|
|
250
|
+
/**
|
|
251
|
+
* The default is false. Set this to true if you need UCM loops included for all valid transaction as well. By default UCM loops are generated only for invalid transactions.
|
|
252
|
+
* @type {boolean}
|
|
253
|
+
* @memberof EdifactApiEdifactAckPost
|
|
254
|
+
*/
|
|
255
|
+
readonly ackForValidTrans?: boolean;
|
|
256
|
+
/**
|
|
257
|
+
* The default is true. Set this to false if you need to generate separate EdifactInterchange for each acknowledgment. By default all acknowledgments are batched in the same EdifactInterchange.
|
|
258
|
+
* @type {boolean}
|
|
259
|
+
* @memberof EdifactApiEdifactAckPost
|
|
260
|
+
*/
|
|
261
|
+
readonly batchAcks?: boolean;
|
|
262
|
+
/**
|
|
263
|
+
* The default technical acknowledgment CONTRL is generated according to EdifactInterchange.UNB.AcknowledgementRequest_9. You can either enforce it to always generate technical CONTRLs or supress it to never generate any technical CONTRLs. This will override the flag in EdifactInterchange.UNB.AcknowledgementRequest_9. The available values are: default, enforce, suppress.
|
|
264
|
+
* @type {string}
|
|
265
|
+
* @memberof EdifactApiEdifactAckPost
|
|
266
|
+
*/
|
|
267
|
+
readonly technicalAck?: string;
|
|
268
|
+
/**
|
|
269
|
+
* The default syntax for EANCOM transactions. By default all EANCOM transactions will be validated according to the rules of Syntax 4. Set this flag to true if you need Syntax 3 to be used.
|
|
270
|
+
* @type {boolean}
|
|
271
|
+
* @memberof EdifactApiEdifactAckPost
|
|
272
|
+
*/
|
|
273
|
+
readonly eancomS3?: boolean;
|
|
274
|
+
/**
|
|
275
|
+
* The EdifactInterchange object to acknowledge.
|
|
276
|
+
* @type {EdifactInterchange}
|
|
277
|
+
* @memberof EdifactApiEdifactAckPost
|
|
278
|
+
*/
|
|
279
|
+
readonly edifactInterchange?: EdifactInterchange;
|
|
280
|
+
}
|
|
281
|
+
/**
|
|
282
|
+
* Request parameters for edifactReadPost operation in EdifactApi.
|
|
283
|
+
* @export
|
|
284
|
+
* @interface EdifactApiEdifactReadPostRequest
|
|
285
|
+
*/
|
|
286
|
+
export interface EdifactApiEdifactReadPostRequest {
|
|
287
|
+
/**
|
|
288
|
+
* Whether to ignore all null values in the response. The default is false.
|
|
289
|
+
* @type {boolean}
|
|
290
|
+
* @memberof EdifactApiEdifactReadPost
|
|
291
|
+
*/
|
|
292
|
+
readonly ignoreNullValues?: boolean;
|
|
293
|
+
/**
|
|
294
|
+
* Whether to continue reading if a corrupt interchange is encountered. The default is false.
|
|
295
|
+
* @type {boolean}
|
|
296
|
+
* @memberof EdifactApiEdifactReadPost
|
|
297
|
+
*/
|
|
298
|
+
readonly continueOnError?: boolean;
|
|
299
|
+
/**
|
|
300
|
+
* 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.
|
|
301
|
+
* @type {string}
|
|
302
|
+
* @memberof EdifactApiEdifactReadPost
|
|
303
|
+
*/
|
|
304
|
+
readonly charSet?: string;
|
|
305
|
+
/**
|
|
306
|
+
* The model to use. By default, the API will infer the model based on the transaction and version identifiers.
|
|
307
|
+
* @type {string}
|
|
308
|
+
* @memberof EdifactApiEdifactReadPost
|
|
309
|
+
*/
|
|
310
|
+
readonly model?: string;
|
|
311
|
+
/**
|
|
312
|
+
* The default syntax for EANCOM transactions. By default all EANCOM transactions will be translated and validated according to the rules of Syntax 4. Set this flag to true if you need Syntax 3 to be used.
|
|
313
|
+
* @type {boolean}
|
|
314
|
+
* @memberof EdifactApiEdifactReadPost
|
|
315
|
+
*/
|
|
316
|
+
readonly eancomS3?: boolean;
|
|
317
|
+
/**
|
|
318
|
+
*
|
|
319
|
+
* @type {File}
|
|
320
|
+
* @memberof EdifactApiEdifactReadPost
|
|
321
|
+
*/
|
|
322
|
+
readonly body?: File;
|
|
323
|
+
}
|
|
324
|
+
/**
|
|
325
|
+
* Request parameters for edifactValidatePost operation in EdifactApi.
|
|
326
|
+
* @export
|
|
327
|
+
* @interface EdifactApiEdifactValidatePostRequest
|
|
328
|
+
*/
|
|
329
|
+
export interface EdifactApiEdifactValidatePostRequest {
|
|
330
|
+
/**
|
|
331
|
+
* In case you need to validate against a syntax set, different than UNOA and UNOB, populate this filed with all of the allowed symbols, url-escaped. All data elements with alpha (A) or alphanumeric (AN) data types are validated against a syntax set of allowed characters. The supported syntax sets are UNOA and UNOB. The validator infers the correct syntax set from EdifactInterchange.UNB.SYNTAXIDENTIFIER_1.SyntaxIdentifier_1. The symbols added to this field will override the corresponding sets in both UNOA and UNOB.
|
|
332
|
+
* @type {string}
|
|
333
|
+
* @memberof EdifactApiEdifactValidatePost
|
|
334
|
+
*/
|
|
335
|
+
readonly syntaxSet?: string;
|
|
336
|
+
/**
|
|
337
|
+
* You are allowed to validate an EdifactInterchange with missing interchange, functional group or transaction trailers (UNZ, UNE, UNT). 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 EdifactInterchange and by default, this is set to false. To skip all trailer validation, set this to true.
|
|
338
|
+
* @type {boolean}
|
|
339
|
+
* @memberof EdifactApiEdifactValidatePost
|
|
340
|
+
*/
|
|
341
|
+
readonly skipTrailer?: boolean;
|
|
342
|
+
/**
|
|
343
|
+
* 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.
|
|
344
|
+
* @type {boolean}
|
|
345
|
+
* @memberof EdifactApiEdifactValidatePost
|
|
346
|
+
*/
|
|
347
|
+
readonly structureOnly?: boolean;
|
|
348
|
+
/**
|
|
349
|
+
* This could be either point . (default) or comma ,.
|
|
350
|
+
* @type {string}
|
|
351
|
+
* @memberof EdifactApiEdifactValidatePost
|
|
352
|
+
*/
|
|
353
|
+
readonly decimalPoint?: string;
|
|
354
|
+
/**
|
|
355
|
+
* The default syntax for EANCOM transactions. By default all EANCOM transactions will be validated according to the rules of Syntax 4. Set this flag to true if you need Syntax 3 to be used.
|
|
356
|
+
* @type {boolean}
|
|
357
|
+
* @memberof EdifactApiEdifactValidatePost
|
|
358
|
+
*/
|
|
359
|
+
readonly eancomS3?: boolean;
|
|
360
|
+
/**
|
|
361
|
+
* The EdifactInterchange object to validate.
|
|
362
|
+
* @type {EdifactInterchange}
|
|
363
|
+
* @memberof EdifactApiEdifactValidatePost
|
|
364
|
+
*/
|
|
365
|
+
readonly edifactInterchange?: EdifactInterchange;
|
|
366
|
+
}
|
|
367
|
+
/**
|
|
368
|
+
* Request parameters for edifactWritePost operation in EdifactApi.
|
|
369
|
+
* @export
|
|
370
|
+
* @interface EdifactApiEdifactWritePostRequest
|
|
371
|
+
*/
|
|
372
|
+
export interface EdifactApiEdifactWritePostRequest {
|
|
373
|
+
/**
|
|
374
|
+
* Whether to preserve blank data elements so the output contains multiple delimiters instead of omitting any excess delimiters. The default is false.
|
|
375
|
+
* @type {boolean}
|
|
376
|
+
* @memberof EdifactApiEdifactWritePost
|
|
377
|
+
*/
|
|
378
|
+
readonly preserveWhitespace?: boolean;
|
|
379
|
+
/**
|
|
380
|
+
* 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.
|
|
381
|
+
* @type {string}
|
|
382
|
+
* @memberof EdifactApiEdifactWritePost
|
|
383
|
+
*/
|
|
384
|
+
readonly charSet?: string;
|
|
385
|
+
/**
|
|
386
|
+
* 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.
|
|
387
|
+
* @type {string}
|
|
388
|
+
* @memberof EdifactApiEdifactWritePost
|
|
389
|
+
*/
|
|
390
|
+
readonly postfix?: string;
|
|
391
|
+
/**
|
|
392
|
+
* Sometimes the same delimiter is used to denote data element separator and repetition separator as in IATA transactions. By default, this is false.
|
|
393
|
+
* @type {boolean}
|
|
394
|
+
* @memberof EdifactApiEdifactWritePost
|
|
395
|
+
*/
|
|
396
|
+
readonly sameRepetionAndDataElement?: boolean;
|
|
397
|
+
/**
|
|
398
|
+
* The default syntax for EANCOM transactions. By default all EANCOM transactions will be translated and validated according to the rules of Syntax 4. Set this flag to true if you need Syntax 3 to be used.
|
|
399
|
+
* @type {boolean}
|
|
400
|
+
* @memberof EdifactApiEdifactWritePost
|
|
401
|
+
*/
|
|
402
|
+
readonly eancomS3?: boolean;
|
|
403
|
+
/**
|
|
404
|
+
* The EdifactInterchange object to translate to raw EDIFACT.
|
|
405
|
+
* @type {EdifactInterchange}
|
|
406
|
+
* @memberof EdifactApiEdifactWritePost
|
|
407
|
+
*/
|
|
408
|
+
readonly edifactInterchange?: EdifactInterchange;
|
|
409
|
+
}
|
|
410
|
+
/**
|
|
411
|
+
* EdifactApi - object-oriented interface
|
|
412
|
+
* @export
|
|
413
|
+
* @class EdifactApi
|
|
414
|
+
* @extends {BaseAPI}
|
|
415
|
+
*/
|
|
416
|
+
export declare class EdifactApi extends BaseAPI implements EdifactApiInterface {
|
|
417
|
+
/**
|
|
418
|
+
*
|
|
419
|
+
* @summary Generate EDIFACT acknowledments
|
|
420
|
+
* @param {EdifactApiEdifactAckPostRequest} requestParameters Request parameters.
|
|
421
|
+
* @param {*} [options] Override http request option.
|
|
422
|
+
* @throws {RequiredError}
|
|
423
|
+
* @memberof EdifactApi
|
|
424
|
+
*/
|
|
425
|
+
edifactAckPost(requestParameters?: EdifactApiEdifactAckPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EdifactInterchange[], any, {}>>;
|
|
426
|
+
/**
|
|
427
|
+
*
|
|
428
|
+
* @summary Convert EDIFACT files to JSON
|
|
429
|
+
* @param {EdifactApiEdifactReadPostRequest} requestParameters Request parameters.
|
|
430
|
+
* @param {*} [options] Override http request option.
|
|
431
|
+
* @throws {RequiredError}
|
|
432
|
+
* @memberof EdifactApi
|
|
433
|
+
*/
|
|
434
|
+
edifactReadPost(requestParameters?: EdifactApiEdifactReadPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EdifactInterchange[], any, {}>>;
|
|
435
|
+
/**
|
|
436
|
+
*
|
|
437
|
+
* @summary Validate EDIFACT messages
|
|
438
|
+
* @param {EdifactApiEdifactValidatePostRequest} requestParameters Request parameters.
|
|
439
|
+
* @param {*} [options] Override http request option.
|
|
440
|
+
* @throws {RequiredError}
|
|
441
|
+
* @memberof EdifactApi
|
|
442
|
+
*/
|
|
443
|
+
edifactValidatePost(requestParameters?: EdifactApiEdifactValidatePostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OperationResult, any, {}>>;
|
|
444
|
+
/**
|
|
445
|
+
*
|
|
446
|
+
* @summary Convert JSON to EDIFACT files
|
|
447
|
+
* @param {EdifactApiEdifactWritePostRequest} requestParameters Request parameters.
|
|
448
|
+
* @param {*} [options] Override http request option.
|
|
449
|
+
* @throws {RequiredError}
|
|
450
|
+
* @memberof EdifactApi
|
|
451
|
+
*/
|
|
452
|
+
edifactWritePost(requestParameters?: EdifactApiEdifactWritePostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
453
|
+
}
|