Generated from cc6d11e5d9e61c097fe7e4ebd21883fa1f8dd860 (#4275)

typo: logic/resource-manager/Microsoft.Logic

- conetnt -> content
This commit is contained in:
Azure SDK for Python bot 2018-12-03 09:58:36 -08:00 коммит произвёл GitHub
Родитель 314d083e17
Коммит d9ee9b3b11
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
142 изменённых файлов: 5221 добавлений и 10554 удалений

Просмотреть файл

@ -3,22 +3,23 @@ uid: azure-arm-logic
summary: *content summary: *content
--- ---
# Microsoft Azure SDK for Node.js - LogicManagementClient **This SDK will be deprecated next year and will be replaced by a new TypeScript-based isomorphic SDK (found at https://github.com/Azure/azure-sdk-for-js) which works on Node.js and browsers.**
## Microsoft Azure SDK for Node.js - LogicManagementClient
This project provides a Node.js package for accessing Azure. Right now it supports: This project provides a Node.js package for accessing Azure. Right now it supports:
- **Node.js version 6.x.x or higher** - **Node.js version 6.x.x or higher**
## Features ### Features
## How to Install ### How to Install
```bash ```bash
npm install azure-arm-logic npm install azure-arm-logic
``` ```
## How to use ### How to use
### Authentication, client creation and listBySubscription workflows as an example. #### Authentication, client creation and listBySubscription workflows as an example.
```javascript ```javascript
const msRestAzure = require("ms-rest-azure"); const msRestAzure = require("ms-rest-azure");
@ -37,6 +38,6 @@ msRestAzure.interactiveLogin().then((creds) => {
console.dir(err, {depth: null, colors: true}); console.dir(err, {depth: null, colors: true});
}); });
## Related projects ### Related projects
- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node) - [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node)

Просмотреть файл

@ -17,14 +17,14 @@
class AS2AcknowledgementConnectionSettings { class AS2AcknowledgementConnectionSettings {
/** /**
* Create a AS2AcknowledgementConnectionSettings. * Create a AS2AcknowledgementConnectionSettings.
* @member {boolean} ignoreCertificateNameMismatch The value indicating * @property {boolean} ignoreCertificateNameMismatch The value indicating
* whether to ignore mismatch in certificate name. * whether to ignore mismatch in certificate name.
* @member {boolean} supportHttpStatusCodeContinue The value indicating * @property {boolean} supportHttpStatusCodeContinue The value indicating
* whether to support HTTP status code 'CONTINUE'. * whether to support HTTP status code 'CONTINUE'.
* @member {boolean} keepHttpConnectionAlive The value indicating whether to * @property {boolean} keepHttpConnectionAlive The value indicating whether
* keep the connection alive. * to keep the connection alive.
* @member {boolean} unfoldHttpHeaders The value indicating whether to unfold * @property {boolean} unfoldHttpHeaders The value indicating whether to
* the HTTP headers. * unfold the HTTP headers.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,340 +17,342 @@
class AS2AgreementContent { class AS2AgreementContent {
/** /**
* Create a AS2AgreementContent. * Create a AS2AgreementContent.
* @member {object} receiveAgreement The AS2 one-way receive agreement. * @property {object} receiveAgreement The AS2 one-way receive agreement.
* @member {object} [receiveAgreement.senderBusinessIdentity] The sender * @property {object} [receiveAgreement.senderBusinessIdentity] The sender
* business identity * business identity
* @member {string} [receiveAgreement.senderBusinessIdentity.qualifier] The * @property {string} [receiveAgreement.senderBusinessIdentity.qualifier] The
* business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32
* @member {string} [receiveAgreement.senderBusinessIdentity.value] The user * @property {string} [receiveAgreement.senderBusinessIdentity.value] The
* defined business identity value.
* @member {object} [receiveAgreement.receiverBusinessIdentity] The receiver
* business identity
* @member {string} [receiveAgreement.receiverBusinessIdentity.qualifier] The
* business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32
* @member {string} [receiveAgreement.receiverBusinessIdentity.value] The
* user defined business identity value. * user defined business identity value.
* @member {object} [receiveAgreement.protocolSettings] The AS2 protocol * @property {object} [receiveAgreement.receiverBusinessIdentity] The
* receiver business identity
* @property {string} [receiveAgreement.receiverBusinessIdentity.qualifier]
* The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32
* @property {string} [receiveAgreement.receiverBusinessIdentity.value] The
* user defined business identity value.
* @property {object} [receiveAgreement.protocolSettings] The AS2 protocol
* settings. * settings.
* @member {object} * @property {object}
* [receiveAgreement.protocolSettings.messageConnectionSettings] The message * [receiveAgreement.protocolSettings.messageConnectionSettings] The message
* connection settings. * connection settings.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch] * [receiveAgreement.protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch]
* The value indicating whether to ignore mismatch in certificate name. * The value indicating whether to ignore mismatch in certificate name.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue] * [receiveAgreement.protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue]
* The value indicating whether to support HTTP status code 'CONTINUE'. * The value indicating whether to support HTTP status code 'CONTINUE'.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.messageConnectionSettings.keepHttpConnectionAlive] * [receiveAgreement.protocolSettings.messageConnectionSettings.keepHttpConnectionAlive]
* The value indicating whether to keep the connection alive. * The value indicating whether to keep the connection alive.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.messageConnectionSettings.unfoldHttpHeaders] * [receiveAgreement.protocolSettings.messageConnectionSettings.unfoldHttpHeaders]
* The value indicating whether to unfold the HTTP headers. * The value indicating whether to unfold the HTTP headers.
* @member {object} * @property {object}
* [receiveAgreement.protocolSettings.acknowledgementConnectionSettings] The * [receiveAgreement.protocolSettings.acknowledgementConnectionSettings] The
* acknowledgement connection settings. * acknowledgement connection settings.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch] * [receiveAgreement.protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch]
* The value indicating whether to ignore mismatch in certificate name. * The value indicating whether to ignore mismatch in certificate name.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue] * [receiveAgreement.protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue]
* The value indicating whether to support HTTP status code 'CONTINUE'. * The value indicating whether to support HTTP status code 'CONTINUE'.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive] * [receiveAgreement.protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive]
* The value indicating whether to keep the connection alive. * The value indicating whether to keep the connection alive.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders] * [receiveAgreement.protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders]
* The value indicating whether to unfold the HTTP headers. * The value indicating whether to unfold the HTTP headers.
* @member {object} [receiveAgreement.protocolSettings.mdnSettings] The MDN * @property {object} [receiveAgreement.protocolSettings.mdnSettings] The MDN
* settings. * settings.
* @member {boolean} [receiveAgreement.protocolSettings.mdnSettings.needMdn] * @property {boolean}
* The value indicating whether to send or request a MDN. * [receiveAgreement.protocolSettings.mdnSettings.needMdn] The value
* @member {boolean} [receiveAgreement.protocolSettings.mdnSettings.signMdn] * indicating whether to send or request a MDN.
* The value indicating whether the MDN needs to be signed or not. * @property {boolean}
* @member {boolean} * [receiveAgreement.protocolSettings.mdnSettings.signMdn] The value
* indicating whether the MDN needs to be signed or not.
* @property {boolean}
* [receiveAgreement.protocolSettings.mdnSettings.sendMdnAsynchronously] The * [receiveAgreement.protocolSettings.mdnSettings.sendMdnAsynchronously] The
* value indicating whether to send the asynchronous MDN. * value indicating whether to send the asynchronous MDN.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.mdnSettings.receiptDeliveryUrl] The * [receiveAgreement.protocolSettings.mdnSettings.receiptDeliveryUrl] The
* receipt delivery URL. * receipt delivery URL.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.mdnSettings.dispositionNotificationTo] * [receiveAgreement.protocolSettings.mdnSettings.dispositionNotificationTo]
* The disposition notification to header value. * The disposition notification to header value.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.mdnSettings.signOutboundMdnIfOptional] * [receiveAgreement.protocolSettings.mdnSettings.signOutboundMdnIfOptional]
* The value indicating whether to sign the outbound MDN if optional. * The value indicating whether to sign the outbound MDN if optional.
* @member {string} [receiveAgreement.protocolSettings.mdnSettings.mdnText] * @property {string} [receiveAgreement.protocolSettings.mdnSettings.mdnText]
* The MDN text. * The MDN text.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.mdnSettings.sendInboundMdnToMessageBox] * [receiveAgreement.protocolSettings.mdnSettings.sendInboundMdnToMessageBox]
* The value indicating whether to send inbound MDN to message box. * The value indicating whether to send inbound MDN to message box.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.mdnSettings.micHashingAlgorithm] The * [receiveAgreement.protocolSettings.mdnSettings.micHashingAlgorithm] The
* signing or hashing algorithm. Possible values include: 'NotSpecified', * signing or hashing algorithm. Possible values include: 'NotSpecified',
* 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' * 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512'
* @member {object} [receiveAgreement.protocolSettings.securitySettings] The * @property {object} [receiveAgreement.protocolSettings.securitySettings]
* security settings. * The security settings.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.securitySettings.overrideGroupSigningCertificate] * [receiveAgreement.protocolSettings.securitySettings.overrideGroupSigningCertificate]
* The value indicating whether to send or request a MDN. * The value indicating whether to send or request a MDN.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.securitySettings.signingCertificateName] * [receiveAgreement.protocolSettings.securitySettings.signingCertificateName]
* The name of the signing certificate. * The name of the signing certificate.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.securitySettings.encryptionCertificateName] * [receiveAgreement.protocolSettings.securitySettings.encryptionCertificateName]
* The name of the encryption certificate. * The name of the encryption certificate.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundEncodedMessages] * [receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundEncodedMessages]
* The value indicating whether to enable NRR for inbound encoded messages. * The value indicating whether to enable NRR for inbound encoded messages.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundDecodedMessages] * [receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundDecodedMessages]
* The value indicating whether to enable NRR for inbound decoded messages. * The value indicating whether to enable NRR for inbound decoded messages.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundMdn] * [receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundMdn]
* The value indicating whether to enable NRR for outbound MDN. * The value indicating whether to enable NRR for outbound MDN.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages] * [receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages]
* The value indicating whether to enable NRR for outbound encoded messages. * The value indicating whether to enable NRR for outbound encoded messages.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages] * [receiveAgreement.protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages]
* The value indicating whether to enable NRR for outbound decoded messages. * The value indicating whether to enable NRR for outbound decoded messages.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundMdn] * [receiveAgreement.protocolSettings.securitySettings.enableNrrForInboundMdn]
* The value indicating whether to enable NRR for inbound MDN. * The value indicating whether to enable NRR for inbound MDN.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.securitySettings.sha2AlgorithmFormat] * [receiveAgreement.protocolSettings.securitySettings.sha2AlgorithmFormat]
* The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, * The Sha2 algorithm format. Valid values are Sha2, ShaHashSize,
* ShaHyphenHashSize, Sha2UnderscoreHashSize. * ShaHyphenHashSize, Sha2UnderscoreHashSize.
* @member {object} [receiveAgreement.protocolSettings.validationSettings] * @property {object} [receiveAgreement.protocolSettings.validationSettings]
* The validation settings. * The validation settings.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.validationSettings.overrideMessageProperties] * [receiveAgreement.protocolSettings.validationSettings.overrideMessageProperties]
* The value indicating whether to override incoming message properties with * The value indicating whether to override incoming message properties with
* those in agreement. * those in agreement.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.validationSettings.encryptMessage] The * [receiveAgreement.protocolSettings.validationSettings.encryptMessage] The
* value indicating whether the message has to be encrypted. * value indicating whether the message has to be encrypted.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.validationSettings.signMessage] The * [receiveAgreement.protocolSettings.validationSettings.signMessage] The
* value indicating whether the message has to be signed. * value indicating whether the message has to be signed.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.validationSettings.compressMessage] The * [receiveAgreement.protocolSettings.validationSettings.compressMessage] The
* value indicating whether the message has to be compressed. * value indicating whether the message has to be compressed.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.validationSettings.checkDuplicateMessage] * [receiveAgreement.protocolSettings.validationSettings.checkDuplicateMessage]
* The value indicating whether to check for duplicate message. * The value indicating whether to check for duplicate message.
* @member {number} * @property {number}
* [receiveAgreement.protocolSettings.validationSettings.interchangeDuplicatesValidityDays] * [receiveAgreement.protocolSettings.validationSettings.interchangeDuplicatesValidityDays]
* The number of days to look back for duplicate interchange. * The number of days to look back for duplicate interchange.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnSend] * [receiveAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnSend]
* The value indicating whether to check for certificate revocation list on * The value indicating whether to check for certificate revocation list on
* send. * send.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnReceive] * [receiveAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnReceive]
* The value indicating whether to check for certificate revocation list on * The value indicating whether to check for certificate revocation list on
* receive. * receive.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.validationSettings.encryptionAlgorithm] * [receiveAgreement.protocolSettings.validationSettings.encryptionAlgorithm]
* The encryption algorithm. Possible values include: 'NotSpecified', 'None', * The encryption algorithm. Possible values include: 'NotSpecified', 'None',
* 'DES3', 'RC2', 'AES128', 'AES192', 'AES256' * 'DES3', 'RC2', 'AES128', 'AES192', 'AES256'
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.validationSettings.signingAlgorithm] * [receiveAgreement.protocolSettings.validationSettings.signingAlgorithm]
* The signing algorithm. Possible values include: 'NotSpecified', 'Default', * The signing algorithm. Possible values include: 'NotSpecified', 'Default',
* 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512'
* @member {object} [receiveAgreement.protocolSettings.envelopeSettings] The * @property {object} [receiveAgreement.protocolSettings.envelopeSettings]
* envelope settings. * The envelope settings.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.messageContentType] * [receiveAgreement.protocolSettings.envelopeSettings.messageContentType]
* The message content type. * The message content type.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.envelopeSettings.transmitFileNameInMimeHeader] * [receiveAgreement.protocolSettings.envelopeSettings.transmitFileNameInMimeHeader]
* The value indicating whether to transmit file name in mime header. * The value indicating whether to transmit file name in mime header.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.fileNameTemplate] The * [receiveAgreement.protocolSettings.envelopeSettings.fileNameTemplate] The
* template for file name. * template for file name.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError] * [receiveAgreement.protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError]
* The value indicating whether to suspend message on file name generation * The value indicating whether to suspend message on file name generation
* error. * error.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.envelopeSettings.autogenerateFileName] * [receiveAgreement.protocolSettings.envelopeSettings.autogenerateFileName]
* The value indicating whether to auto generate file name. * The value indicating whether to auto generate file name.
* @member {object} [receiveAgreement.protocolSettings.errorSettings] The * @property {object} [receiveAgreement.protocolSettings.errorSettings] The
* error settings. * error settings.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.errorSettings.suspendDuplicateMessage] * [receiveAgreement.protocolSettings.errorSettings.suspendDuplicateMessage]
* The value indicating whether to suspend duplicate message. * The value indicating whether to suspend duplicate message.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.errorSettings.resendIfMdnNotReceived] * [receiveAgreement.protocolSettings.errorSettings.resendIfMdnNotReceived]
* The value indicating whether to resend message If MDN is not received. * The value indicating whether to resend message If MDN is not received.
* @member {object} sendAgreement The AS2 one-way send agreement. * @property {object} sendAgreement The AS2 one-way send agreement.
* @member {object} [sendAgreement.senderBusinessIdentity] The sender * @property {object} [sendAgreement.senderBusinessIdentity] The sender
* business identity * business identity
* @member {string} [sendAgreement.senderBusinessIdentity.qualifier] The * @property {string} [sendAgreement.senderBusinessIdentity.qualifier] The
* business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32
* @member {string} [sendAgreement.senderBusinessIdentity.value] The user * @property {string} [sendAgreement.senderBusinessIdentity.value] The user
* defined business identity value. * defined business identity value.
* @member {object} [sendAgreement.receiverBusinessIdentity] The receiver * @property {object} [sendAgreement.receiverBusinessIdentity] The receiver
* business identity * business identity
* @member {string} [sendAgreement.receiverBusinessIdentity.qualifier] The * @property {string} [sendAgreement.receiverBusinessIdentity.qualifier] The
* business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32
* @member {string} [sendAgreement.receiverBusinessIdentity.value] The user * @property {string} [sendAgreement.receiverBusinessIdentity.value] The user
* defined business identity value. * defined business identity value.
* @member {object} [sendAgreement.protocolSettings] The AS2 protocol * @property {object} [sendAgreement.protocolSettings] The AS2 protocol
* settings. * settings.
* @member {object} * @property {object}
* [sendAgreement.protocolSettings.messageConnectionSettings] The message * [sendAgreement.protocolSettings.messageConnectionSettings] The message
* connection settings. * connection settings.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch] * [sendAgreement.protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch]
* The value indicating whether to ignore mismatch in certificate name. * The value indicating whether to ignore mismatch in certificate name.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue] * [sendAgreement.protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue]
* The value indicating whether to support HTTP status code 'CONTINUE'. * The value indicating whether to support HTTP status code 'CONTINUE'.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.messageConnectionSettings.keepHttpConnectionAlive] * [sendAgreement.protocolSettings.messageConnectionSettings.keepHttpConnectionAlive]
* The value indicating whether to keep the connection alive. * The value indicating whether to keep the connection alive.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.messageConnectionSettings.unfoldHttpHeaders] * [sendAgreement.protocolSettings.messageConnectionSettings.unfoldHttpHeaders]
* The value indicating whether to unfold the HTTP headers. * The value indicating whether to unfold the HTTP headers.
* @member {object} * @property {object}
* [sendAgreement.protocolSettings.acknowledgementConnectionSettings] The * [sendAgreement.protocolSettings.acknowledgementConnectionSettings] The
* acknowledgement connection settings. * acknowledgement connection settings.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch] * [sendAgreement.protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch]
* The value indicating whether to ignore mismatch in certificate name. * The value indicating whether to ignore mismatch in certificate name.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue] * [sendAgreement.protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue]
* The value indicating whether to support HTTP status code 'CONTINUE'. * The value indicating whether to support HTTP status code 'CONTINUE'.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive] * [sendAgreement.protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive]
* The value indicating whether to keep the connection alive. * The value indicating whether to keep the connection alive.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders] * [sendAgreement.protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders]
* The value indicating whether to unfold the HTTP headers. * The value indicating whether to unfold the HTTP headers.
* @member {object} [sendAgreement.protocolSettings.mdnSettings] The MDN * @property {object} [sendAgreement.protocolSettings.mdnSettings] The MDN
* settings. * settings.
* @member {boolean} [sendAgreement.protocolSettings.mdnSettings.needMdn] The * @property {boolean} [sendAgreement.protocolSettings.mdnSettings.needMdn]
* value indicating whether to send or request a MDN. * The value indicating whether to send or request a MDN.
* @member {boolean} [sendAgreement.protocolSettings.mdnSettings.signMdn] The * @property {boolean} [sendAgreement.protocolSettings.mdnSettings.signMdn]
* value indicating whether the MDN needs to be signed or not. * The value indicating whether the MDN needs to be signed or not.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.mdnSettings.sendMdnAsynchronously] The * [sendAgreement.protocolSettings.mdnSettings.sendMdnAsynchronously] The
* value indicating whether to send the asynchronous MDN. * value indicating whether to send the asynchronous MDN.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.mdnSettings.receiptDeliveryUrl] The * [sendAgreement.protocolSettings.mdnSettings.receiptDeliveryUrl] The
* receipt delivery URL. * receipt delivery URL.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.mdnSettings.dispositionNotificationTo] The * [sendAgreement.protocolSettings.mdnSettings.dispositionNotificationTo] The
* disposition notification to header value. * disposition notification to header value.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.mdnSettings.signOutboundMdnIfOptional] The * [sendAgreement.protocolSettings.mdnSettings.signOutboundMdnIfOptional] The
* value indicating whether to sign the outbound MDN if optional. * value indicating whether to sign the outbound MDN if optional.
* @member {string} [sendAgreement.protocolSettings.mdnSettings.mdnText] The * @property {string} [sendAgreement.protocolSettings.mdnSettings.mdnText]
* MDN text. * The MDN text.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.mdnSettings.sendInboundMdnToMessageBox] * [sendAgreement.protocolSettings.mdnSettings.sendInboundMdnToMessageBox]
* The value indicating whether to send inbound MDN to message box. * The value indicating whether to send inbound MDN to message box.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.mdnSettings.micHashingAlgorithm] The * [sendAgreement.protocolSettings.mdnSettings.micHashingAlgorithm] The
* signing or hashing algorithm. Possible values include: 'NotSpecified', * signing or hashing algorithm. Possible values include: 'NotSpecified',
* 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' * 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512'
* @member {object} [sendAgreement.protocolSettings.securitySettings] The * @property {object} [sendAgreement.protocolSettings.securitySettings] The
* security settings. * security settings.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.securitySettings.overrideGroupSigningCertificate] * [sendAgreement.protocolSettings.securitySettings.overrideGroupSigningCertificate]
* The value indicating whether to send or request a MDN. * The value indicating whether to send or request a MDN.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.securitySettings.signingCertificateName] * [sendAgreement.protocolSettings.securitySettings.signingCertificateName]
* The name of the signing certificate. * The name of the signing certificate.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.securitySettings.encryptionCertificateName] * [sendAgreement.protocolSettings.securitySettings.encryptionCertificateName]
* The name of the encryption certificate. * The name of the encryption certificate.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.securitySettings.enableNrrForInboundEncodedMessages] * [sendAgreement.protocolSettings.securitySettings.enableNrrForInboundEncodedMessages]
* The value indicating whether to enable NRR for inbound encoded messages. * The value indicating whether to enable NRR for inbound encoded messages.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.securitySettings.enableNrrForInboundDecodedMessages] * [sendAgreement.protocolSettings.securitySettings.enableNrrForInboundDecodedMessages]
* The value indicating whether to enable NRR for inbound decoded messages. * The value indicating whether to enable NRR for inbound decoded messages.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundMdn] * [sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundMdn]
* The value indicating whether to enable NRR for outbound MDN. * The value indicating whether to enable NRR for outbound MDN.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages] * [sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages]
* The value indicating whether to enable NRR for outbound encoded messages. * The value indicating whether to enable NRR for outbound encoded messages.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages] * [sendAgreement.protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages]
* The value indicating whether to enable NRR for outbound decoded messages. * The value indicating whether to enable NRR for outbound decoded messages.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.securitySettings.enableNrrForInboundMdn] * [sendAgreement.protocolSettings.securitySettings.enableNrrForInboundMdn]
* The value indicating whether to enable NRR for inbound MDN. * The value indicating whether to enable NRR for inbound MDN.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.securitySettings.sha2AlgorithmFormat] The * [sendAgreement.protocolSettings.securitySettings.sha2AlgorithmFormat] The
* Sha2 algorithm format. Valid values are Sha2, ShaHashSize, * Sha2 algorithm format. Valid values are Sha2, ShaHashSize,
* ShaHyphenHashSize, Sha2UnderscoreHashSize. * ShaHyphenHashSize, Sha2UnderscoreHashSize.
* @member {object} [sendAgreement.protocolSettings.validationSettings] The * @property {object} [sendAgreement.protocolSettings.validationSettings] The
* validation settings. * validation settings.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.validationSettings.overrideMessageProperties] * [sendAgreement.protocolSettings.validationSettings.overrideMessageProperties]
* The value indicating whether to override incoming message properties with * The value indicating whether to override incoming message properties with
* those in agreement. * those in agreement.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.validationSettings.encryptMessage] The * [sendAgreement.protocolSettings.validationSettings.encryptMessage] The
* value indicating whether the message has to be encrypted. * value indicating whether the message has to be encrypted.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.validationSettings.signMessage] The value * [sendAgreement.protocolSettings.validationSettings.signMessage] The value
* indicating whether the message has to be signed. * indicating whether the message has to be signed.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.validationSettings.compressMessage] The * [sendAgreement.protocolSettings.validationSettings.compressMessage] The
* value indicating whether the message has to be compressed. * value indicating whether the message has to be compressed.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.validationSettings.checkDuplicateMessage] * [sendAgreement.protocolSettings.validationSettings.checkDuplicateMessage]
* The value indicating whether to check for duplicate message. * The value indicating whether to check for duplicate message.
* @member {number} * @property {number}
* [sendAgreement.protocolSettings.validationSettings.interchangeDuplicatesValidityDays] * [sendAgreement.protocolSettings.validationSettings.interchangeDuplicatesValidityDays]
* The number of days to look back for duplicate interchange. * The number of days to look back for duplicate interchange.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnSend] * [sendAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnSend]
* The value indicating whether to check for certificate revocation list on * The value indicating whether to check for certificate revocation list on
* send. * send.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnReceive] * [sendAgreement.protocolSettings.validationSettings.checkCertificateRevocationListOnReceive]
* The value indicating whether to check for certificate revocation list on * The value indicating whether to check for certificate revocation list on
* receive. * receive.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.validationSettings.encryptionAlgorithm] * [sendAgreement.protocolSettings.validationSettings.encryptionAlgorithm]
* The encryption algorithm. Possible values include: 'NotSpecified', 'None', * The encryption algorithm. Possible values include: 'NotSpecified', 'None',
* 'DES3', 'RC2', 'AES128', 'AES192', 'AES256' * 'DES3', 'RC2', 'AES128', 'AES192', 'AES256'
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.validationSettings.signingAlgorithm] The * [sendAgreement.protocolSettings.validationSettings.signingAlgorithm] The
* signing algorithm. Possible values include: 'NotSpecified', 'Default', * signing algorithm. Possible values include: 'NotSpecified', 'Default',
* 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512'
* @member {object} [sendAgreement.protocolSettings.envelopeSettings] The * @property {object} [sendAgreement.protocolSettings.envelopeSettings] The
* envelope settings. * envelope settings.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.messageContentType] The * [sendAgreement.protocolSettings.envelopeSettings.messageContentType] The
* message content type. * message content type.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.envelopeSettings.transmitFileNameInMimeHeader] * [sendAgreement.protocolSettings.envelopeSettings.transmitFileNameInMimeHeader]
* The value indicating whether to transmit file name in mime header. * The value indicating whether to transmit file name in mime header.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.fileNameTemplate] The * [sendAgreement.protocolSettings.envelopeSettings.fileNameTemplate] The
* template for file name. * template for file name.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError] * [sendAgreement.protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError]
* The value indicating whether to suspend message on file name generation * The value indicating whether to suspend message on file name generation
* error. * error.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.envelopeSettings.autogenerateFileName] The * [sendAgreement.protocolSettings.envelopeSettings.autogenerateFileName] The
* value indicating whether to auto generate file name. * value indicating whether to auto generate file name.
* @member {object} [sendAgreement.protocolSettings.errorSettings] The error * @property {object} [sendAgreement.protocolSettings.errorSettings] The
* settings. * error settings.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.errorSettings.suspendDuplicateMessage] The * [sendAgreement.protocolSettings.errorSettings.suspendDuplicateMessage] The
* value indicating whether to suspend duplicate message. * value indicating whether to suspend duplicate message.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.errorSettings.resendIfMdnNotReceived] The * [sendAgreement.protocolSettings.errorSettings.resendIfMdnNotReceived] The
* value indicating whether to resend message If MDN is not received. * value indicating whether to resend message If MDN is not received.
*/ */

Просмотреть файл

@ -17,13 +17,13 @@
class AS2EnvelopeSettings { class AS2EnvelopeSettings {
/** /**
* Create a AS2EnvelopeSettings. * Create a AS2EnvelopeSettings.
* @member {string} messageContentType The message content type. * @property {string} messageContentType The message content type.
* @member {boolean} transmitFileNameInMimeHeader The value indicating * @property {boolean} transmitFileNameInMimeHeader The value indicating
* whether to transmit file name in mime header. * whether to transmit file name in mime header.
* @member {string} fileNameTemplate The template for file name. * @property {string} fileNameTemplate The template for file name.
* @member {boolean} suspendMessageOnFileNameGenerationError The value * @property {boolean} suspendMessageOnFileNameGenerationError The value
* indicating whether to suspend message on file name generation error. * indicating whether to suspend message on file name generation error.
* @member {boolean} autogenerateFileName The value indicating whether to * @property {boolean} autogenerateFileName The value indicating whether to
* auto generate file name. * auto generate file name.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,9 +17,9 @@
class AS2ErrorSettings { class AS2ErrorSettings {
/** /**
* Create a AS2ErrorSettings. * Create a AS2ErrorSettings.
* @member {boolean} suspendDuplicateMessage The value indicating whether to * @property {boolean} suspendDuplicateMessage The value indicating whether
* suspend duplicate message. * to suspend duplicate message.
* @member {boolean} resendIfMdnNotReceived The value indicating whether to * @property {boolean} resendIfMdnNotReceived The value indicating whether to
* resend message If MDN is not received. * resend message If MDN is not received.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,21 +17,21 @@
class AS2MdnSettings { class AS2MdnSettings {
/** /**
* Create a AS2MdnSettings. * Create a AS2MdnSettings.
* @member {boolean} needMdn The value indicating whether to send or request * @property {boolean} needMdn The value indicating whether to send or
* a MDN. * request a MDN.
* @member {boolean} signMdn The value indicating whether the MDN needs to be * @property {boolean} signMdn The value indicating whether the MDN needs to
* signed or not. * be signed or not.
* @member {boolean} sendMdnAsynchronously The value indicating whether to * @property {boolean} sendMdnAsynchronously The value indicating whether to
* send the asynchronous MDN. * send the asynchronous MDN.
* @member {string} [receiptDeliveryUrl] The receipt delivery URL. * @property {string} [receiptDeliveryUrl] The receipt delivery URL.
* @member {string} [dispositionNotificationTo] The disposition notification * @property {string} [dispositionNotificationTo] The disposition
* to header value. * notification to header value.
* @member {boolean} signOutboundMdnIfOptional The value indicating whether * @property {boolean} signOutboundMdnIfOptional The value indicating whether
* to sign the outbound MDN if optional. * to sign the outbound MDN if optional.
* @member {string} [mdnText] The MDN text. * @property {string} [mdnText] The MDN text.
* @member {boolean} sendInboundMdnToMessageBox The value indicating whether * @property {boolean} sendInboundMdnToMessageBox The value indicating
* to send inbound MDN to message box. * whether to send inbound MDN to message box.
* @member {string} micHashingAlgorithm The signing or hashing algorithm. * @property {string} micHashingAlgorithm The signing or hashing algorithm.
* Possible values include: 'NotSpecified', 'None', 'MD5', 'SHA1', 'SHA2256', * Possible values include: 'NotSpecified', 'None', 'MD5', 'SHA1', 'SHA2256',
* 'SHA2384', 'SHA2512' * 'SHA2384', 'SHA2512'
*/ */

Просмотреть файл

@ -17,14 +17,14 @@
class AS2MessageConnectionSettings { class AS2MessageConnectionSettings {
/** /**
* Create a AS2MessageConnectionSettings. * Create a AS2MessageConnectionSettings.
* @member {boolean} ignoreCertificateNameMismatch The value indicating * @property {boolean} ignoreCertificateNameMismatch The value indicating
* whether to ignore mismatch in certificate name. * whether to ignore mismatch in certificate name.
* @member {boolean} supportHttpStatusCodeContinue The value indicating * @property {boolean} supportHttpStatusCodeContinue The value indicating
* whether to support HTTP status code 'CONTINUE'. * whether to support HTTP status code 'CONTINUE'.
* @member {boolean} keepHttpConnectionAlive The value indicating whether to * @property {boolean} keepHttpConnectionAlive The value indicating whether
* keep the connection alive. * to keep the connection alive.
* @member {boolean} unfoldHttpHeaders The value indicating whether to unfold * @property {boolean} unfoldHttpHeaders The value indicating whether to
* the HTTP headers. * unfold the HTTP headers.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,149 +17,155 @@
class AS2OneWayAgreement { class AS2OneWayAgreement {
/** /**
* Create a AS2OneWayAgreement. * Create a AS2OneWayAgreement.
* @member {object} senderBusinessIdentity The sender business identity * @property {object} senderBusinessIdentity The sender business identity
* @member {string} [senderBusinessIdentity.qualifier] The business identity * @property {string} [senderBusinessIdentity.qualifier] The business
* qualifier e.g. as2identity, ZZ, ZZZ, 31, 32
* @member {string} [senderBusinessIdentity.value] The user defined business
* identity value.
* @member {object} receiverBusinessIdentity The receiver business identity
* @member {string} [receiverBusinessIdentity.qualifier] The business
* identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32
* @member {string} [receiverBusinessIdentity.value] The user defined * @property {string} [senderBusinessIdentity.value] The user defined
* business identity value. * business identity value.
* @member {object} protocolSettings The AS2 protocol settings. * @property {object} receiverBusinessIdentity The receiver business identity
* @member {object} [protocolSettings.messageConnectionSettings] The message * @property {string} [receiverBusinessIdentity.qualifier] The business
* connection settings. * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32
* @member {boolean} * @property {string} [receiverBusinessIdentity.value] The user defined
* business identity value.
* @property {object} protocolSettings The AS2 protocol settings.
* @property {object} [protocolSettings.messageConnectionSettings] The
* message connection settings.
* @property {boolean}
* [protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch] * [protocolSettings.messageConnectionSettings.ignoreCertificateNameMismatch]
* The value indicating whether to ignore mismatch in certificate name. * The value indicating whether to ignore mismatch in certificate name.
* @member {boolean} * @property {boolean}
* [protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue] * [protocolSettings.messageConnectionSettings.supportHttpStatusCodeContinue]
* The value indicating whether to support HTTP status code 'CONTINUE'. * The value indicating whether to support HTTP status code 'CONTINUE'.
* @member {boolean} * @property {boolean}
* [protocolSettings.messageConnectionSettings.keepHttpConnectionAlive] The * [protocolSettings.messageConnectionSettings.keepHttpConnectionAlive] The
* value indicating whether to keep the connection alive. * value indicating whether to keep the connection alive.
* @member {boolean} * @property {boolean}
* [protocolSettings.messageConnectionSettings.unfoldHttpHeaders] The value * [protocolSettings.messageConnectionSettings.unfoldHttpHeaders] The value
* indicating whether to unfold the HTTP headers. * indicating whether to unfold the HTTP headers.
* @member {object} [protocolSettings.acknowledgementConnectionSettings] The * @property {object} [protocolSettings.acknowledgementConnectionSettings]
* acknowledgement connection settings. * The acknowledgement connection settings.
* @member {boolean} * @property {boolean}
* [protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch] * [protocolSettings.acknowledgementConnectionSettings.ignoreCertificateNameMismatch]
* The value indicating whether to ignore mismatch in certificate name. * The value indicating whether to ignore mismatch in certificate name.
* @member {boolean} * @property {boolean}
* [protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue] * [protocolSettings.acknowledgementConnectionSettings.supportHttpStatusCodeContinue]
* The value indicating whether to support HTTP status code 'CONTINUE'. * The value indicating whether to support HTTP status code 'CONTINUE'.
* @member {boolean} * @property {boolean}
* [protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive] * [protocolSettings.acknowledgementConnectionSettings.keepHttpConnectionAlive]
* The value indicating whether to keep the connection alive. * The value indicating whether to keep the connection alive.
* @member {boolean} * @property {boolean}
* [protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders] The * [protocolSettings.acknowledgementConnectionSettings.unfoldHttpHeaders] The
* value indicating whether to unfold the HTTP headers. * value indicating whether to unfold the HTTP headers.
* @member {object} [protocolSettings.mdnSettings] The MDN settings. * @property {object} [protocolSettings.mdnSettings] The MDN settings.
* @member {boolean} [protocolSettings.mdnSettings.needMdn] The value * @property {boolean} [protocolSettings.mdnSettings.needMdn] The value
* indicating whether to send or request a MDN. * indicating whether to send or request a MDN.
* @member {boolean} [protocolSettings.mdnSettings.signMdn] The value * @property {boolean} [protocolSettings.mdnSettings.signMdn] The value
* indicating whether the MDN needs to be signed or not. * indicating whether the MDN needs to be signed or not.
* @member {boolean} [protocolSettings.mdnSettings.sendMdnAsynchronously] The * @property {boolean} [protocolSettings.mdnSettings.sendMdnAsynchronously]
* value indicating whether to send the asynchronous MDN. * The value indicating whether to send the asynchronous MDN.
* @member {string} [protocolSettings.mdnSettings.receiptDeliveryUrl] The * @property {string} [protocolSettings.mdnSettings.receiptDeliveryUrl] The
* receipt delivery URL. * receipt delivery URL.
* @member {string} [protocolSettings.mdnSettings.dispositionNotificationTo] * @property {string}
* The disposition notification to header value. * [protocolSettings.mdnSettings.dispositionNotificationTo] The disposition
* @member {boolean} [protocolSettings.mdnSettings.signOutboundMdnIfOptional] * notification to header value.
* The value indicating whether to sign the outbound MDN if optional. * @property {boolean}
* @member {string} [protocolSettings.mdnSettings.mdnText] The MDN text. * [protocolSettings.mdnSettings.signOutboundMdnIfOptional] The value
* @member {boolean} * indicating whether to sign the outbound MDN if optional.
* @property {string} [protocolSettings.mdnSettings.mdnText] The MDN text.
* @property {boolean}
* [protocolSettings.mdnSettings.sendInboundMdnToMessageBox] The value * [protocolSettings.mdnSettings.sendInboundMdnToMessageBox] The value
* indicating whether to send inbound MDN to message box. * indicating whether to send inbound MDN to message box.
* @member {string} [protocolSettings.mdnSettings.micHashingAlgorithm] The * @property {string} [protocolSettings.mdnSettings.micHashingAlgorithm] The
* signing or hashing algorithm. Possible values include: 'NotSpecified', * signing or hashing algorithm. Possible values include: 'NotSpecified',
* 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' * 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512'
* @member {object} [protocolSettings.securitySettings] The security * @property {object} [protocolSettings.securitySettings] The security
* settings. * settings.
* @member {boolean} * @property {boolean}
* [protocolSettings.securitySettings.overrideGroupSigningCertificate] The * [protocolSettings.securitySettings.overrideGroupSigningCertificate] The
* value indicating whether to send or request a MDN. * value indicating whether to send or request a MDN.
* @member {string} * @property {string}
* [protocolSettings.securitySettings.signingCertificateName] The name of the * [protocolSettings.securitySettings.signingCertificateName] The name of the
* signing certificate. * signing certificate.
* @member {string} * @property {string}
* [protocolSettings.securitySettings.encryptionCertificateName] The name of * [protocolSettings.securitySettings.encryptionCertificateName] The name of
* the encryption certificate. * the encryption certificate.
* @member {boolean} * @property {boolean}
* [protocolSettings.securitySettings.enableNrrForInboundEncodedMessages] The * [protocolSettings.securitySettings.enableNrrForInboundEncodedMessages] The
* value indicating whether to enable NRR for inbound encoded messages. * value indicating whether to enable NRR for inbound encoded messages.
* @member {boolean} * @property {boolean}
* [protocolSettings.securitySettings.enableNrrForInboundDecodedMessages] The * [protocolSettings.securitySettings.enableNrrForInboundDecodedMessages] The
* value indicating whether to enable NRR for inbound decoded messages. * value indicating whether to enable NRR for inbound decoded messages.
* @member {boolean} * @property {boolean}
* [protocolSettings.securitySettings.enableNrrForOutboundMdn] The value * [protocolSettings.securitySettings.enableNrrForOutboundMdn] The value
* indicating whether to enable NRR for outbound MDN. * indicating whether to enable NRR for outbound MDN.
* @member {boolean} * @property {boolean}
* [protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages] * [protocolSettings.securitySettings.enableNrrForOutboundEncodedMessages]
* The value indicating whether to enable NRR for outbound encoded messages. * The value indicating whether to enable NRR for outbound encoded messages.
* @member {boolean} * @property {boolean}
* [protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages] * [protocolSettings.securitySettings.enableNrrForOutboundDecodedMessages]
* The value indicating whether to enable NRR for outbound decoded messages. * The value indicating whether to enable NRR for outbound decoded messages.
* @member {boolean} * @property {boolean}
* [protocolSettings.securitySettings.enableNrrForInboundMdn] The value * [protocolSettings.securitySettings.enableNrrForInboundMdn] The value
* indicating whether to enable NRR for inbound MDN. * indicating whether to enable NRR for inbound MDN.
* @member {string} [protocolSettings.securitySettings.sha2AlgorithmFormat] * @property {string} [protocolSettings.securitySettings.sha2AlgorithmFormat]
* The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, * The Sha2 algorithm format. Valid values are Sha2, ShaHashSize,
* ShaHyphenHashSize, Sha2UnderscoreHashSize. * ShaHyphenHashSize, Sha2UnderscoreHashSize.
* @member {object} [protocolSettings.validationSettings] The validation * @property {object} [protocolSettings.validationSettings] The validation
* settings. * settings.
* @member {boolean} * @property {boolean}
* [protocolSettings.validationSettings.overrideMessageProperties] The value * [protocolSettings.validationSettings.overrideMessageProperties] The value
* indicating whether to override incoming message properties with those in * indicating whether to override incoming message properties with those in
* agreement. * agreement.
* @member {boolean} [protocolSettings.validationSettings.encryptMessage] The * @property {boolean} [protocolSettings.validationSettings.encryptMessage]
* value indicating whether the message has to be encrypted. * The value indicating whether the message has to be encrypted.
* @member {boolean} [protocolSettings.validationSettings.signMessage] The * @property {boolean} [protocolSettings.validationSettings.signMessage] The
* value indicating whether the message has to be signed. * value indicating whether the message has to be signed.
* @member {boolean} [protocolSettings.validationSettings.compressMessage] * @property {boolean} [protocolSettings.validationSettings.compressMessage]
* The value indicating whether the message has to be compressed. * The value indicating whether the message has to be compressed.
* @member {boolean} * @property {boolean}
* [protocolSettings.validationSettings.checkDuplicateMessage] The value * [protocolSettings.validationSettings.checkDuplicateMessage] The value
* indicating whether to check for duplicate message. * indicating whether to check for duplicate message.
* @member {number} * @property {number}
* [protocolSettings.validationSettings.interchangeDuplicatesValidityDays] * [protocolSettings.validationSettings.interchangeDuplicatesValidityDays]
* The number of days to look back for duplicate interchange. * The number of days to look back for duplicate interchange.
* @member {boolean} * @property {boolean}
* [protocolSettings.validationSettings.checkCertificateRevocationListOnSend] * [protocolSettings.validationSettings.checkCertificateRevocationListOnSend]
* The value indicating whether to check for certificate revocation list on * The value indicating whether to check for certificate revocation list on
* send. * send.
* @member {boolean} * @property {boolean}
* [protocolSettings.validationSettings.checkCertificateRevocationListOnReceive] * [protocolSettings.validationSettings.checkCertificateRevocationListOnReceive]
* The value indicating whether to check for certificate revocation list on * The value indicating whether to check for certificate revocation list on
* receive. * receive.
* @member {string} [protocolSettings.validationSettings.encryptionAlgorithm] * @property {string}
* The encryption algorithm. Possible values include: 'NotSpecified', 'None', * [protocolSettings.validationSettings.encryptionAlgorithm] The encryption
* 'DES3', 'RC2', 'AES128', 'AES192', 'AES256' * algorithm. Possible values include: 'NotSpecified', 'None', 'DES3', 'RC2',
* @member {string} [protocolSettings.validationSettings.signingAlgorithm] * 'AES128', 'AES192', 'AES256'
* @property {string} [protocolSettings.validationSettings.signingAlgorithm]
* The signing algorithm. Possible values include: 'NotSpecified', 'Default', * The signing algorithm. Possible values include: 'NotSpecified', 'Default',
* 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512' * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512'
* @member {object} [protocolSettings.envelopeSettings] The envelope * @property {object} [protocolSettings.envelopeSettings] The envelope
* settings. * settings.
* @member {string} [protocolSettings.envelopeSettings.messageContentType] * @property {string} [protocolSettings.envelopeSettings.messageContentType]
* The message content type. * The message content type.
* @member {boolean} * @property {boolean}
* [protocolSettings.envelopeSettings.transmitFileNameInMimeHeader] The value * [protocolSettings.envelopeSettings.transmitFileNameInMimeHeader] The value
* indicating whether to transmit file name in mime header. * indicating whether to transmit file name in mime header.
* @member {string} [protocolSettings.envelopeSettings.fileNameTemplate] The * @property {string} [protocolSettings.envelopeSettings.fileNameTemplate]
* template for file name. * The template for file name.
* @member {boolean} * @property {boolean}
* [protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError] * [protocolSettings.envelopeSettings.suspendMessageOnFileNameGenerationError]
* The value indicating whether to suspend message on file name generation * The value indicating whether to suspend message on file name generation
* error. * error.
* @member {boolean} [protocolSettings.envelopeSettings.autogenerateFileName] * @property {boolean}
* The value indicating whether to auto generate file name. * [protocolSettings.envelopeSettings.autogenerateFileName] The value
* @member {object} [protocolSettings.errorSettings] The error settings. * indicating whether to auto generate file name.
* @member {boolean} [protocolSettings.errorSettings.suspendDuplicateMessage] * @property {object} [protocolSettings.errorSettings] The error settings.
* The value indicating whether to suspend duplicate message. * @property {boolean}
* @member {boolean} [protocolSettings.errorSettings.resendIfMdnNotReceived] * [protocolSettings.errorSettings.suspendDuplicateMessage] The value
* The value indicating whether to resend message If MDN is not received. * indicating whether to suspend duplicate message.
* @property {boolean}
* [protocolSettings.errorSettings.resendIfMdnNotReceived] The value
* indicating whether to resend message If MDN is not received.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,114 +17,114 @@
class AS2ProtocolSettings { class AS2ProtocolSettings {
/** /**
* Create a AS2ProtocolSettings. * Create a AS2ProtocolSettings.
* @member {object} messageConnectionSettings The message connection * @property {object} messageConnectionSettings The message connection
* settings. * settings.
* @member {boolean} * @property {boolean}
* [messageConnectionSettings.ignoreCertificateNameMismatch] The value * [messageConnectionSettings.ignoreCertificateNameMismatch] The value
* indicating whether to ignore mismatch in certificate name. * indicating whether to ignore mismatch in certificate name.
* @member {boolean} * @property {boolean}
* [messageConnectionSettings.supportHttpStatusCodeContinue] The value * [messageConnectionSettings.supportHttpStatusCodeContinue] The value
* indicating whether to support HTTP status code 'CONTINUE'. * indicating whether to support HTTP status code 'CONTINUE'.
* @member {boolean} [messageConnectionSettings.keepHttpConnectionAlive] The * @property {boolean} [messageConnectionSettings.keepHttpConnectionAlive]
* value indicating whether to keep the connection alive. * The value indicating whether to keep the connection alive.
* @member {boolean} [messageConnectionSettings.unfoldHttpHeaders] The value * @property {boolean} [messageConnectionSettings.unfoldHttpHeaders] The
* indicating whether to unfold the HTTP headers. * value indicating whether to unfold the HTTP headers.
* @member {object} acknowledgementConnectionSettings The acknowledgement * @property {object} acknowledgementConnectionSettings The acknowledgement
* connection settings. * connection settings.
* @member {boolean} * @property {boolean}
* [acknowledgementConnectionSettings.ignoreCertificateNameMismatch] The * [acknowledgementConnectionSettings.ignoreCertificateNameMismatch] The
* value indicating whether to ignore mismatch in certificate name. * value indicating whether to ignore mismatch in certificate name.
* @member {boolean} * @property {boolean}
* [acknowledgementConnectionSettings.supportHttpStatusCodeContinue] The * [acknowledgementConnectionSettings.supportHttpStatusCodeContinue] The
* value indicating whether to support HTTP status code 'CONTINUE'. * value indicating whether to support HTTP status code 'CONTINUE'.
* @member {boolean} * @property {boolean}
* [acknowledgementConnectionSettings.keepHttpConnectionAlive] The value * [acknowledgementConnectionSettings.keepHttpConnectionAlive] The value
* indicating whether to keep the connection alive. * indicating whether to keep the connection alive.
* @member {boolean} [acknowledgementConnectionSettings.unfoldHttpHeaders] * @property {boolean} [acknowledgementConnectionSettings.unfoldHttpHeaders]
* The value indicating whether to unfold the HTTP headers. * The value indicating whether to unfold the HTTP headers.
* @member {object} mdnSettings The MDN settings. * @property {object} mdnSettings The MDN settings.
* @member {boolean} [mdnSettings.needMdn] The value indicating whether to * @property {boolean} [mdnSettings.needMdn] The value indicating whether to
* send or request a MDN. * send or request a MDN.
* @member {boolean} [mdnSettings.signMdn] The value indicating whether the * @property {boolean} [mdnSettings.signMdn] The value indicating whether the
* MDN needs to be signed or not. * MDN needs to be signed or not.
* @member {boolean} [mdnSettings.sendMdnAsynchronously] The value indicating * @property {boolean} [mdnSettings.sendMdnAsynchronously] The value
* whether to send the asynchronous MDN. * indicating whether to send the asynchronous MDN.
* @member {string} [mdnSettings.receiptDeliveryUrl] The receipt delivery * @property {string} [mdnSettings.receiptDeliveryUrl] The receipt delivery
* URL. * URL.
* @member {string} [mdnSettings.dispositionNotificationTo] The disposition * @property {string} [mdnSettings.dispositionNotificationTo] The disposition
* notification to header value. * notification to header value.
* @member {boolean} [mdnSettings.signOutboundMdnIfOptional] The value * @property {boolean} [mdnSettings.signOutboundMdnIfOptional] The value
* indicating whether to sign the outbound MDN if optional. * indicating whether to sign the outbound MDN if optional.
* @member {string} [mdnSettings.mdnText] The MDN text. * @property {string} [mdnSettings.mdnText] The MDN text.
* @member {boolean} [mdnSettings.sendInboundMdnToMessageBox] The value * @property {boolean} [mdnSettings.sendInboundMdnToMessageBox] The value
* indicating whether to send inbound MDN to message box. * indicating whether to send inbound MDN to message box.
* @member {string} [mdnSettings.micHashingAlgorithm] The signing or hashing * @property {string} [mdnSettings.micHashingAlgorithm] The signing or
* algorithm. Possible values include: 'NotSpecified', 'None', 'MD5', 'SHA1', * hashing algorithm. Possible values include: 'NotSpecified', 'None', 'MD5',
* 'SHA2256', 'SHA2384', 'SHA2512' * 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512'
* @member {object} securitySettings The security settings. * @property {object} securitySettings The security settings.
* @member {boolean} [securitySettings.overrideGroupSigningCertificate] The * @property {boolean} [securitySettings.overrideGroupSigningCertificate] The
* value indicating whether to send or request a MDN. * value indicating whether to send or request a MDN.
* @member {string} [securitySettings.signingCertificateName] The name of the * @property {string} [securitySettings.signingCertificateName] The name of
* signing certificate. * the signing certificate.
* @member {string} [securitySettings.encryptionCertificateName] The name of * @property {string} [securitySettings.encryptionCertificateName] The name
* the encryption certificate. * of the encryption certificate.
* @member {boolean} [securitySettings.enableNrrForInboundEncodedMessages] * @property {boolean} [securitySettings.enableNrrForInboundEncodedMessages]
* The value indicating whether to enable NRR for inbound encoded messages. * The value indicating whether to enable NRR for inbound encoded messages.
* @member {boolean} [securitySettings.enableNrrForInboundDecodedMessages] * @property {boolean} [securitySettings.enableNrrForInboundDecodedMessages]
* The value indicating whether to enable NRR for inbound decoded messages. * The value indicating whether to enable NRR for inbound decoded messages.
* @member {boolean} [securitySettings.enableNrrForOutboundMdn] The value * @property {boolean} [securitySettings.enableNrrForOutboundMdn] The value
* indicating whether to enable NRR for outbound MDN. * indicating whether to enable NRR for outbound MDN.
* @member {boolean} [securitySettings.enableNrrForOutboundEncodedMessages] * @property {boolean} [securitySettings.enableNrrForOutboundEncodedMessages]
* The value indicating whether to enable NRR for outbound encoded messages. * The value indicating whether to enable NRR for outbound encoded messages.
* @member {boolean} [securitySettings.enableNrrForOutboundDecodedMessages] * @property {boolean} [securitySettings.enableNrrForOutboundDecodedMessages]
* The value indicating whether to enable NRR for outbound decoded messages. * The value indicating whether to enable NRR for outbound decoded messages.
* @member {boolean} [securitySettings.enableNrrForInboundMdn] The value * @property {boolean} [securitySettings.enableNrrForInboundMdn] The value
* indicating whether to enable NRR for inbound MDN. * indicating whether to enable NRR for inbound MDN.
* @member {string} [securitySettings.sha2AlgorithmFormat] The Sha2 algorithm * @property {string} [securitySettings.sha2AlgorithmFormat] The Sha2
* format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, * algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize,
* Sha2UnderscoreHashSize. * Sha2UnderscoreHashSize.
* @member {object} validationSettings The validation settings. * @property {object} validationSettings The validation settings.
* @member {boolean} [validationSettings.overrideMessageProperties] The value * @property {boolean} [validationSettings.overrideMessageProperties] The
* indicating whether to override incoming message properties with those in * value indicating whether to override incoming message properties with
* agreement. * those in agreement.
* @member {boolean} [validationSettings.encryptMessage] The value indicating * @property {boolean} [validationSettings.encryptMessage] The value
* whether the message has to be encrypted. * indicating whether the message has to be encrypted.
* @member {boolean} [validationSettings.signMessage] The value indicating * @property {boolean} [validationSettings.signMessage] The value indicating
* whether the message has to be signed. * whether the message has to be signed.
* @member {boolean} [validationSettings.compressMessage] The value * @property {boolean} [validationSettings.compressMessage] The value
* indicating whether the message has to be compressed. * indicating whether the message has to be compressed.
* @member {boolean} [validationSettings.checkDuplicateMessage] The value * @property {boolean} [validationSettings.checkDuplicateMessage] The value
* indicating whether to check for duplicate message. * indicating whether to check for duplicate message.
* @member {number} [validationSettings.interchangeDuplicatesValidityDays] * @property {number} [validationSettings.interchangeDuplicatesValidityDays]
* The number of days to look back for duplicate interchange. * The number of days to look back for duplicate interchange.
* @member {boolean} * @property {boolean}
* [validationSettings.checkCertificateRevocationListOnSend] The value * [validationSettings.checkCertificateRevocationListOnSend] The value
* indicating whether to check for certificate revocation list on send. * indicating whether to check for certificate revocation list on send.
* @member {boolean} * @property {boolean}
* [validationSettings.checkCertificateRevocationListOnReceive] The value * [validationSettings.checkCertificateRevocationListOnReceive] The value
* indicating whether to check for certificate revocation list on receive. * indicating whether to check for certificate revocation list on receive.
* @member {string} [validationSettings.encryptionAlgorithm] The encryption * @property {string} [validationSettings.encryptionAlgorithm] The encryption
* algorithm. Possible values include: 'NotSpecified', 'None', 'DES3', 'RC2', * algorithm. Possible values include: 'NotSpecified', 'None', 'DES3', 'RC2',
* 'AES128', 'AES192', 'AES256' * 'AES128', 'AES192', 'AES256'
* @member {string} [validationSettings.signingAlgorithm] The signing * @property {string} [validationSettings.signingAlgorithm] The signing
* algorithm. Possible values include: 'NotSpecified', 'Default', 'SHA1', * algorithm. Possible values include: 'NotSpecified', 'Default', 'SHA1',
* 'SHA2256', 'SHA2384', 'SHA2512' * 'SHA2256', 'SHA2384', 'SHA2512'
* @member {object} envelopeSettings The envelope settings. * @property {object} envelopeSettings The envelope settings.
* @member {string} [envelopeSettings.messageContentType] The message content * @property {string} [envelopeSettings.messageContentType] The message
* type. * content type.
* @member {boolean} [envelopeSettings.transmitFileNameInMimeHeader] The * @property {boolean} [envelopeSettings.transmitFileNameInMimeHeader] The
* value indicating whether to transmit file name in mime header. * value indicating whether to transmit file name in mime header.
* @member {string} [envelopeSettings.fileNameTemplate] The template for file * @property {string} [envelopeSettings.fileNameTemplate] The template for
* name. * file name.
* @member {boolean} * @property {boolean}
* [envelopeSettings.suspendMessageOnFileNameGenerationError] The value * [envelopeSettings.suspendMessageOnFileNameGenerationError] The value
* indicating whether to suspend message on file name generation error. * indicating whether to suspend message on file name generation error.
* @member {boolean} [envelopeSettings.autogenerateFileName] The value * @property {boolean} [envelopeSettings.autogenerateFileName] The value
* indicating whether to auto generate file name. * indicating whether to auto generate file name.
* @member {object} errorSettings The error settings. * @property {object} errorSettings The error settings.
* @member {boolean} [errorSettings.suspendDuplicateMessage] The value * @property {boolean} [errorSettings.suspendDuplicateMessage] The value
* indicating whether to suspend duplicate message. * indicating whether to suspend duplicate message.
* @member {boolean} [errorSettings.resendIfMdnNotReceived] The value * @property {boolean} [errorSettings.resendIfMdnNotReceived] The value
* indicating whether to resend message If MDN is not received. * indicating whether to resend message If MDN is not received.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,25 +17,25 @@
class AS2SecuritySettings { class AS2SecuritySettings {
/** /**
* Create a AS2SecuritySettings. * Create a AS2SecuritySettings.
* @member {boolean} overrideGroupSigningCertificate The value indicating * @property {boolean} overrideGroupSigningCertificate The value indicating
* whether to send or request a MDN. * whether to send or request a MDN.
* @member {string} [signingCertificateName] The name of the signing * @property {string} [signingCertificateName] The name of the signing
* certificate. * certificate.
* @member {string} [encryptionCertificateName] The name of the encryption * @property {string} [encryptionCertificateName] The name of the encryption
* certificate. * certificate.
* @member {boolean} enableNrrForInboundEncodedMessages The value indicating * @property {boolean} enableNrrForInboundEncodedMessages The value
* whether to enable NRR for inbound encoded messages. * indicating whether to enable NRR for inbound encoded messages.
* @member {boolean} enableNrrForInboundDecodedMessages The value indicating * @property {boolean} enableNrrForInboundDecodedMessages The value
* whether to enable NRR for inbound decoded messages. * indicating whether to enable NRR for inbound decoded messages.
* @member {boolean} enableNrrForOutboundMdn The value indicating whether to * @property {boolean} enableNrrForOutboundMdn The value indicating whether
* enable NRR for outbound MDN. * to enable NRR for outbound MDN.
* @member {boolean} enableNrrForOutboundEncodedMessages The value indicating * @property {boolean} enableNrrForOutboundEncodedMessages The value
* whether to enable NRR for outbound encoded messages. * indicating whether to enable NRR for outbound encoded messages.
* @member {boolean} enableNrrForOutboundDecodedMessages The value indicating * @property {boolean} enableNrrForOutboundDecodedMessages The value
* whether to enable NRR for outbound decoded messages. * indicating whether to enable NRR for outbound decoded messages.
* @member {boolean} enableNrrForInboundMdn The value indicating whether to * @property {boolean} enableNrrForInboundMdn The value indicating whether to
* enable NRR for inbound MDN. * enable NRR for inbound MDN.
* @member {string} [sha2AlgorithmFormat] The Sha2 algorithm format. Valid * @property {string} [sha2AlgorithmFormat] The Sha2 algorithm format. Valid
* values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. * values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,27 +17,27 @@
class AS2ValidationSettings { class AS2ValidationSettings {
/** /**
* Create a AS2ValidationSettings. * Create a AS2ValidationSettings.
* @member {boolean} overrideMessageProperties The value indicating whether * @property {boolean} overrideMessageProperties The value indicating whether
* to override incoming message properties with those in agreement. * to override incoming message properties with those in agreement.
* @member {boolean} encryptMessage The value indicating whether the message * @property {boolean} encryptMessage The value indicating whether the
* has to be encrypted. * message has to be encrypted.
* @member {boolean} signMessage The value indicating whether the message has * @property {boolean} signMessage The value indicating whether the message
* to be signed. * has to be signed.
* @member {boolean} compressMessage The value indicating whether the message * @property {boolean} compressMessage The value indicating whether the
* has to be compressed. * message has to be compressed.
* @member {boolean} checkDuplicateMessage The value indicating whether to * @property {boolean} checkDuplicateMessage The value indicating whether to
* check for duplicate message. * check for duplicate message.
* @member {number} interchangeDuplicatesValidityDays The number of days to * @property {number} interchangeDuplicatesValidityDays The number of days to
* look back for duplicate interchange. * look back for duplicate interchange.
* @member {boolean} checkCertificateRevocationListOnSend The value * @property {boolean} checkCertificateRevocationListOnSend The value
* indicating whether to check for certificate revocation list on send. * indicating whether to check for certificate revocation list on send.
* @member {boolean} checkCertificateRevocationListOnReceive The value * @property {boolean} checkCertificateRevocationListOnReceive The value
* indicating whether to check for certificate revocation list on receive. * indicating whether to check for certificate revocation list on receive.
* @member {string} encryptionAlgorithm The encryption algorithm. Possible * @property {string} encryptionAlgorithm The encryption algorithm. Possible
* values include: 'NotSpecified', 'None', 'DES3', 'RC2', 'AES128', 'AES192', * values include: 'NotSpecified', 'None', 'DES3', 'RC2', 'AES128', 'AES192',
* 'AES256' * 'AES256'
* @member {string} [signingAlgorithm] The signing algorithm. Possible values * @property {string} [signingAlgorithm] The signing algorithm. Possible
* include: 'NotSpecified', 'Default', 'SHA1', 'SHA2256', 'SHA2384', * values include: 'NotSpecified', 'Default', 'SHA1', 'SHA2256', 'SHA2384',
* 'SHA2512' * 'SHA2512'
*/ */
constructor() { constructor() {

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -20,18 +20,18 @@ const models = require('./index');
class ArtifactContentPropertiesDefinition extends models['ArtifactProperties'] { class ArtifactContentPropertiesDefinition extends models['ArtifactProperties'] {
/** /**
* Create a ArtifactContentPropertiesDefinition. * Create a ArtifactContentPropertiesDefinition.
* @member {object} [content] * @property {object} [content]
* @member {string} [contentType] The content type. * @property {string} [contentType] The content type.
* @member {object} [contentLink] The content link. * @property {object} [contentLink] The content link.
* @member {string} [contentLink.uri] The content link URI. * @property {string} [contentLink.uri] The content link URI.
* @member {string} [contentLink.contentVersion] The content version. * @property {string} [contentLink.contentVersion] The content version.
* @member {number} [contentLink.contentSize] The content size. * @property {number} [contentLink.contentSize] The content size.
* @member {object} [contentLink.contentHash] The content hash. * @property {object} [contentLink.contentHash] The content hash.
* @member {string} [contentLink.contentHash.algorithm] The algorithm of the * @property {string} [contentLink.contentHash.algorithm] The algorithm of
* the content hash.
* @property {string} [contentLink.contentHash.value] The value of the
* content hash. * content hash.
* @member {string} [contentLink.contentHash.value] The value of the content * @property {object} [contentLink.metadata] The metadata.
* hash.
* @member {object} [contentLink.metadata] The metadata.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -17,9 +17,9 @@
class ArtifactProperties { class ArtifactProperties {
/** /**
* Create a ArtifactProperties. * Create a ArtifactProperties.
* @member {date} [createdTime] The artifact creation time. * @property {date} [createdTime] The artifact creation time.
* @member {date} [changedTime] The artifact changed time. * @property {date} [changedTime] The artifact changed time.
* @member {object} [metadata] * @property {object} [metadata]
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -20,11 +20,11 @@ const models = require('./index');
class AssemblyDefinition extends models['Resource'] { class AssemblyDefinition extends models['Resource'] {
/** /**
* Create a AssemblyDefinition. * Create a AssemblyDefinition.
* @member {object} properties The assembly properties. * @property {object} properties The assembly properties.
* @member {string} [properties.assemblyName] The assembly name. * @property {string} [properties.assemblyName] The assembly name.
* @member {string} [properties.assemblyVersion] The assembly version. * @property {string} [properties.assemblyVersion] The assembly version.
* @member {string} [properties.assemblyCulture] The assembly culture. * @property {string} [properties.assemblyCulture] The assembly culture.
* @member {string} [properties.assemblyPublicKeyToken] The assembly public * @property {string} [properties.assemblyPublicKeyToken] The assembly public
* key token. * key token.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -20,10 +20,10 @@ const models = require('./index');
class AssemblyProperties extends models['ArtifactContentPropertiesDefinition'] { class AssemblyProperties extends models['ArtifactContentPropertiesDefinition'] {
/** /**
* Create a AssemblyProperties. * Create a AssemblyProperties.
* @member {string} assemblyName The assembly name. * @property {string} assemblyName The assembly name.
* @member {string} [assemblyVersion] The assembly version. * @property {string} [assemblyVersion] The assembly version.
* @member {string} [assemblyCulture] The assembly culture. * @property {string} [assemblyCulture] The assembly culture.
* @member {string} [assemblyPublicKeyToken] The assembly public key token. * @property {string} [assemblyPublicKeyToken] The assembly public key token.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -20,8 +20,8 @@ const models = require('./index');
class AzureResourceErrorInfo extends models['ErrorInfo'] { class AzureResourceErrorInfo extends models['ErrorInfo'] {
/** /**
* Create a AzureResourceErrorInfo. * Create a AzureResourceErrorInfo.
* @member {string} message The error message. * @property {string} message The error message.
* @member {array} [details] The error details. * @property {array} [details] The error details.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -17,7 +17,7 @@
class B2BPartnerContent { class B2BPartnerContent {
/** /**
* Create a B2BPartnerContent. * Create a B2BPartnerContent.
* @member {array} [businessIdentities] The list of partner business * @property {array} [businessIdentities] The list of partner business
* identities. * identities.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -20,36 +20,39 @@ const models = require('./index');
class BatchConfiguration extends models['Resource'] { class BatchConfiguration extends models['Resource'] {
/** /**
* Create a BatchConfiguration. * Create a BatchConfiguration.
* @member {object} properties The batch configuration properties. * @property {object} properties The batch configuration properties.
* @member {string} [properties.batchGroupName] The name of the batch group. * @property {string} [properties.batchGroupName] The name of the batch
* @member {object} [properties.releaseCriteria] The batch release criteria. * group.
* @member {number} [properties.releaseCriteria.messageCount] The message * @property {object} [properties.releaseCriteria] The batch release
* criteria.
* @property {number} [properties.releaseCriteria.messageCount] The message
* count. * count.
* @member {number} [properties.releaseCriteria.batchSize] The batch size in * @property {number} [properties.releaseCriteria.batchSize] The batch size
* bytes. * in bytes.
* @member {object} [properties.releaseCriteria.recurrence] The recurrence. * @property {object} [properties.releaseCriteria.recurrence] The recurrence.
* @member {string} [properties.releaseCriteria.recurrence.frequency] The * @property {string} [properties.releaseCriteria.recurrence.frequency] The
* frequency. Possible values include: 'NotSpecified', 'Second', 'Minute', * frequency. Possible values include: 'NotSpecified', 'Second', 'Minute',
* 'Hour', 'Day', 'Week', 'Month', 'Year' * 'Hour', 'Day', 'Week', 'Month', 'Year'
* @member {number} [properties.releaseCriteria.recurrence.interval] The * @property {number} [properties.releaseCriteria.recurrence.interval] The
* interval. * interval.
* @member {string} [properties.releaseCriteria.recurrence.startTime] The * @property {string} [properties.releaseCriteria.recurrence.startTime] The
* start time. * start time.
* @member {string} [properties.releaseCriteria.recurrence.endTime] The end * @property {string} [properties.releaseCriteria.recurrence.endTime] The end
* time. * time.
* @member {string} [properties.releaseCriteria.recurrence.timeZone] The time * @property {string} [properties.releaseCriteria.recurrence.timeZone] The
* zone. * time zone.
* @member {object} [properties.releaseCriteria.recurrence.schedule] The * @property {object} [properties.releaseCriteria.recurrence.schedule] The
* recurrence schedule. * recurrence schedule.
* @member {array} [properties.releaseCriteria.recurrence.schedule.minutes] * @property {array} [properties.releaseCriteria.recurrence.schedule.minutes]
* The minutes. * The minutes.
* @member {array} [properties.releaseCriteria.recurrence.schedule.hours] The * @property {array} [properties.releaseCriteria.recurrence.schedule.hours]
* hours. * The hours.
* @member {array} [properties.releaseCriteria.recurrence.schedule.weekDays] * @property {array}
* The days of the week. * [properties.releaseCriteria.recurrence.schedule.weekDays] The days of the
* @member {array} [properties.releaseCriteria.recurrence.schedule.monthDays] * week.
* The month days. * @property {array}
* @member {array} * [properties.releaseCriteria.recurrence.schedule.monthDays] The month days.
* @property {array}
* [properties.releaseCriteria.recurrence.schedule.monthlyOccurrences] The * [properties.releaseCriteria.recurrence.schedule.monthlyOccurrences] The
* monthly occurrences. * monthly occurrences.
*/ */

Просмотреть файл

@ -20,27 +20,28 @@ const models = require('./index');
class BatchConfigurationProperties extends models['ArtifactProperties'] { class BatchConfigurationProperties extends models['ArtifactProperties'] {
/** /**
* Create a BatchConfigurationProperties. * Create a BatchConfigurationProperties.
* @member {string} batchGroupName The name of the batch group. * @property {string} batchGroupName The name of the batch group.
* @member {object} releaseCriteria The batch release criteria. * @property {object} releaseCriteria The batch release criteria.
* @member {number} [releaseCriteria.messageCount] The message count. * @property {number} [releaseCriteria.messageCount] The message count.
* @member {number} [releaseCriteria.batchSize] The batch size in bytes. * @property {number} [releaseCriteria.batchSize] The batch size in bytes.
* @member {object} [releaseCriteria.recurrence] The recurrence. * @property {object} [releaseCriteria.recurrence] The recurrence.
* @member {string} [releaseCriteria.recurrence.frequency] The frequency. * @property {string} [releaseCriteria.recurrence.frequency] The frequency.
* Possible values include: 'NotSpecified', 'Second', 'Minute', 'Hour', * Possible values include: 'NotSpecified', 'Second', 'Minute', 'Hour',
* 'Day', 'Week', 'Month', 'Year' * 'Day', 'Week', 'Month', 'Year'
* @member {number} [releaseCriteria.recurrence.interval] The interval. * @property {number} [releaseCriteria.recurrence.interval] The interval.
* @member {string} [releaseCriteria.recurrence.startTime] The start time. * @property {string} [releaseCriteria.recurrence.startTime] The start time.
* @member {string} [releaseCriteria.recurrence.endTime] The end time. * @property {string} [releaseCriteria.recurrence.endTime] The end time.
* @member {string} [releaseCriteria.recurrence.timeZone] The time zone. * @property {string} [releaseCriteria.recurrence.timeZone] The time zone.
* @member {object} [releaseCriteria.recurrence.schedule] The recurrence * @property {object} [releaseCriteria.recurrence.schedule] The recurrence
* schedule. * schedule.
* @member {array} [releaseCriteria.recurrence.schedule.minutes] The minutes. * @property {array} [releaseCriteria.recurrence.schedule.minutes] The
* @member {array} [releaseCriteria.recurrence.schedule.hours] The hours. * minutes.
* @member {array} [releaseCriteria.recurrence.schedule.weekDays] The days of * @property {array} [releaseCriteria.recurrence.schedule.hours] The hours.
* the week. * @property {array} [releaseCriteria.recurrence.schedule.weekDays] The days
* @member {array} [releaseCriteria.recurrence.schedule.monthDays] The month * of the week.
* days. * @property {array} [releaseCriteria.recurrence.schedule.monthDays] The
* @member {array} [releaseCriteria.recurrence.schedule.monthlyOccurrences] * month days.
* @property {array} [releaseCriteria.recurrence.schedule.monthlyOccurrences]
* The monthly occurrences. * The monthly occurrences.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,22 +17,22 @@
class BatchReleaseCriteria { class BatchReleaseCriteria {
/** /**
* Create a BatchReleaseCriteria. * Create a BatchReleaseCriteria.
* @member {number} [messageCount] The message count. * @property {number} [messageCount] The message count.
* @member {number} [batchSize] The batch size in bytes. * @property {number} [batchSize] The batch size in bytes.
* @member {object} [recurrence] The recurrence. * @property {object} [recurrence] The recurrence.
* @member {string} [recurrence.frequency] The frequency. Possible values * @property {string} [recurrence.frequency] The frequency. Possible values
* include: 'NotSpecified', 'Second', 'Minute', 'Hour', 'Day', 'Week', * include: 'NotSpecified', 'Second', 'Minute', 'Hour', 'Day', 'Week',
* 'Month', 'Year' * 'Month', 'Year'
* @member {number} [recurrence.interval] The interval. * @property {number} [recurrence.interval] The interval.
* @member {string} [recurrence.startTime] The start time. * @property {string} [recurrence.startTime] The start time.
* @member {string} [recurrence.endTime] The end time. * @property {string} [recurrence.endTime] The end time.
* @member {string} [recurrence.timeZone] The time zone. * @property {string} [recurrence.timeZone] The time zone.
* @member {object} [recurrence.schedule] The recurrence schedule. * @property {object} [recurrence.schedule] The recurrence schedule.
* @member {array} [recurrence.schedule.minutes] The minutes. * @property {array} [recurrence.schedule.minutes] The minutes.
* @member {array} [recurrence.schedule.hours] The hours. * @property {array} [recurrence.schedule.hours] The hours.
* @member {array} [recurrence.schedule.weekDays] The days of the week. * @property {array} [recurrence.schedule.weekDays] The days of the week.
* @member {array} [recurrence.schedule.monthDays] The month days. * @property {array} [recurrence.schedule.monthDays] The month days.
* @member {array} [recurrence.schedule.monthlyOccurrences] The monthly * @property {array} [recurrence.schedule.monthlyOccurrences] The monthly
* occurrences. * occurrences.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,9 +17,9 @@
class BusinessIdentity { class BusinessIdentity {
/** /**
* Create a BusinessIdentity. * Create a BusinessIdentity.
* @member {string} qualifier The business identity qualifier e.g. * @property {string} qualifier The business identity qualifier e.g.
* as2identity, ZZ, ZZZ, 31, 32 * as2identity, ZZ, ZZZ, 31, 32
* @member {string} value The user defined business identity value. * @property {string} value The user defined business identity value.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,7 +17,7 @@
class CallbackUrl { class CallbackUrl {
/** /**
* Create a CallbackUrl. * Create a CallbackUrl.
* @member {string} [value] The URL value. * @property {string} [value] The URL value.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,8 +17,8 @@
class ContentHash { class ContentHash {
/** /**
* Create a ContentHash. * Create a ContentHash.
* @member {string} [algorithm] The algorithm of the content hash. * @property {string} [algorithm] The algorithm of the content hash.
* @member {string} [value] The value of the content hash. * @property {string} [value] The value of the content hash.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,14 +17,14 @@
class ContentLink { class ContentLink {
/** /**
* Create a ContentLink. * Create a ContentLink.
* @member {string} [uri] The content link URI. * @property {string} [uri] The content link URI.
* @member {string} [contentVersion] The content version. * @property {string} [contentVersion] The content version.
* @member {number} [contentSize] The content size. * @property {number} [contentSize] The content size.
* @member {object} [contentHash] The content hash. * @property {object} [contentHash] The content hash.
* @member {string} [contentHash.algorithm] The algorithm of the content * @property {string} [contentHash.algorithm] The algorithm of the content
* hash. * hash.
* @member {string} [contentHash.value] The value of the content hash. * @property {string} [contentHash.value] The value of the content hash.
* @member {object} [metadata] The metadata. * @property {object} [metadata] The metadata.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,7 +17,7 @@
class Correlation { class Correlation {
/** /**
* Create a Correlation. * Create a Correlation.
* @member {string} [clientTrackingId] The client tracking id. * @property {string} [clientTrackingId] The client tracking id.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,27 +17,27 @@
class EdifactAcknowledgementSettings { class EdifactAcknowledgementSettings {
/** /**
* Create a EdifactAcknowledgementSettings. * Create a EdifactAcknowledgementSettings.
* @member {boolean} needTechnicalAcknowledgement The value indicating * @property {boolean} needTechnicalAcknowledgement The value indicating
* whether technical acknowledgement is needed. * whether technical acknowledgement is needed.
* @member {boolean} batchTechnicalAcknowledgements The value indicating * @property {boolean} batchTechnicalAcknowledgements The value indicating
* whether to batch the technical acknowledgements. * whether to batch the technical acknowledgements.
* @member {boolean} needFunctionalAcknowledgement The value indicating * @property {boolean} needFunctionalAcknowledgement The value indicating
* whether functional acknowledgement is needed. * whether functional acknowledgement is needed.
* @member {boolean} batchFunctionalAcknowledgements The value indicating * @property {boolean} batchFunctionalAcknowledgements The value indicating
* whether to batch functional acknowledgements. * whether to batch functional acknowledgements.
* @member {boolean} needLoopForValidMessages The value indicating whether a * @property {boolean} needLoopForValidMessages The value indicating whether
* loop is needed for valid messages. * a loop is needed for valid messages.
* @member {boolean} sendSynchronousAcknowledgement The value indicating * @property {boolean} sendSynchronousAcknowledgement The value indicating
* whether to send synchronous acknowledgement. * whether to send synchronous acknowledgement.
* @member {string} [acknowledgementControlNumberPrefix] The acknowledgement * @property {string} [acknowledgementControlNumberPrefix] The
* control number prefix. * acknowledgement control number prefix.
* @member {string} [acknowledgementControlNumberSuffix] The acknowledgement * @property {string} [acknowledgementControlNumberSuffix] The
* control number suffix. * acknowledgement control number suffix.
* @member {number} acknowledgementControlNumberLowerBound The * @property {number} acknowledgementControlNumberLowerBound The
* acknowledgement control number lower bound. * acknowledgement control number lower bound.
* @member {number} acknowledgementControlNumberUpperBound The * @property {number} acknowledgementControlNumberUpperBound The
* acknowledgement control number upper bound. * acknowledgement control number upper bound.
* @member {boolean} rolloverAcknowledgementControlNumber The value * @property {boolean} rolloverAcknowledgementControlNumber The value
* indicating whether to rollover acknowledgement control number. * indicating whether to rollover acknowledgement control number.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,580 +17,582 @@
class EdifactAgreementContent { class EdifactAgreementContent {
/** /**
* Create a EdifactAgreementContent. * Create a EdifactAgreementContent.
* @member {object} receiveAgreement The EDIFACT one-way receive agreement. * @property {object} receiveAgreement The EDIFACT one-way receive agreement.
* @member {object} [receiveAgreement.senderBusinessIdentity] The sender * @property {object} [receiveAgreement.senderBusinessIdentity] The sender
* business identity * business identity
* @member {string} [receiveAgreement.senderBusinessIdentity.qualifier] The * @property {string} [receiveAgreement.senderBusinessIdentity.qualifier] The
* business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32
* @member {string} [receiveAgreement.senderBusinessIdentity.value] The user * @property {string} [receiveAgreement.senderBusinessIdentity.value] The
* defined business identity value.
* @member {object} [receiveAgreement.receiverBusinessIdentity] The receiver
* business identity
* @member {string} [receiveAgreement.receiverBusinessIdentity.qualifier] The
* business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32
* @member {string} [receiveAgreement.receiverBusinessIdentity.value] The
* user defined business identity value. * user defined business identity value.
* @member {object} [receiveAgreement.protocolSettings] The EDIFACT protocol * @property {object} [receiveAgreement.receiverBusinessIdentity] The
* settings. * receiver business identity
* @member {object} [receiveAgreement.protocolSettings.validationSettings] * @property {string} [receiveAgreement.receiverBusinessIdentity.qualifier]
* The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32
* @property {string} [receiveAgreement.receiverBusinessIdentity.value] The
* user defined business identity value.
* @property {object} [receiveAgreement.protocolSettings] The EDIFACT
* protocol settings.
* @property {object} [receiveAgreement.protocolSettings.validationSettings]
* The EDIFACT validation settings. * The EDIFACT validation settings.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.validationSettings.validateCharacterSet] * [receiveAgreement.protocolSettings.validationSettings.validateCharacterSet]
* The value indicating whether to validate character set in the message. * The value indicating whether to validate character set in the message.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] * [receiveAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber]
* The value indicating whether to check for duplicate interchange control * The value indicating whether to check for duplicate interchange control
* number. * number.
* @member {number} * @property {number}
* [receiveAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] * [receiveAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays]
* The validity period of interchange control number. * The validity period of interchange control number.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] * [receiveAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber]
* The value indicating whether to check for duplicate group control number. * The value indicating whether to check for duplicate group control number.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] * [receiveAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber]
* The value indicating whether to check for duplicate transaction set * The value indicating whether to check for duplicate transaction set
* control number. * control number.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.validationSettings.validateEdiTypes] * [receiveAgreement.protocolSettings.validationSettings.validateEdiTypes]
* The value indicating whether to Whether to validate EDI types. * The value indicating whether to Whether to validate EDI types.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.validationSettings.validateXsdTypes] * [receiveAgreement.protocolSettings.validationSettings.validateXsdTypes]
* The value indicating whether to Whether to validate XSD types. * The value indicating whether to Whether to validate XSD types.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] * [receiveAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes]
* The value indicating whether to allow leading and trailing spaces and * The value indicating whether to allow leading and trailing spaces and
* zeroes. * zeroes.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] * [receiveAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes]
* The value indicating whether to trim leading and trailing spaces and * The value indicating whether to trim leading and trailing spaces and
* zeroes. * zeroes.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] * [receiveAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy]
* The trailing separator policy. Possible values include: 'NotSpecified', * The trailing separator policy. Possible values include: 'NotSpecified',
* 'NotAllowed', 'Optional', 'Mandatory' * 'NotAllowed', 'Optional', 'Mandatory'
* @member {object} [receiveAgreement.protocolSettings.framingSettings] The * @property {object} [receiveAgreement.protocolSettings.framingSettings] The
* EDIFACT framing settings. * EDIFACT framing settings.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.framingSettings.serviceCodeListDirectoryVersion] * [receiveAgreement.protocolSettings.framingSettings.serviceCodeListDirectoryVersion]
* The service code list directory version. * The service code list directory version.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.framingSettings.characterEncoding] The * [receiveAgreement.protocolSettings.framingSettings.characterEncoding] The
* character encoding. * character encoding.
* @member {number} * @property {number}
* [receiveAgreement.protocolSettings.framingSettings.protocolVersion] The * [receiveAgreement.protocolSettings.framingSettings.protocolVersion] The
* protocol version. * protocol version.
* @member {number} * @property {number}
* [receiveAgreement.protocolSettings.framingSettings.dataElementSeparator] * [receiveAgreement.protocolSettings.framingSettings.dataElementSeparator]
* The data element separator. * The data element separator.
* @member {number} * @property {number}
* [receiveAgreement.protocolSettings.framingSettings.componentSeparator] The * [receiveAgreement.protocolSettings.framingSettings.componentSeparator] The
* component separator. * component separator.
* @member {number} * @property {number}
* [receiveAgreement.protocolSettings.framingSettings.segmentTerminator] The * [receiveAgreement.protocolSettings.framingSettings.segmentTerminator] The
* segment terminator. * segment terminator.
* @member {number} * @property {number}
* [receiveAgreement.protocolSettings.framingSettings.releaseIndicator] The * [receiveAgreement.protocolSettings.framingSettings.releaseIndicator] The
* release indicator. * release indicator.
* @member {number} * @property {number}
* [receiveAgreement.protocolSettings.framingSettings.repetitionSeparator] * [receiveAgreement.protocolSettings.framingSettings.repetitionSeparator]
* The repetition separator. * The repetition separator.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.framingSettings.characterSet] The * [receiveAgreement.protocolSettings.framingSettings.characterSet] The
* EDIFACT frame setting characterSet. Possible values include: * EDIFACT frame setting characterSet. Possible values include:
* 'NotSpecified', 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', * 'NotSpecified', 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG',
* 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA' * 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA'
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.framingSettings.decimalPointIndicator] * [receiveAgreement.protocolSettings.framingSettings.decimalPointIndicator]
* The EDIFACT frame setting decimal indicator. Possible values include: * The EDIFACT frame setting decimal indicator. Possible values include:
* 'NotSpecified', 'Comma', 'Decimal' * 'NotSpecified', 'Comma', 'Decimal'
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] * [receiveAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix]
* The EDIFACT frame setting segment terminator suffix. Possible values * The EDIFACT frame setting segment terminator suffix. Possible values
* include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' * include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF'
* @member {object} [receiveAgreement.protocolSettings.envelopeSettings] The * @property {object} [receiveAgreement.protocolSettings.envelopeSettings]
* EDIFACT envelope settings. * The EDIFACT envelope settings.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.groupAssociationAssignedCode] * [receiveAgreement.protocolSettings.envelopeSettings.groupAssociationAssignedCode]
* The group association assigned code. * The group association assigned code.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.communicationAgreementId] * [receiveAgreement.protocolSettings.envelopeSettings.communicationAgreementId]
* The communication agreement id. * The communication agreement id.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.envelopeSettings.applyDelimiterStringAdvice] * [receiveAgreement.protocolSettings.envelopeSettings.applyDelimiterStringAdvice]
* The value indicating whether to apply delimiter string advice. * The value indicating whether to apply delimiter string advice.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.envelopeSettings.createGroupingSegments] * [receiveAgreement.protocolSettings.envelopeSettings.createGroupingSegments]
* The value indicating whether to create grouping segments. * The value indicating whether to create grouping segments.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] * [receiveAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders]
* The value indicating whether to enable default group headers. * The value indicating whether to enable default group headers.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordValue] * [receiveAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordValue]
* The recipient reference password value. * The recipient reference password value.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordQualifier] * [receiveAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordQualifier]
* The recipient reference password qualifier. * The recipient reference password qualifier.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.applicationReferenceId] * [receiveAgreement.protocolSettings.envelopeSettings.applicationReferenceId]
* The application reference id. * The application reference id.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.processingPriorityCode] * [receiveAgreement.protocolSettings.envelopeSettings.processingPriorityCode]
* The processing priority code. * The processing priority code.
* @member {number} * @property {number}
* [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] * [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound]
* The interchange control number lower bound. * The interchange control number lower bound.
* @member {number} * @property {number}
* [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] * [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound]
* The interchange control number upper bound. * The interchange control number upper bound.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] * [receiveAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber]
* The value indicating whether to rollover interchange control number. * The value indicating whether to rollover interchange control number.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberPrefix] * [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberPrefix]
* The interchange control number prefix. * The interchange control number prefix.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberSuffix] * [receiveAgreement.protocolSettings.envelopeSettings.interchangeControlNumberSuffix]
* The interchange control number suffix. * The interchange control number suffix.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.senderReverseRoutingAddress] * [receiveAgreement.protocolSettings.envelopeSettings.senderReverseRoutingAddress]
* The sender reverse routing address. * The sender reverse routing address.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.receiverReverseRoutingAddress] * [receiveAgreement.protocolSettings.envelopeSettings.receiverReverseRoutingAddress]
* The receiver reverse routing address. * The receiver reverse routing address.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.functionalGroupId] The * [receiveAgreement.protocolSettings.envelopeSettings.functionalGroupId] The
* functional group id. * functional group id.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.groupControllingAgencyCode] * [receiveAgreement.protocolSettings.envelopeSettings.groupControllingAgencyCode]
* The group controlling agency code. * The group controlling agency code.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.groupMessageVersion] * [receiveAgreement.protocolSettings.envelopeSettings.groupMessageVersion]
* The group message version. * The group message version.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.groupMessageRelease] * [receiveAgreement.protocolSettings.envelopeSettings.groupMessageRelease]
* The group message release. * The group message release.
* @member {number} * @property {number}
* [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] * [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound]
* The group control number lower bound. * The group control number lower bound.
* @member {number} * @property {number}
* [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] * [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound]
* The group control number upper bound. * The group control number upper bound.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] * [receiveAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber]
* The value indicating whether to rollover group control number. * The value indicating whether to rollover group control number.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberPrefix] * [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberPrefix]
* The group control number prefix. * The group control number prefix.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberSuffix] * [receiveAgreement.protocolSettings.envelopeSettings.groupControlNumberSuffix]
* The group control number suffix. * The group control number suffix.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverQualifier] * [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverQualifier]
* The group application receiver qualifier. * The group application receiver qualifier.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverId] * [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverId]
* The group application receiver id. * The group application receiver id.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationSenderQualifier] * [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationSenderQualifier]
* The group application sender qualifier. * The group application sender qualifier.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationSenderId] * [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationSenderId]
* The group application sender id. * The group application sender id.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationPassword] * [receiveAgreement.protocolSettings.envelopeSettings.groupApplicationPassword]
* The group application password. * The group application password.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] * [receiveAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber]
* The value indicating whether to overwrite existing transaction set control * The value indicating whether to overwrite existing transaction set control
* number. * number.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix]
* The transaction set control number prefix. * The transaction set control number prefix.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix]
* The transaction set control number suffix. * The transaction set control number suffix.
* @member {number} * @property {number}
* [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound]
* The transaction set control number lower bound. * The transaction set control number lower bound.
* @member {number} * @property {number}
* [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] * [receiveAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound]
* The transaction set control number upper bound. * The transaction set control number upper bound.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] * [receiveAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber]
* The value indicating whether to rollover transaction set control number. * The value indicating whether to rollover transaction set control number.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.envelopeSettings.isTestInterchange] The * [receiveAgreement.protocolSettings.envelopeSettings.isTestInterchange] The
* value indicating whether the message is a test interchange. * value indicating whether the message is a test interchange.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.senderInternalIdentification] * [receiveAgreement.protocolSettings.envelopeSettings.senderInternalIdentification]
* The sender internal identification. * The sender internal identification.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.senderInternalSubIdentification] * [receiveAgreement.protocolSettings.envelopeSettings.senderInternalSubIdentification]
* The sender internal sub identification. * The sender internal sub identification.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.receiverInternalIdentification] * [receiveAgreement.protocolSettings.envelopeSettings.receiverInternalIdentification]
* The receiver internal identification. * The receiver internal identification.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.envelopeSettings.receiverInternalSubIdentification] * [receiveAgreement.protocolSettings.envelopeSettings.receiverInternalSubIdentification]
* The receiver internal sub identification. * The receiver internal sub identification.
* @member {object} * @property {object}
* [receiveAgreement.protocolSettings.acknowledgementSettings] The EDIFACT * [receiveAgreement.protocolSettings.acknowledgementSettings] The EDIFACT
* acknowledgement settings. * acknowledgement settings.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] * [receiveAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement]
* The value indicating whether technical acknowledgement is needed. * The value indicating whether technical acknowledgement is needed.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] * [receiveAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements]
* The value indicating whether to batch the technical acknowledgements. * The value indicating whether to batch the technical acknowledgements.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] * [receiveAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement]
* The value indicating whether functional acknowledgement is needed. * The value indicating whether functional acknowledgement is needed.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] * [receiveAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements]
* The value indicating whether to batch functional acknowledgements. * The value indicating whether to batch functional acknowledgements.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] * [receiveAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages]
* The value indicating whether a loop is needed for valid messages. * The value indicating whether a loop is needed for valid messages.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] * [receiveAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement]
* The value indicating whether to send synchronous acknowledgement. * The value indicating whether to send synchronous acknowledgement.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix]
* The acknowledgement control number prefix. * The acknowledgement control number prefix.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix]
* The acknowledgement control number suffix. * The acknowledgement control number suffix.
* @member {number} * @property {number}
* [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound]
* The acknowledgement control number lower bound. * The acknowledgement control number lower bound.
* @member {number} * @property {number}
* [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] * [receiveAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound]
* The acknowledgement control number upper bound. * The acknowledgement control number upper bound.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] * [receiveAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber]
* The value indicating whether to rollover acknowledgement control number. * The value indicating whether to rollover acknowledgement control number.
* @member {object} [receiveAgreement.protocolSettings.messageFilter] The * @property {object} [receiveAgreement.protocolSettings.messageFilter] The
* EDIFACT message filter. * EDIFACT message filter.
* @member {string} * @property {string}
* [receiveAgreement.protocolSettings.messageFilter.messageFilterType] The * [receiveAgreement.protocolSettings.messageFilter.messageFilterType] The
* message filter type. Possible values include: 'NotSpecified', 'Include', * message filter type. Possible values include: 'NotSpecified', 'Include',
* 'Exclude' * 'Exclude'
* @member {object} [receiveAgreement.protocolSettings.processingSettings] * @property {object} [receiveAgreement.protocolSettings.processingSettings]
* The EDIFACT processing Settings. * The EDIFACT processing Settings.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.processingSettings.maskSecurityInfo] * [receiveAgreement.protocolSettings.processingSettings.maskSecurityInfo]
* The value indicating whether to mask security information. * The value indicating whether to mask security information.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.processingSettings.preserveInterchange] * [receiveAgreement.protocolSettings.processingSettings.preserveInterchange]
* The value indicating whether to preserve interchange. * The value indicating whether to preserve interchange.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] * [receiveAgreement.protocolSettings.processingSettings.suspendInterchangeOnError]
* The value indicating whether to suspend interchange on error. * The value indicating whether to suspend interchange on error.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] * [receiveAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators]
* The value indicating whether to create empty xml tags for trailing * The value indicating whether to create empty xml tags for trailing
* separators. * separators.
* @member {boolean} * @property {boolean}
* [receiveAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] * [receiveAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator]
* The value indicating whether to use dot as decimal separator. * The value indicating whether to use dot as decimal separator.
* @member {array} [receiveAgreement.protocolSettings.envelopeOverrides] The * @property {array} [receiveAgreement.protocolSettings.envelopeOverrides]
* EDIFACT envelope override settings. * The EDIFACT envelope override settings.
* @member {array} [receiveAgreement.protocolSettings.messageFilterList] The * @property {array} [receiveAgreement.protocolSettings.messageFilterList]
* EDIFACT message filter list. * The EDIFACT message filter list.
* @member {array} [receiveAgreement.protocolSettings.schemaReferences] The * @property {array} [receiveAgreement.protocolSettings.schemaReferences] The
* EDIFACT schema references. * EDIFACT schema references.
* @member {array} [receiveAgreement.protocolSettings.validationOverrides] * @property {array} [receiveAgreement.protocolSettings.validationOverrides]
* The EDIFACT validation override settings. * The EDIFACT validation override settings.
* @member {array} * @property {array}
* [receiveAgreement.protocolSettings.edifactDelimiterOverrides] The EDIFACT * [receiveAgreement.protocolSettings.edifactDelimiterOverrides] The EDIFACT
* delimiter override settings. * delimiter override settings.
* @member {object} sendAgreement The EDIFACT one-way send agreement. * @property {object} sendAgreement The EDIFACT one-way send agreement.
* @member {object} [sendAgreement.senderBusinessIdentity] The sender * @property {object} [sendAgreement.senderBusinessIdentity] The sender
* business identity * business identity
* @member {string} [sendAgreement.senderBusinessIdentity.qualifier] The * @property {string} [sendAgreement.senderBusinessIdentity.qualifier] The
* business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32
* @member {string} [sendAgreement.senderBusinessIdentity.value] The user * @property {string} [sendAgreement.senderBusinessIdentity.value] The user
* defined business identity value. * defined business identity value.
* @member {object} [sendAgreement.receiverBusinessIdentity] The receiver * @property {object} [sendAgreement.receiverBusinessIdentity] The receiver
* business identity * business identity
* @member {string} [sendAgreement.receiverBusinessIdentity.qualifier] The * @property {string} [sendAgreement.receiverBusinessIdentity.qualifier] The
* business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 * business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32
* @member {string} [sendAgreement.receiverBusinessIdentity.value] The user * @property {string} [sendAgreement.receiverBusinessIdentity.value] The user
* defined business identity value. * defined business identity value.
* @member {object} [sendAgreement.protocolSettings] The EDIFACT protocol * @property {object} [sendAgreement.protocolSettings] The EDIFACT protocol
* settings. * settings.
* @member {object} [sendAgreement.protocolSettings.validationSettings] The * @property {object} [sendAgreement.protocolSettings.validationSettings] The
* EDIFACT validation settings. * EDIFACT validation settings.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.validationSettings.validateCharacterSet] * [sendAgreement.protocolSettings.validationSettings.validateCharacterSet]
* The value indicating whether to validate character set in the message. * The value indicating whether to validate character set in the message.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] * [sendAgreement.protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber]
* The value indicating whether to check for duplicate interchange control * The value indicating whether to check for duplicate interchange control
* number. * number.
* @member {number} * @property {number}
* [sendAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays] * [sendAgreement.protocolSettings.validationSettings.interchangeControlNumberValidityDays]
* The validity period of interchange control number. * The validity period of interchange control number.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber] * [sendAgreement.protocolSettings.validationSettings.checkDuplicateGroupControlNumber]
* The value indicating whether to check for duplicate group control number. * The value indicating whether to check for duplicate group control number.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] * [sendAgreement.protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber]
* The value indicating whether to check for duplicate transaction set * The value indicating whether to check for duplicate transaction set
* control number. * control number.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.validationSettings.validateEdiTypes] The * [sendAgreement.protocolSettings.validationSettings.validateEdiTypes] The
* value indicating whether to Whether to validate EDI types. * value indicating whether to Whether to validate EDI types.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.validationSettings.validateXsdTypes] The * [sendAgreement.protocolSettings.validationSettings.validateXsdTypes] The
* value indicating whether to Whether to validate XSD types. * value indicating whether to Whether to validate XSD types.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] * [sendAgreement.protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes]
* The value indicating whether to allow leading and trailing spaces and * The value indicating whether to allow leading and trailing spaces and
* zeroes. * zeroes.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] * [sendAgreement.protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes]
* The value indicating whether to trim leading and trailing spaces and * The value indicating whether to trim leading and trailing spaces and
* zeroes. * zeroes.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy] * [sendAgreement.protocolSettings.validationSettings.trailingSeparatorPolicy]
* The trailing separator policy. Possible values include: 'NotSpecified', * The trailing separator policy. Possible values include: 'NotSpecified',
* 'NotAllowed', 'Optional', 'Mandatory' * 'NotAllowed', 'Optional', 'Mandatory'
* @member {object} [sendAgreement.protocolSettings.framingSettings] The * @property {object} [sendAgreement.protocolSettings.framingSettings] The
* EDIFACT framing settings. * EDIFACT framing settings.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.framingSettings.serviceCodeListDirectoryVersion] * [sendAgreement.protocolSettings.framingSettings.serviceCodeListDirectoryVersion]
* The service code list directory version. * The service code list directory version.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.framingSettings.characterEncoding] The * [sendAgreement.protocolSettings.framingSettings.characterEncoding] The
* character encoding. * character encoding.
* @member {number} * @property {number}
* [sendAgreement.protocolSettings.framingSettings.protocolVersion] The * [sendAgreement.protocolSettings.framingSettings.protocolVersion] The
* protocol version. * protocol version.
* @member {number} * @property {number}
* [sendAgreement.protocolSettings.framingSettings.dataElementSeparator] The * [sendAgreement.protocolSettings.framingSettings.dataElementSeparator] The
* data element separator. * data element separator.
* @member {number} * @property {number}
* [sendAgreement.protocolSettings.framingSettings.componentSeparator] The * [sendAgreement.protocolSettings.framingSettings.componentSeparator] The
* component separator. * component separator.
* @member {number} * @property {number}
* [sendAgreement.protocolSettings.framingSettings.segmentTerminator] The * [sendAgreement.protocolSettings.framingSettings.segmentTerminator] The
* segment terminator. * segment terminator.
* @member {number} * @property {number}
* [sendAgreement.protocolSettings.framingSettings.releaseIndicator] The * [sendAgreement.protocolSettings.framingSettings.releaseIndicator] The
* release indicator. * release indicator.
* @member {number} * @property {number}
* [sendAgreement.protocolSettings.framingSettings.repetitionSeparator] The * [sendAgreement.protocolSettings.framingSettings.repetitionSeparator] The
* repetition separator. * repetition separator.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.framingSettings.characterSet] The EDIFACT * [sendAgreement.protocolSettings.framingSettings.characterSet] The EDIFACT
* frame setting characterSet. Possible values include: 'NotSpecified', * frame setting characterSet. Possible values include: 'NotSpecified',
* 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', * 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI',
* 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA' * 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA'
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.framingSettings.decimalPointIndicator] The * [sendAgreement.protocolSettings.framingSettings.decimalPointIndicator] The
* EDIFACT frame setting decimal indicator. Possible values include: * EDIFACT frame setting decimal indicator. Possible values include:
* 'NotSpecified', 'Comma', 'Decimal' * 'NotSpecified', 'Comma', 'Decimal'
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix] * [sendAgreement.protocolSettings.framingSettings.segmentTerminatorSuffix]
* The EDIFACT frame setting segment terminator suffix. Possible values * The EDIFACT frame setting segment terminator suffix. Possible values
* include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' * include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF'
* @member {object} [sendAgreement.protocolSettings.envelopeSettings] The * @property {object} [sendAgreement.protocolSettings.envelopeSettings] The
* EDIFACT envelope settings. * EDIFACT envelope settings.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.groupAssociationAssignedCode] * [sendAgreement.protocolSettings.envelopeSettings.groupAssociationAssignedCode]
* The group association assigned code. * The group association assigned code.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.communicationAgreementId] * [sendAgreement.protocolSettings.envelopeSettings.communicationAgreementId]
* The communication agreement id. * The communication agreement id.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.envelopeSettings.applyDelimiterStringAdvice] * [sendAgreement.protocolSettings.envelopeSettings.applyDelimiterStringAdvice]
* The value indicating whether to apply delimiter string advice. * The value indicating whether to apply delimiter string advice.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.envelopeSettings.createGroupingSegments] * [sendAgreement.protocolSettings.envelopeSettings.createGroupingSegments]
* The value indicating whether to create grouping segments. * The value indicating whether to create grouping segments.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders] * [sendAgreement.protocolSettings.envelopeSettings.enableDefaultGroupHeaders]
* The value indicating whether to enable default group headers. * The value indicating whether to enable default group headers.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordValue] * [sendAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordValue]
* The recipient reference password value. * The recipient reference password value.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordQualifier] * [sendAgreement.protocolSettings.envelopeSettings.recipientReferencePasswordQualifier]
* The recipient reference password qualifier. * The recipient reference password qualifier.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.applicationReferenceId] * [sendAgreement.protocolSettings.envelopeSettings.applicationReferenceId]
* The application reference id. * The application reference id.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.processingPriorityCode] * [sendAgreement.protocolSettings.envelopeSettings.processingPriorityCode]
* The processing priority code. * The processing priority code.
* @member {number} * @property {number}
* [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] * [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberLowerBound]
* The interchange control number lower bound. * The interchange control number lower bound.
* @member {number} * @property {number}
* [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] * [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberUpperBound]
* The interchange control number upper bound. * The interchange control number upper bound.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] * [sendAgreement.protocolSettings.envelopeSettings.rolloverInterchangeControlNumber]
* The value indicating whether to rollover interchange control number. * The value indicating whether to rollover interchange control number.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberPrefix] * [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberPrefix]
* The interchange control number prefix. * The interchange control number prefix.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberSuffix] * [sendAgreement.protocolSettings.envelopeSettings.interchangeControlNumberSuffix]
* The interchange control number suffix. * The interchange control number suffix.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.senderReverseRoutingAddress] * [sendAgreement.protocolSettings.envelopeSettings.senderReverseRoutingAddress]
* The sender reverse routing address. * The sender reverse routing address.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.receiverReverseRoutingAddress] * [sendAgreement.protocolSettings.envelopeSettings.receiverReverseRoutingAddress]
* The receiver reverse routing address. * The receiver reverse routing address.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.functionalGroupId] The * [sendAgreement.protocolSettings.envelopeSettings.functionalGroupId] The
* functional group id. * functional group id.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.groupControllingAgencyCode] * [sendAgreement.protocolSettings.envelopeSettings.groupControllingAgencyCode]
* The group controlling agency code. * The group controlling agency code.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.groupMessageVersion] The * [sendAgreement.protocolSettings.envelopeSettings.groupMessageVersion] The
* group message version. * group message version.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.groupMessageRelease] The * [sendAgreement.protocolSettings.envelopeSettings.groupMessageRelease] The
* group message release. * group message release.
* @member {number} * @property {number}
* [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound] * [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberLowerBound]
* The group control number lower bound. * The group control number lower bound.
* @member {number} * @property {number}
* [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound] * [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberUpperBound]
* The group control number upper bound. * The group control number upper bound.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber] * [sendAgreement.protocolSettings.envelopeSettings.rolloverGroupControlNumber]
* The value indicating whether to rollover group control number. * The value indicating whether to rollover group control number.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberPrefix] * [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberPrefix]
* The group control number prefix. * The group control number prefix.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberSuffix] * [sendAgreement.protocolSettings.envelopeSettings.groupControlNumberSuffix]
* The group control number suffix. * The group control number suffix.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverQualifier] * [sendAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverQualifier]
* The group application receiver qualifier. * The group application receiver qualifier.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverId] * [sendAgreement.protocolSettings.envelopeSettings.groupApplicationReceiverId]
* The group application receiver id. * The group application receiver id.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.groupApplicationSenderQualifier] * [sendAgreement.protocolSettings.envelopeSettings.groupApplicationSenderQualifier]
* The group application sender qualifier. * The group application sender qualifier.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.groupApplicationSenderId] * [sendAgreement.protocolSettings.envelopeSettings.groupApplicationSenderId]
* The group application sender id. * The group application sender id.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.groupApplicationPassword] * [sendAgreement.protocolSettings.envelopeSettings.groupApplicationPassword]
* The group application password. * The group application password.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] * [sendAgreement.protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber]
* The value indicating whether to overwrite existing transaction set control * The value indicating whether to overwrite existing transaction set control
* number. * number.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberPrefix]
* The transaction set control number prefix. * The transaction set control number prefix.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberSuffix]
* The transaction set control number suffix. * The transaction set control number suffix.
* @member {number} * @property {number}
* [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound]
* The transaction set control number lower bound. * The transaction set control number lower bound.
* @member {number} * @property {number}
* [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] * [sendAgreement.protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound]
* The transaction set control number upper bound. * The transaction set control number upper bound.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] * [sendAgreement.protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber]
* The value indicating whether to rollover transaction set control number. * The value indicating whether to rollover transaction set control number.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.envelopeSettings.isTestInterchange] The * [sendAgreement.protocolSettings.envelopeSettings.isTestInterchange] The
* value indicating whether the message is a test interchange. * value indicating whether the message is a test interchange.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.senderInternalIdentification] * [sendAgreement.protocolSettings.envelopeSettings.senderInternalIdentification]
* The sender internal identification. * The sender internal identification.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.senderInternalSubIdentification] * [sendAgreement.protocolSettings.envelopeSettings.senderInternalSubIdentification]
* The sender internal sub identification. * The sender internal sub identification.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.receiverInternalIdentification] * [sendAgreement.protocolSettings.envelopeSettings.receiverInternalIdentification]
* The receiver internal identification. * The receiver internal identification.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.envelopeSettings.receiverInternalSubIdentification] * [sendAgreement.protocolSettings.envelopeSettings.receiverInternalSubIdentification]
* The receiver internal sub identification. * The receiver internal sub identification.
* @member {object} [sendAgreement.protocolSettings.acknowledgementSettings] * @property {object}
* The EDIFACT acknowledgement settings. * [sendAgreement.protocolSettings.acknowledgementSettings] The EDIFACT
* @member {boolean} * acknowledgement settings.
* @property {boolean}
* [sendAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] * [sendAgreement.protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement]
* The value indicating whether technical acknowledgement is needed. * The value indicating whether technical acknowledgement is needed.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] * [sendAgreement.protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements]
* The value indicating whether to batch the technical acknowledgements. * The value indicating whether to batch the technical acknowledgements.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] * [sendAgreement.protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement]
* The value indicating whether functional acknowledgement is needed. * The value indicating whether functional acknowledgement is needed.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] * [sendAgreement.protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements]
* The value indicating whether to batch functional acknowledgements. * The value indicating whether to batch functional acknowledgements.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages] * [sendAgreement.protocolSettings.acknowledgementSettings.needLoopForValidMessages]
* The value indicating whether a loop is needed for valid messages. * The value indicating whether a loop is needed for valid messages.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] * [sendAgreement.protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement]
* The value indicating whether to send synchronous acknowledgement. * The value indicating whether to send synchronous acknowledgement.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix]
* The acknowledgement control number prefix. * The acknowledgement control number prefix.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix]
* The acknowledgement control number suffix. * The acknowledgement control number suffix.
* @member {number} * @property {number}
* [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound]
* The acknowledgement control number lower bound. * The acknowledgement control number lower bound.
* @member {number} * @property {number}
* [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] * [sendAgreement.protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound]
* The acknowledgement control number upper bound. * The acknowledgement control number upper bound.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] * [sendAgreement.protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber]
* The value indicating whether to rollover acknowledgement control number. * The value indicating whether to rollover acknowledgement control number.
* @member {object} [sendAgreement.protocolSettings.messageFilter] The * @property {object} [sendAgreement.protocolSettings.messageFilter] The
* EDIFACT message filter. * EDIFACT message filter.
* @member {string} * @property {string}
* [sendAgreement.protocolSettings.messageFilter.messageFilterType] The * [sendAgreement.protocolSettings.messageFilter.messageFilterType] The
* message filter type. Possible values include: 'NotSpecified', 'Include', * message filter type. Possible values include: 'NotSpecified', 'Include',
* 'Exclude' * 'Exclude'
* @member {object} [sendAgreement.protocolSettings.processingSettings] The * @property {object} [sendAgreement.protocolSettings.processingSettings] The
* EDIFACT processing Settings. * EDIFACT processing Settings.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.processingSettings.maskSecurityInfo] The * [sendAgreement.protocolSettings.processingSettings.maskSecurityInfo] The
* value indicating whether to mask security information. * value indicating whether to mask security information.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.processingSettings.preserveInterchange] * [sendAgreement.protocolSettings.processingSettings.preserveInterchange]
* The value indicating whether to preserve interchange. * The value indicating whether to preserve interchange.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.processingSettings.suspendInterchangeOnError] * [sendAgreement.protocolSettings.processingSettings.suspendInterchangeOnError]
* The value indicating whether to suspend interchange on error. * The value indicating whether to suspend interchange on error.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] * [sendAgreement.protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators]
* The value indicating whether to create empty xml tags for trailing * The value indicating whether to create empty xml tags for trailing
* separators. * separators.
* @member {boolean} * @property {boolean}
* [sendAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator] * [sendAgreement.protocolSettings.processingSettings.useDotAsDecimalSeparator]
* The value indicating whether to use dot as decimal separator. * The value indicating whether to use dot as decimal separator.
* @member {array} [sendAgreement.protocolSettings.envelopeOverrides] The * @property {array} [sendAgreement.protocolSettings.envelopeOverrides] The
* EDIFACT envelope override settings. * EDIFACT envelope override settings.
* @member {array} [sendAgreement.protocolSettings.messageFilterList] The * @property {array} [sendAgreement.protocolSettings.messageFilterList] The
* EDIFACT message filter list. * EDIFACT message filter list.
* @member {array} [sendAgreement.protocolSettings.schemaReferences] The * @property {array} [sendAgreement.protocolSettings.schemaReferences] The
* EDIFACT schema references. * EDIFACT schema references.
* @member {array} [sendAgreement.protocolSettings.validationOverrides] The * @property {array} [sendAgreement.protocolSettings.validationOverrides] The
* EDIFACT validation override settings. * EDIFACT validation override settings.
* @member {array} [sendAgreement.protocolSettings.edifactDelimiterOverrides] * @property {array}
* The EDIFACT delimiter override settings. * [sendAgreement.protocolSettings.edifactDelimiterOverrides] The EDIFACT
* delimiter override settings.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,21 +17,21 @@
class EdifactDelimiterOverride { class EdifactDelimiterOverride {
/** /**
* Create a EdifactDelimiterOverride. * Create a EdifactDelimiterOverride.
* @member {string} [messageId] The message id. * @property {string} [messageId] The message id.
* @member {string} [messageVersion] The message version. * @property {string} [messageVersion] The message version.
* @member {string} [messageRelease] The message release. * @property {string} [messageRelease] The message release.
* @member {number} dataElementSeparator The data element separator. * @property {number} dataElementSeparator The data element separator.
* @member {number} componentSeparator The component separator. * @property {number} componentSeparator The component separator.
* @member {number} segmentTerminator The segment terminator. * @property {number} segmentTerminator The segment terminator.
* @member {number} repetitionSeparator The repetition separator. * @property {number} repetitionSeparator The repetition separator.
* @member {string} segmentTerminatorSuffix The segment terminator suffix. * @property {string} segmentTerminatorSuffix The segment terminator suffix.
* Possible values include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' * Possible values include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF'
* @member {string} decimalPointIndicator The decimal point indicator. * @property {string} decimalPointIndicator The decimal point indicator.
* Possible values include: 'NotSpecified', 'Comma', 'Decimal' * Possible values include: 'NotSpecified', 'Comma', 'Decimal'
* @member {number} releaseIndicator The release indicator. * @property {number} releaseIndicator The release indicator.
* @member {string} [messageAssociationAssignedCode] The message association * @property {string} [messageAssociationAssignedCode] The message
* assigned code. * association assigned code.
* @member {string} [targetNamespace] The target namespace on which this * @property {string} [targetNamespace] The target namespace on which this
* delimiter settings has to be applied. * delimiter settings has to be applied.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,30 +17,31 @@
class EdifactEnvelopeOverride { class EdifactEnvelopeOverride {
/** /**
* Create a EdifactEnvelopeOverride. * Create a EdifactEnvelopeOverride.
* @member {string} [messageId] The message id on which this envelope * @property {string} [messageId] The message id on which this envelope
* settings has to be applied. * settings has to be applied.
* @member {string} [messageVersion] The message version on which this * @property {string} [messageVersion] The message version on which this
* envelope settings has to be applied. * envelope settings has to be applied.
* @member {string} [messageRelease] The message release version on which * @property {string} [messageRelease] The message release version on which
* this envelope settings has to be applied. * this envelope settings has to be applied.
* @member {string} [messageAssociationAssignedCode] The message association * @property {string} [messageAssociationAssignedCode] The message
* assigned code. * association assigned code.
* @member {string} [targetNamespace] The target namespace on which this * @property {string} [targetNamespace] The target namespace on which this
* envelope settings has to be applied. * envelope settings has to be applied.
* @member {string} [functionalGroupId] The functional group id. * @property {string} [functionalGroupId] The functional group id.
* @member {string} [senderApplicationQualifier] The sender application * @property {string} [senderApplicationQualifier] The sender application
* qualifier. * qualifier.
* @member {string} [senderApplicationId] The sender application id. * @property {string} [senderApplicationId] The sender application id.
* @member {string} [receiverApplicationQualifier] The receiver application * @property {string} [receiverApplicationQualifier] The receiver application
* qualifier. * qualifier.
* @member {string} [receiverApplicationId] The receiver application id. * @property {string} [receiverApplicationId] The receiver application id.
* @member {string} [controllingAgencyCode] The controlling agency code. * @property {string} [controllingAgencyCode] The controlling agency code.
* @member {string} [groupHeaderMessageVersion] The group header message * @property {string} [groupHeaderMessageVersion] The group header message
* version. * version.
* @member {string} [groupHeaderMessageRelease] The group header message * @property {string} [groupHeaderMessageRelease] The group header message
* release. * release.
* @member {string} [associationAssignedCode] The association assigned code. * @property {string} [associationAssignedCode] The association assigned
* @member {string} [applicationPassword] The application password. * code.
* @property {string} [applicationPassword] The application password.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,83 +17,83 @@
class EdifactEnvelopeSettings { class EdifactEnvelopeSettings {
/** /**
* Create a EdifactEnvelopeSettings. * Create a EdifactEnvelopeSettings.
* @member {string} [groupAssociationAssignedCode] The group association * @property {string} [groupAssociationAssignedCode] The group association
* assigned code. * assigned code.
* @member {string} [communicationAgreementId] The communication agreement * @property {string} [communicationAgreementId] The communication agreement
* id. * id.
* @member {boolean} applyDelimiterStringAdvice The value indicating whether * @property {boolean} applyDelimiterStringAdvice The value indicating
* to apply delimiter string advice. * whether to apply delimiter string advice.
* @member {boolean} createGroupingSegments The value indicating whether to * @property {boolean} createGroupingSegments The value indicating whether to
* create grouping segments. * create grouping segments.
* @member {boolean} enableDefaultGroupHeaders The value indicating whether * @property {boolean} enableDefaultGroupHeaders The value indicating whether
* to enable default group headers. * to enable default group headers.
* @member {string} [recipientReferencePasswordValue] The recipient reference * @property {string} [recipientReferencePasswordValue] The recipient
* password value. * reference password value.
* @member {string} [recipientReferencePasswordQualifier] The recipient * @property {string} [recipientReferencePasswordQualifier] The recipient
* reference password qualifier. * reference password qualifier.
* @member {string} [applicationReferenceId] The application reference id. * @property {string} [applicationReferenceId] The application reference id.
* @member {string} [processingPriorityCode] The processing priority code. * @property {string} [processingPriorityCode] The processing priority code.
* @member {number} interchangeControlNumberLowerBound The interchange * @property {number} interchangeControlNumberLowerBound The interchange
* control number lower bound. * control number lower bound.
* @member {number} interchangeControlNumberUpperBound The interchange * @property {number} interchangeControlNumberUpperBound The interchange
* control number upper bound. * control number upper bound.
* @member {boolean} rolloverInterchangeControlNumber The value indicating * @property {boolean} rolloverInterchangeControlNumber The value indicating
* whether to rollover interchange control number. * whether to rollover interchange control number.
* @member {string} [interchangeControlNumberPrefix] The interchange control * @property {string} [interchangeControlNumberPrefix] The interchange
* number prefix.
* @member {string} [interchangeControlNumberSuffix] The interchange control
* number suffix.
* @member {string} [senderReverseRoutingAddress] The sender reverse routing
* address.
* @member {string} [receiverReverseRoutingAddress] The receiver reverse
* routing address.
* @member {string} [functionalGroupId] The functional group id.
* @member {string} [groupControllingAgencyCode] The group controlling agency
* code.
* @member {string} [groupMessageVersion] The group message version.
* @member {string} [groupMessageRelease] The group message release.
* @member {number} groupControlNumberLowerBound The group control number
* lower bound.
* @member {number} groupControlNumberUpperBound The group control number
* upper bound.
* @member {boolean} rolloverGroupControlNumber The value indicating whether
* to rollover group control number.
* @member {string} [groupControlNumberPrefix] The group control number
* prefix.
* @member {string} [groupControlNumberSuffix] The group control number
* suffix.
* @member {string} [groupApplicationReceiverQualifier] The group application
* receiver qualifier.
* @member {string} [groupApplicationReceiverId] The group application
* receiver id.
* @member {string} [groupApplicationSenderQualifier] The group application
* sender qualifier.
* @member {string} [groupApplicationSenderId] The group application sender
* id.
* @member {string} [groupApplicationPassword] The group application
* password.
* @member {boolean} overwriteExistingTransactionSetControlNumber The value
* indicating whether to overwrite existing transaction set control number.
* @member {string} [transactionSetControlNumberPrefix] The transaction set
* control number prefix. * control number prefix.
* @member {string} [transactionSetControlNumberSuffix] The transaction set * @property {string} [interchangeControlNumberSuffix] The interchange
* control number suffix. * control number suffix.
* @member {number} transactionSetControlNumberLowerBound The transaction set * @property {string} [senderReverseRoutingAddress] The sender reverse
* control number lower bound. * routing address.
* @member {number} transactionSetControlNumberUpperBound The transaction set * @property {string} [receiverReverseRoutingAddress] The receiver reverse
* control number upper bound. * routing address.
* @member {boolean} rolloverTransactionSetControlNumber The value indicating * @property {string} [functionalGroupId] The functional group id.
* whether to rollover transaction set control number. * @property {string} [groupControllingAgencyCode] The group controlling
* @member {boolean} isTestInterchange The value indicating whether the * agency code.
* @property {string} [groupMessageVersion] The group message version.
* @property {string} [groupMessageRelease] The group message release.
* @property {number} groupControlNumberLowerBound The group control number
* lower bound.
* @property {number} groupControlNumberUpperBound The group control number
* upper bound.
* @property {boolean} rolloverGroupControlNumber The value indicating
* whether to rollover group control number.
* @property {string} [groupControlNumberPrefix] The group control number
* prefix.
* @property {string} [groupControlNumberSuffix] The group control number
* suffix.
* @property {string} [groupApplicationReceiverQualifier] The group
* application receiver qualifier.
* @property {string} [groupApplicationReceiverId] The group application
* receiver id.
* @property {string} [groupApplicationSenderQualifier] The group application
* sender qualifier.
* @property {string} [groupApplicationSenderId] The group application sender
* id.
* @property {string} [groupApplicationPassword] The group application
* password.
* @property {boolean} overwriteExistingTransactionSetControlNumber The value
* indicating whether to overwrite existing transaction set control number.
* @property {string} [transactionSetControlNumberPrefix] The transaction set
* control number prefix.
* @property {string} [transactionSetControlNumberSuffix] The transaction set
* control number suffix.
* @property {number} transactionSetControlNumberLowerBound The transaction
* set control number lower bound.
* @property {number} transactionSetControlNumberUpperBound The transaction
* set control number upper bound.
* @property {boolean} rolloverTransactionSetControlNumber The value
* indicating whether to rollover transaction set control number.
* @property {boolean} isTestInterchange The value indicating whether the
* message is a test interchange. * message is a test interchange.
* @member {string} [senderInternalIdentification] The sender internal * @property {string} [senderInternalIdentification] The sender internal
* identification. * identification.
* @member {string} [senderInternalSubIdentification] The sender internal sub * @property {string} [senderInternalSubIdentification] The sender internal
* identification.
* @member {string} [receiverInternalIdentification] The receiver internal
* identification.
* @member {string} [receiverInternalSubIdentification] The receiver internal
* sub identification. * sub identification.
* @property {string} [receiverInternalIdentification] The receiver internal
* identification.
* @property {string} [receiverInternalSubIdentification] The receiver
* internal sub identification.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,24 +17,24 @@
class EdifactFramingSettings { class EdifactFramingSettings {
/** /**
* Create a EdifactFramingSettings. * Create a EdifactFramingSettings.
* @member {string} [serviceCodeListDirectoryVersion] The service code list * @property {string} [serviceCodeListDirectoryVersion] The service code list
* directory version. * directory version.
* @member {string} [characterEncoding] The character encoding. * @property {string} [characterEncoding] The character encoding.
* @member {number} protocolVersion The protocol version. * @property {number} protocolVersion The protocol version.
* @member {number} dataElementSeparator The data element separator. * @property {number} dataElementSeparator The data element separator.
* @member {number} componentSeparator The component separator. * @property {number} componentSeparator The component separator.
* @member {number} segmentTerminator The segment terminator. * @property {number} segmentTerminator The segment terminator.
* @member {number} releaseIndicator The release indicator. * @property {number} releaseIndicator The release indicator.
* @member {number} repetitionSeparator The repetition separator. * @property {number} repetitionSeparator The repetition separator.
* @member {string} characterSet The EDIFACT frame setting characterSet. * @property {string} characterSet The EDIFACT frame setting characterSet.
* Possible values include: 'NotSpecified', 'UNOB', 'UNOA', 'UNOC', 'UNOD', * Possible values include: 'NotSpecified', 'UNOB', 'UNOA', 'UNOC', 'UNOD',
* 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', 'UNOY', * 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', 'UNOY',
* 'KECA' * 'KECA'
* @member {string} decimalPointIndicator The EDIFACT frame setting decimal * @property {string} decimalPointIndicator The EDIFACT frame setting decimal
* indicator. Possible values include: 'NotSpecified', 'Comma', 'Decimal' * indicator. Possible values include: 'NotSpecified', 'Comma', 'Decimal'
* @member {string} segmentTerminatorSuffix The EDIFACT frame setting segment * @property {string} segmentTerminatorSuffix The EDIFACT frame setting
* terminator suffix. Possible values include: 'NotSpecified', 'None', 'CR', * segment terminator suffix. Possible values include: 'NotSpecified',
* 'LF', 'CRLF' * 'None', 'CR', 'LF', 'CRLF'
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,7 +17,7 @@
class EdifactMessageFilter { class EdifactMessageFilter {
/** /**
* Create a EdifactMessageFilter. * Create a EdifactMessageFilter.
* @member {string} messageFilterType The message filter type. Possible * @property {string} messageFilterType The message filter type. Possible
* values include: 'NotSpecified', 'Include', 'Exclude' * values include: 'NotSpecified', 'Include', 'Exclude'
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,8 +17,8 @@
class EdifactMessageIdentifier { class EdifactMessageIdentifier {
/** /**
* Create a EdifactMessageIdentifier. * Create a EdifactMessageIdentifier.
* @member {string} messageId The message id on which this envelope settings * @property {string} messageId The message id on which this envelope
* has to be applied. * settings has to be applied.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,270 +17,271 @@
class EdifactOneWayAgreement { class EdifactOneWayAgreement {
/** /**
* Create a EdifactOneWayAgreement. * Create a EdifactOneWayAgreement.
* @member {object} senderBusinessIdentity The sender business identity * @property {object} senderBusinessIdentity The sender business identity
* @member {string} [senderBusinessIdentity.qualifier] The business identity * @property {string} [senderBusinessIdentity.qualifier] The business
* qualifier e.g. as2identity, ZZ, ZZZ, 31, 32
* @member {string} [senderBusinessIdentity.value] The user defined business
* identity value.
* @member {object} receiverBusinessIdentity The receiver business identity
* @member {string} [receiverBusinessIdentity.qualifier] The business
* identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 * identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32
* @member {string} [receiverBusinessIdentity.value] The user defined * @property {string} [senderBusinessIdentity.value] The user defined
* business identity value. * business identity value.
* @member {object} protocolSettings The EDIFACT protocol settings. * @property {object} receiverBusinessIdentity The receiver business identity
* @member {object} [protocolSettings.validationSettings] The EDIFACT * @property {string} [receiverBusinessIdentity.qualifier] The business
* identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32
* @property {string} [receiverBusinessIdentity.value] The user defined
* business identity value.
* @property {object} protocolSettings The EDIFACT protocol settings.
* @property {object} [protocolSettings.validationSettings] The EDIFACT
* validation settings. * validation settings.
* @member {boolean} * @property {boolean}
* [protocolSettings.validationSettings.validateCharacterSet] The value * [protocolSettings.validationSettings.validateCharacterSet] The value
* indicating whether to validate character set in the message. * indicating whether to validate character set in the message.
* @member {boolean} * @property {boolean}
* [protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber] * [protocolSettings.validationSettings.checkDuplicateInterchangeControlNumber]
* The value indicating whether to check for duplicate interchange control * The value indicating whether to check for duplicate interchange control
* number. * number.
* @member {number} * @property {number}
* [protocolSettings.validationSettings.interchangeControlNumberValidityDays] * [protocolSettings.validationSettings.interchangeControlNumberValidityDays]
* The validity period of interchange control number. * The validity period of interchange control number.
* @member {boolean} * @property {boolean}
* [protocolSettings.validationSettings.checkDuplicateGroupControlNumber] The * [protocolSettings.validationSettings.checkDuplicateGroupControlNumber] The
* value indicating whether to check for duplicate group control number. * value indicating whether to check for duplicate group control number.
* @member {boolean} * @property {boolean}
* [protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber] * [protocolSettings.validationSettings.checkDuplicateTransactionSetControlNumber]
* The value indicating whether to check for duplicate transaction set * The value indicating whether to check for duplicate transaction set
* control number. * control number.
* @member {boolean} [protocolSettings.validationSettings.validateEdiTypes] * @property {boolean} [protocolSettings.validationSettings.validateEdiTypes]
* The value indicating whether to Whether to validate EDI types. * The value indicating whether to Whether to validate EDI types.
* @member {boolean} [protocolSettings.validationSettings.validateXsdTypes] * @property {boolean} [protocolSettings.validationSettings.validateXsdTypes]
* The value indicating whether to Whether to validate XSD types. * The value indicating whether to Whether to validate XSD types.
* @member {boolean} * @property {boolean}
* [protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes] * [protocolSettings.validationSettings.allowLeadingAndTrailingSpacesAndZeroes]
* The value indicating whether to allow leading and trailing spaces and * The value indicating whether to allow leading and trailing spaces and
* zeroes. * zeroes.
* @member {boolean} * @property {boolean}
* [protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes] * [protocolSettings.validationSettings.trimLeadingAndTrailingSpacesAndZeroes]
* The value indicating whether to trim leading and trailing spaces and * The value indicating whether to trim leading and trailing spaces and
* zeroes. * zeroes.
* @member {string} * @property {string}
* [protocolSettings.validationSettings.trailingSeparatorPolicy] The trailing * [protocolSettings.validationSettings.trailingSeparatorPolicy] The trailing
* separator policy. Possible values include: 'NotSpecified', 'NotAllowed', * separator policy. Possible values include: 'NotSpecified', 'NotAllowed',
* 'Optional', 'Mandatory' * 'Optional', 'Mandatory'
* @member {object} [protocolSettings.framingSettings] The EDIFACT framing * @property {object} [protocolSettings.framingSettings] The EDIFACT framing
* settings. * settings.
* @member {string} * @property {string}
* [protocolSettings.framingSettings.serviceCodeListDirectoryVersion] The * [protocolSettings.framingSettings.serviceCodeListDirectoryVersion] The
* service code list directory version. * service code list directory version.
* @member {string} [protocolSettings.framingSettings.characterEncoding] The * @property {string} [protocolSettings.framingSettings.characterEncoding]
* character encoding. * The character encoding.
* @member {number} [protocolSettings.framingSettings.protocolVersion] The * @property {number} [protocolSettings.framingSettings.protocolVersion] The
* protocol version. * protocol version.
* @member {number} [protocolSettings.framingSettings.dataElementSeparator] * @property {number} [protocolSettings.framingSettings.dataElementSeparator]
* The data element separator. * The data element separator.
* @member {number} [protocolSettings.framingSettings.componentSeparator] The * @property {number} [protocolSettings.framingSettings.componentSeparator]
* component separator. * The component separator.
* @member {number} [protocolSettings.framingSettings.segmentTerminator] The * @property {number} [protocolSettings.framingSettings.segmentTerminator]
* segment terminator. * The segment terminator.
* @member {number} [protocolSettings.framingSettings.releaseIndicator] The * @property {number} [protocolSettings.framingSettings.releaseIndicator] The
* release indicator. * release indicator.
* @member {number} [protocolSettings.framingSettings.repetitionSeparator] * @property {number} [protocolSettings.framingSettings.repetitionSeparator]
* The repetition separator. * The repetition separator.
* @member {string} [protocolSettings.framingSettings.characterSet] The * @property {string} [protocolSettings.framingSettings.characterSet] The
* EDIFACT frame setting characterSet. Possible values include: * EDIFACT frame setting characterSet. Possible values include:
* 'NotSpecified', 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', * 'NotSpecified', 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG',
* 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA' * 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA'
* @member {string} [protocolSettings.framingSettings.decimalPointIndicator] * @property {string}
* The EDIFACT frame setting decimal indicator. Possible values include: * [protocolSettings.framingSettings.decimalPointIndicator] The EDIFACT frame
* 'NotSpecified', 'Comma', 'Decimal' * setting decimal indicator. Possible values include: 'NotSpecified',
* @member {string} * 'Comma', 'Decimal'
* @property {string}
* [protocolSettings.framingSettings.segmentTerminatorSuffix] The EDIFACT * [protocolSettings.framingSettings.segmentTerminatorSuffix] The EDIFACT
* frame setting segment terminator suffix. Possible values include: * frame setting segment terminator suffix. Possible values include:
* 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' * 'NotSpecified', 'None', 'CR', 'LF', 'CRLF'
* @member {object} [protocolSettings.envelopeSettings] The EDIFACT envelope * @property {object} [protocolSettings.envelopeSettings] The EDIFACT
* settings. * envelope settings.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.groupAssociationAssignedCode] The group * [protocolSettings.envelopeSettings.groupAssociationAssignedCode] The group
* association assigned code. * association assigned code.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.communicationAgreementId] The * [protocolSettings.envelopeSettings.communicationAgreementId] The
* communication agreement id. * communication agreement id.
* @member {boolean} * @property {boolean}
* [protocolSettings.envelopeSettings.applyDelimiterStringAdvice] The value * [protocolSettings.envelopeSettings.applyDelimiterStringAdvice] The value
* indicating whether to apply delimiter string advice. * indicating whether to apply delimiter string advice.
* @member {boolean} * @property {boolean}
* [protocolSettings.envelopeSettings.createGroupingSegments] The value * [protocolSettings.envelopeSettings.createGroupingSegments] The value
* indicating whether to create grouping segments. * indicating whether to create grouping segments.
* @member {boolean} * @property {boolean}
* [protocolSettings.envelopeSettings.enableDefaultGroupHeaders] The value * [protocolSettings.envelopeSettings.enableDefaultGroupHeaders] The value
* indicating whether to enable default group headers. * indicating whether to enable default group headers.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.recipientReferencePasswordValue] The * [protocolSettings.envelopeSettings.recipientReferencePasswordValue] The
* recipient reference password value. * recipient reference password value.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.recipientReferencePasswordQualifier] * [protocolSettings.envelopeSettings.recipientReferencePasswordQualifier]
* The recipient reference password qualifier. * The recipient reference password qualifier.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.applicationReferenceId] The application * [protocolSettings.envelopeSettings.applicationReferenceId] The application
* reference id. * reference id.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.processingPriorityCode] The processing * [protocolSettings.envelopeSettings.processingPriorityCode] The processing
* priority code. * priority code.
* @member {number} * @property {number}
* [protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] The * [protocolSettings.envelopeSettings.interchangeControlNumberLowerBound] The
* interchange control number lower bound. * interchange control number lower bound.
* @member {number} * @property {number}
* [protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] The * [protocolSettings.envelopeSettings.interchangeControlNumberUpperBound] The
* interchange control number upper bound. * interchange control number upper bound.
* @member {boolean} * @property {boolean}
* [protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] The * [protocolSettings.envelopeSettings.rolloverInterchangeControlNumber] The
* value indicating whether to rollover interchange control number. * value indicating whether to rollover interchange control number.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.interchangeControlNumberPrefix] The * [protocolSettings.envelopeSettings.interchangeControlNumberPrefix] The
* interchange control number prefix. * interchange control number prefix.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.interchangeControlNumberSuffix] The * [protocolSettings.envelopeSettings.interchangeControlNumberSuffix] The
* interchange control number suffix. * interchange control number suffix.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.senderReverseRoutingAddress] The sender * [protocolSettings.envelopeSettings.senderReverseRoutingAddress] The sender
* reverse routing address. * reverse routing address.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.receiverReverseRoutingAddress] The * [protocolSettings.envelopeSettings.receiverReverseRoutingAddress] The
* receiver reverse routing address. * receiver reverse routing address.
* @member {string} [protocolSettings.envelopeSettings.functionalGroupId] The * @property {string} [protocolSettings.envelopeSettings.functionalGroupId]
* functional group id. * The functional group id.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.groupControllingAgencyCode] The group * [protocolSettings.envelopeSettings.groupControllingAgencyCode] The group
* controlling agency code. * controlling agency code.
* @member {string} [protocolSettings.envelopeSettings.groupMessageVersion] * @property {string} [protocolSettings.envelopeSettings.groupMessageVersion]
* The group message version. * The group message version.
* @member {string} [protocolSettings.envelopeSettings.groupMessageRelease] * @property {string} [protocolSettings.envelopeSettings.groupMessageRelease]
* The group message release. * The group message release.
* @member {number} * @property {number}
* [protocolSettings.envelopeSettings.groupControlNumberLowerBound] The group * [protocolSettings.envelopeSettings.groupControlNumberLowerBound] The group
* control number lower bound. * control number lower bound.
* @member {number} * @property {number}
* [protocolSettings.envelopeSettings.groupControlNumberUpperBound] The group * [protocolSettings.envelopeSettings.groupControlNumberUpperBound] The group
* control number upper bound. * control number upper bound.
* @member {boolean} * @property {boolean}
* [protocolSettings.envelopeSettings.rolloverGroupControlNumber] The value * [protocolSettings.envelopeSettings.rolloverGroupControlNumber] The value
* indicating whether to rollover group control number. * indicating whether to rollover group control number.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.groupControlNumberPrefix] The group * [protocolSettings.envelopeSettings.groupControlNumberPrefix] The group
* control number prefix. * control number prefix.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.groupControlNumberSuffix] The group * [protocolSettings.envelopeSettings.groupControlNumberSuffix] The group
* control number suffix. * control number suffix.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.groupApplicationReceiverQualifier] The * [protocolSettings.envelopeSettings.groupApplicationReceiverQualifier] The
* group application receiver qualifier. * group application receiver qualifier.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.groupApplicationReceiverId] The group * [protocolSettings.envelopeSettings.groupApplicationReceiverId] The group
* application receiver id. * application receiver id.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.groupApplicationSenderQualifier] The * [protocolSettings.envelopeSettings.groupApplicationSenderQualifier] The
* group application sender qualifier. * group application sender qualifier.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.groupApplicationSenderId] The group * [protocolSettings.envelopeSettings.groupApplicationSenderId] The group
* application sender id. * application sender id.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.groupApplicationPassword] The group * [protocolSettings.envelopeSettings.groupApplicationPassword] The group
* application password. * application password.
* @member {boolean} * @property {boolean}
* [protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber] * [protocolSettings.envelopeSettings.overwriteExistingTransactionSetControlNumber]
* The value indicating whether to overwrite existing transaction set control * The value indicating whether to overwrite existing transaction set control
* number. * number.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] The * [protocolSettings.envelopeSettings.transactionSetControlNumberPrefix] The
* transaction set control number prefix. * transaction set control number prefix.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] The * [protocolSettings.envelopeSettings.transactionSetControlNumberSuffix] The
* transaction set control number suffix. * transaction set control number suffix.
* @member {number} * @property {number}
* [protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound] * [protocolSettings.envelopeSettings.transactionSetControlNumberLowerBound]
* The transaction set control number lower bound. * The transaction set control number lower bound.
* @member {number} * @property {number}
* [protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound] * [protocolSettings.envelopeSettings.transactionSetControlNumberUpperBound]
* The transaction set control number upper bound. * The transaction set control number upper bound.
* @member {boolean} * @property {boolean}
* [protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber] * [protocolSettings.envelopeSettings.rolloverTransactionSetControlNumber]
* The value indicating whether to rollover transaction set control number. * The value indicating whether to rollover transaction set control number.
* @member {boolean} [protocolSettings.envelopeSettings.isTestInterchange] * @property {boolean} [protocolSettings.envelopeSettings.isTestInterchange]
* The value indicating whether the message is a test interchange. * The value indicating whether the message is a test interchange.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.senderInternalIdentification] The * [protocolSettings.envelopeSettings.senderInternalIdentification] The
* sender internal identification. * sender internal identification.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.senderInternalSubIdentification] The * [protocolSettings.envelopeSettings.senderInternalSubIdentification] The
* sender internal sub identification. * sender internal sub identification.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.receiverInternalIdentification] The * [protocolSettings.envelopeSettings.receiverInternalIdentification] The
* receiver internal identification. * receiver internal identification.
* @member {string} * @property {string}
* [protocolSettings.envelopeSettings.receiverInternalSubIdentification] The * [protocolSettings.envelopeSettings.receiverInternalSubIdentification] The
* receiver internal sub identification. * receiver internal sub identification.
* @member {object} [protocolSettings.acknowledgementSettings] The EDIFACT * @property {object} [protocolSettings.acknowledgementSettings] The EDIFACT
* acknowledgement settings. * acknowledgement settings.
* @member {boolean} * @property {boolean}
* [protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement] * [protocolSettings.acknowledgementSettings.needTechnicalAcknowledgement]
* The value indicating whether technical acknowledgement is needed. * The value indicating whether technical acknowledgement is needed.
* @member {boolean} * @property {boolean}
* [protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements] * [protocolSettings.acknowledgementSettings.batchTechnicalAcknowledgements]
* The value indicating whether to batch the technical acknowledgements. * The value indicating whether to batch the technical acknowledgements.
* @member {boolean} * @property {boolean}
* [protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement] * [protocolSettings.acknowledgementSettings.needFunctionalAcknowledgement]
* The value indicating whether functional acknowledgement is needed. * The value indicating whether functional acknowledgement is needed.
* @member {boolean} * @property {boolean}
* [protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements] * [protocolSettings.acknowledgementSettings.batchFunctionalAcknowledgements]
* The value indicating whether to batch functional acknowledgements. * The value indicating whether to batch functional acknowledgements.
* @member {boolean} * @property {boolean}
* [protocolSettings.acknowledgementSettings.needLoopForValidMessages] The * [protocolSettings.acknowledgementSettings.needLoopForValidMessages] The
* value indicating whether a loop is needed for valid messages. * value indicating whether a loop is needed for valid messages.
* @member {boolean} * @property {boolean}
* [protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement] * [protocolSettings.acknowledgementSettings.sendSynchronousAcknowledgement]
* The value indicating whether to send synchronous acknowledgement. * The value indicating whether to send synchronous acknowledgement.
* @member {string} * @property {string}
* [protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix] * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberPrefix]
* The acknowledgement control number prefix. * The acknowledgement control number prefix.
* @member {string} * @property {string}
* [protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix] * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberSuffix]
* The acknowledgement control number suffix. * The acknowledgement control number suffix.
* @member {number} * @property {number}
* [protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound] * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberLowerBound]
* The acknowledgement control number lower bound. * The acknowledgement control number lower bound.
* @member {number} * @property {number}
* [protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound] * [protocolSettings.acknowledgementSettings.acknowledgementControlNumberUpperBound]
* The acknowledgement control number upper bound. * The acknowledgement control number upper bound.
* @member {boolean} * @property {boolean}
* [protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber] * [protocolSettings.acknowledgementSettings.rolloverAcknowledgementControlNumber]
* The value indicating whether to rollover acknowledgement control number. * The value indicating whether to rollover acknowledgement control number.
* @member {object} [protocolSettings.messageFilter] The EDIFACT message * @property {object} [protocolSettings.messageFilter] The EDIFACT message
* filter. * filter.
* @member {string} [protocolSettings.messageFilter.messageFilterType] The * @property {string} [protocolSettings.messageFilter.messageFilterType] The
* message filter type. Possible values include: 'NotSpecified', 'Include', * message filter type. Possible values include: 'NotSpecified', 'Include',
* 'Exclude' * 'Exclude'
* @member {object} [protocolSettings.processingSettings] The EDIFACT * @property {object} [protocolSettings.processingSettings] The EDIFACT
* processing Settings. * processing Settings.
* @member {boolean} [protocolSettings.processingSettings.maskSecurityInfo] * @property {boolean} [protocolSettings.processingSettings.maskSecurityInfo]
* The value indicating whether to mask security information. * The value indicating whether to mask security information.
* @member {boolean} * @property {boolean}
* [protocolSettings.processingSettings.preserveInterchange] The value * [protocolSettings.processingSettings.preserveInterchange] The value
* indicating whether to preserve interchange. * indicating whether to preserve interchange.
* @member {boolean} * @property {boolean}
* [protocolSettings.processingSettings.suspendInterchangeOnError] The value * [protocolSettings.processingSettings.suspendInterchangeOnError] The value
* indicating whether to suspend interchange on error. * indicating whether to suspend interchange on error.
* @member {boolean} * @property {boolean}
* [protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators] * [protocolSettings.processingSettings.createEmptyXmlTagsForTrailingSeparators]
* The value indicating whether to create empty xml tags for trailing * The value indicating whether to create empty xml tags for trailing
* separators. * separators.
* @member {boolean} * @property {boolean}
* [protocolSettings.processingSettings.useDotAsDecimalSeparator] The value * [protocolSettings.processingSettings.useDotAsDecimalSeparator] The value
* indicating whether to use dot as decimal separator. * indicating whether to use dot as decimal separator.
* @member {array} [protocolSettings.envelopeOverrides] The EDIFACT envelope * @property {array} [protocolSettings.envelopeOverrides] The EDIFACT
* override settings. * envelope override settings.
* @member {array} [protocolSettings.messageFilterList] The EDIFACT message * @property {array} [protocolSettings.messageFilterList] The EDIFACT message
* filter list. * filter list.
* @member {array} [protocolSettings.schemaReferences] The EDIFACT schema * @property {array} [protocolSettings.schemaReferences] The EDIFACT schema
* references. * references.
* @member {array} [protocolSettings.validationOverrides] The EDIFACT * @property {array} [protocolSettings.validationOverrides] The EDIFACT
* validation override settings. * validation override settings.
* @member {array} [protocolSettings.edifactDelimiterOverrides] The EDIFACT * @property {array} [protocolSettings.edifactDelimiterOverrides] The EDIFACT
* delimiter override settings. * delimiter override settings.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,16 +17,16 @@
class EdifactProcessingSettings { class EdifactProcessingSettings {
/** /**
* Create a EdifactProcessingSettings. * Create a EdifactProcessingSettings.
* @member {boolean} maskSecurityInfo The value indicating whether to mask * @property {boolean} maskSecurityInfo The value indicating whether to mask
* security information. * security information.
* @member {boolean} preserveInterchange The value indicating whether to * @property {boolean} preserveInterchange The value indicating whether to
* preserve interchange. * preserve interchange.
* @member {boolean} suspendInterchangeOnError The value indicating whether * @property {boolean} suspendInterchangeOnError The value indicating whether
* to suspend interchange on error. * to suspend interchange on error.
* @member {boolean} createEmptyXmlTagsForTrailingSeparators The value * @property {boolean} createEmptyXmlTagsForTrailingSeparators The value
* indicating whether to create empty xml tags for trailing separators. * indicating whether to create empty xml tags for trailing separators.
* @member {boolean} useDotAsDecimalSeparator The value indicating whether to * @property {boolean} useDotAsDecimalSeparator The value indicating whether
* use dot as decimal separator. * to use dot as decimal separator.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,194 +17,201 @@
class EdifactProtocolSettings { class EdifactProtocolSettings {
/** /**
* Create a EdifactProtocolSettings. * Create a EdifactProtocolSettings.
* @member {object} validationSettings The EDIFACT validation settings. * @property {object} validationSettings The EDIFACT validation settings.
* @member {boolean} [validationSettings.validateCharacterSet] The value * @property {boolean} [validationSettings.validateCharacterSet] The value
* indicating whether to validate character set in the message. * indicating whether to validate character set in the message.
* @member {boolean} * @property {boolean}
* [validationSettings.checkDuplicateInterchangeControlNumber] The value * [validationSettings.checkDuplicateInterchangeControlNumber] The value
* indicating whether to check for duplicate interchange control number. * indicating whether to check for duplicate interchange control number.
* @member {number} [validationSettings.interchangeControlNumberValidityDays] * @property {number}
* The validity period of interchange control number. * [validationSettings.interchangeControlNumberValidityDays] The validity
* @member {boolean} [validationSettings.checkDuplicateGroupControlNumber] * period of interchange control number.
* @property {boolean} [validationSettings.checkDuplicateGroupControlNumber]
* The value indicating whether to check for duplicate group control number. * The value indicating whether to check for duplicate group control number.
* @member {boolean} * @property {boolean}
* [validationSettings.checkDuplicateTransactionSetControlNumber] The value * [validationSettings.checkDuplicateTransactionSetControlNumber] The value
* indicating whether to check for duplicate transaction set control number. * indicating whether to check for duplicate transaction set control number.
* @member {boolean} [validationSettings.validateEdiTypes] The value * @property {boolean} [validationSettings.validateEdiTypes] The value
* indicating whether to Whether to validate EDI types. * indicating whether to Whether to validate EDI types.
* @member {boolean} [validationSettings.validateXsdTypes] The value * @property {boolean} [validationSettings.validateXsdTypes] The value
* indicating whether to Whether to validate XSD types. * indicating whether to Whether to validate XSD types.
* @member {boolean} * @property {boolean}
* [validationSettings.allowLeadingAndTrailingSpacesAndZeroes] The value * [validationSettings.allowLeadingAndTrailingSpacesAndZeroes] The value
* indicating whether to allow leading and trailing spaces and zeroes. * indicating whether to allow leading and trailing spaces and zeroes.
* @member {boolean} * @property {boolean}
* [validationSettings.trimLeadingAndTrailingSpacesAndZeroes] The value * [validationSettings.trimLeadingAndTrailingSpacesAndZeroes] The value
* indicating whether to trim leading and trailing spaces and zeroes. * indicating whether to trim leading and trailing spaces and zeroes.
* @member {string} [validationSettings.trailingSeparatorPolicy] The trailing * @property {string} [validationSettings.trailingSeparatorPolicy] The
* separator policy. Possible values include: 'NotSpecified', 'NotAllowed', * trailing separator policy. Possible values include: 'NotSpecified',
* 'Optional', 'Mandatory' * 'NotAllowed', 'Optional', 'Mandatory'
* @member {object} framingSettings The EDIFACT framing settings. * @property {object} framingSettings The EDIFACT framing settings.
* @member {string} [framingSettings.serviceCodeListDirectoryVersion] The * @property {string} [framingSettings.serviceCodeListDirectoryVersion] The
* service code list directory version. * service code list directory version.
* @member {string} [framingSettings.characterEncoding] The character * @property {string} [framingSettings.characterEncoding] The character
* encoding. * encoding.
* @member {number} [framingSettings.protocolVersion] The protocol version. * @property {number} [framingSettings.protocolVersion] The protocol version.
* @member {number} [framingSettings.dataElementSeparator] The data element * @property {number} [framingSettings.dataElementSeparator] The data element
* separator. * separator.
* @member {number} [framingSettings.componentSeparator] The component * @property {number} [framingSettings.componentSeparator] The component
* separator. * separator.
* @member {number} [framingSettings.segmentTerminator] The segment * @property {number} [framingSettings.segmentTerminator] The segment
* terminator. * terminator.
* @member {number} [framingSettings.releaseIndicator] The release indicator. * @property {number} [framingSettings.releaseIndicator] The release
* @member {number} [framingSettings.repetitionSeparator] The repetition * indicator.
* @property {number} [framingSettings.repetitionSeparator] The repetition
* separator. * separator.
* @member {string} [framingSettings.characterSet] The EDIFACT frame setting * @property {string} [framingSettings.characterSet] The EDIFACT frame
* characterSet. Possible values include: 'NotSpecified', 'UNOB', 'UNOA', * setting characterSet. Possible values include: 'NotSpecified', 'UNOB',
* 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', 'UNOJ', 'UNOK', * 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', 'UNOJ',
* 'UNOX', 'UNOY', 'KECA' * 'UNOK', 'UNOX', 'UNOY', 'KECA'
* @member {string} [framingSettings.decimalPointIndicator] The EDIFACT frame * @property {string} [framingSettings.decimalPointIndicator] The EDIFACT
* setting decimal indicator. Possible values include: 'NotSpecified', * frame setting decimal indicator. Possible values include: 'NotSpecified',
* 'Comma', 'Decimal' * 'Comma', 'Decimal'
* @member {string} [framingSettings.segmentTerminatorSuffix] The EDIFACT * @property {string} [framingSettings.segmentTerminatorSuffix] The EDIFACT
* frame setting segment terminator suffix. Possible values include: * frame setting segment terminator suffix. Possible values include:
* 'NotSpecified', 'None', 'CR', 'LF', 'CRLF' * 'NotSpecified', 'None', 'CR', 'LF', 'CRLF'
* @member {object} envelopeSettings The EDIFACT envelope settings. * @property {object} envelopeSettings The EDIFACT envelope settings.
* @member {string} [envelopeSettings.groupAssociationAssignedCode] The group * @property {string} [envelopeSettings.groupAssociationAssignedCode] The
* association assigned code. * group association assigned code.
* @member {string} [envelopeSettings.communicationAgreementId] The * @property {string} [envelopeSettings.communicationAgreementId] The
* communication agreement id. * communication agreement id.
* @member {boolean} [envelopeSettings.applyDelimiterStringAdvice] The value * @property {boolean} [envelopeSettings.applyDelimiterStringAdvice] The
* indicating whether to apply delimiter string advice. * value indicating whether to apply delimiter string advice.
* @member {boolean} [envelopeSettings.createGroupingSegments] The value * @property {boolean} [envelopeSettings.createGroupingSegments] The value
* indicating whether to create grouping segments. * indicating whether to create grouping segments.
* @member {boolean} [envelopeSettings.enableDefaultGroupHeaders] The value * @property {boolean} [envelopeSettings.enableDefaultGroupHeaders] The value
* indicating whether to enable default group headers. * indicating whether to enable default group headers.
* @member {string} [envelopeSettings.recipientReferencePasswordValue] The * @property {string} [envelopeSettings.recipientReferencePasswordValue] The
* recipient reference password value. * recipient reference password value.
* @member {string} [envelopeSettings.recipientReferencePasswordQualifier] * @property {string} [envelopeSettings.recipientReferencePasswordQualifier]
* The recipient reference password qualifier. * The recipient reference password qualifier.
* @member {string} [envelopeSettings.applicationReferenceId] The application * @property {string} [envelopeSettings.applicationReferenceId] The
* reference id. * application reference id.
* @member {string} [envelopeSettings.processingPriorityCode] The processing * @property {string} [envelopeSettings.processingPriorityCode] The
* priority code. * processing priority code.
* @member {number} [envelopeSettings.interchangeControlNumberLowerBound] The * @property {number} [envelopeSettings.interchangeControlNumberLowerBound]
* interchange control number lower bound. * The interchange control number lower bound.
* @member {number} [envelopeSettings.interchangeControlNumberUpperBound] The * @property {number} [envelopeSettings.interchangeControlNumberUpperBound]
* interchange control number upper bound. * The interchange control number upper bound.
* @member {boolean} [envelopeSettings.rolloverInterchangeControlNumber] The * @property {boolean} [envelopeSettings.rolloverInterchangeControlNumber]
* value indicating whether to rollover interchange control number. * The value indicating whether to rollover interchange control number.
* @member {string} [envelopeSettings.interchangeControlNumberPrefix] The * @property {string} [envelopeSettings.interchangeControlNumberPrefix] The
* interchange control number prefix. * interchange control number prefix.
* @member {string} [envelopeSettings.interchangeControlNumberSuffix] The * @property {string} [envelopeSettings.interchangeControlNumberSuffix] The
* interchange control number suffix. * interchange control number suffix.
* @member {string} [envelopeSettings.senderReverseRoutingAddress] The sender * @property {string} [envelopeSettings.senderReverseRoutingAddress] The
* reverse routing address. * sender reverse routing address.
* @member {string} [envelopeSettings.receiverReverseRoutingAddress] The * @property {string} [envelopeSettings.receiverReverseRoutingAddress] The
* receiver reverse routing address. * receiver reverse routing address.
* @member {string} [envelopeSettings.functionalGroupId] The functional group * @property {string} [envelopeSettings.functionalGroupId] The functional
* id. * group id.
* @member {string} [envelopeSettings.groupControllingAgencyCode] The group * @property {string} [envelopeSettings.groupControllingAgencyCode] The group
* controlling agency code. * controlling agency code.
* @member {string} [envelopeSettings.groupMessageVersion] The group message * @property {string} [envelopeSettings.groupMessageVersion] The group
* version. * message version.
* @member {string} [envelopeSettings.groupMessageRelease] The group message * @property {string} [envelopeSettings.groupMessageRelease] The group
* release. * message release.
* @member {number} [envelopeSettings.groupControlNumberLowerBound] The group * @property {number} [envelopeSettings.groupControlNumberLowerBound] The
* control number lower bound. * group control number lower bound.
* @member {number} [envelopeSettings.groupControlNumberUpperBound] The group * @property {number} [envelopeSettings.groupControlNumberUpperBound] The
* control number upper bound. * group control number upper bound.
* @member {boolean} [envelopeSettings.rolloverGroupControlNumber] The value * @property {boolean} [envelopeSettings.rolloverGroupControlNumber] The
* indicating whether to rollover group control number. * value indicating whether to rollover group control number.
* @member {string} [envelopeSettings.groupControlNumberPrefix] The group * @property {string} [envelopeSettings.groupControlNumberPrefix] The group
* control number prefix. * control number prefix.
* @member {string} [envelopeSettings.groupControlNumberSuffix] The group * @property {string} [envelopeSettings.groupControlNumberSuffix] The group
* control number suffix. * control number suffix.
* @member {string} [envelopeSettings.groupApplicationReceiverQualifier] The * @property {string} [envelopeSettings.groupApplicationReceiverQualifier]
* group application receiver qualifier. * The group application receiver qualifier.
* @member {string} [envelopeSettings.groupApplicationReceiverId] The group * @property {string} [envelopeSettings.groupApplicationReceiverId] The group
* application receiver id. * application receiver id.
* @member {string} [envelopeSettings.groupApplicationSenderQualifier] The * @property {string} [envelopeSettings.groupApplicationSenderQualifier] The
* group application sender qualifier. * group application sender qualifier.
* @member {string} [envelopeSettings.groupApplicationSenderId] The group * @property {string} [envelopeSettings.groupApplicationSenderId] The group
* application sender id. * application sender id.
* @member {string} [envelopeSettings.groupApplicationPassword] The group * @property {string} [envelopeSettings.groupApplicationPassword] The group
* application password. * application password.
* @member {boolean} * @property {boolean}
* [envelopeSettings.overwriteExistingTransactionSetControlNumber] The value * [envelopeSettings.overwriteExistingTransactionSetControlNumber] The value
* indicating whether to overwrite existing transaction set control number. * indicating whether to overwrite existing transaction set control number.
* @member {string} [envelopeSettings.transactionSetControlNumberPrefix] The * @property {string} [envelopeSettings.transactionSetControlNumberPrefix]
* transaction set control number prefix. * The transaction set control number prefix.
* @member {string} [envelopeSettings.transactionSetControlNumberSuffix] The * @property {string} [envelopeSettings.transactionSetControlNumberSuffix]
* transaction set control number suffix. * The transaction set control number suffix.
* @member {number} [envelopeSettings.transactionSetControlNumberLowerBound] * @property {number}
* The transaction set control number lower bound. * [envelopeSettings.transactionSetControlNumberLowerBound] The transaction
* @member {number} [envelopeSettings.transactionSetControlNumberUpperBound] * set control number lower bound.
* The transaction set control number upper bound. * @property {number}
* @member {boolean} [envelopeSettings.rolloverTransactionSetControlNumber] * [envelopeSettings.transactionSetControlNumberUpperBound] The transaction
* set control number upper bound.
* @property {boolean} [envelopeSettings.rolloverTransactionSetControlNumber]
* The value indicating whether to rollover transaction set control number. * The value indicating whether to rollover transaction set control number.
* @member {boolean} [envelopeSettings.isTestInterchange] The value * @property {boolean} [envelopeSettings.isTestInterchange] The value
* indicating whether the message is a test interchange. * indicating whether the message is a test interchange.
* @member {string} [envelopeSettings.senderInternalIdentification] The * @property {string} [envelopeSettings.senderInternalIdentification] The
* sender internal identification. * sender internal identification.
* @member {string} [envelopeSettings.senderInternalSubIdentification] The * @property {string} [envelopeSettings.senderInternalSubIdentification] The
* sender internal sub identification. * sender internal sub identification.
* @member {string} [envelopeSettings.receiverInternalIdentification] The * @property {string} [envelopeSettings.receiverInternalIdentification] The
* receiver internal identification. * receiver internal identification.
* @member {string} [envelopeSettings.receiverInternalSubIdentification] The * @property {string} [envelopeSettings.receiverInternalSubIdentification]
* receiver internal sub identification. * The receiver internal sub identification.
* @member {object} acknowledgementSettings The EDIFACT acknowledgement * @property {object} acknowledgementSettings The EDIFACT acknowledgement
* settings. * settings.
* @member {boolean} [acknowledgementSettings.needTechnicalAcknowledgement] * @property {boolean} [acknowledgementSettings.needTechnicalAcknowledgement]
* The value indicating whether technical acknowledgement is needed. * The value indicating whether technical acknowledgement is needed.
* @member {boolean} [acknowledgementSettings.batchTechnicalAcknowledgements] * @property {boolean}
* The value indicating whether to batch the technical acknowledgements. * [acknowledgementSettings.batchTechnicalAcknowledgements] The value
* @member {boolean} [acknowledgementSettings.needFunctionalAcknowledgement] * indicating whether to batch the technical acknowledgements.
* The value indicating whether functional acknowledgement is needed. * @property {boolean}
* @member {boolean} * [acknowledgementSettings.needFunctionalAcknowledgement] The value
* indicating whether functional acknowledgement is needed.
* @property {boolean}
* [acknowledgementSettings.batchFunctionalAcknowledgements] The value * [acknowledgementSettings.batchFunctionalAcknowledgements] The value
* indicating whether to batch functional acknowledgements. * indicating whether to batch functional acknowledgements.
* @member {boolean} [acknowledgementSettings.needLoopForValidMessages] The * @property {boolean} [acknowledgementSettings.needLoopForValidMessages] The
* value indicating whether a loop is needed for valid messages. * value indicating whether a loop is needed for valid messages.
* @member {boolean} [acknowledgementSettings.sendSynchronousAcknowledgement] * @property {boolean}
* The value indicating whether to send synchronous acknowledgement. * [acknowledgementSettings.sendSynchronousAcknowledgement] The value
* @member {string} * indicating whether to send synchronous acknowledgement.
* @property {string}
* [acknowledgementSettings.acknowledgementControlNumberPrefix] The * [acknowledgementSettings.acknowledgementControlNumberPrefix] The
* acknowledgement control number prefix. * acknowledgement control number prefix.
* @member {string} * @property {string}
* [acknowledgementSettings.acknowledgementControlNumberSuffix] The * [acknowledgementSettings.acknowledgementControlNumberSuffix] The
* acknowledgement control number suffix. * acknowledgement control number suffix.
* @member {number} * @property {number}
* [acknowledgementSettings.acknowledgementControlNumberLowerBound] The * [acknowledgementSettings.acknowledgementControlNumberLowerBound] The
* acknowledgement control number lower bound. * acknowledgement control number lower bound.
* @member {number} * @property {number}
* [acknowledgementSettings.acknowledgementControlNumberUpperBound] The * [acknowledgementSettings.acknowledgementControlNumberUpperBound] The
* acknowledgement control number upper bound. * acknowledgement control number upper bound.
* @member {boolean} * @property {boolean}
* [acknowledgementSettings.rolloverAcknowledgementControlNumber] The value * [acknowledgementSettings.rolloverAcknowledgementControlNumber] The value
* indicating whether to rollover acknowledgement control number. * indicating whether to rollover acknowledgement control number.
* @member {object} messageFilter The EDIFACT message filter. * @property {object} messageFilter The EDIFACT message filter.
* @member {string} [messageFilter.messageFilterType] The message filter * @property {string} [messageFilter.messageFilterType] The message filter
* type. Possible values include: 'NotSpecified', 'Include', 'Exclude' * type. Possible values include: 'NotSpecified', 'Include', 'Exclude'
* @member {object} processingSettings The EDIFACT processing Settings. * @property {object} processingSettings The EDIFACT processing Settings.
* @member {boolean} [processingSettings.maskSecurityInfo] The value * @property {boolean} [processingSettings.maskSecurityInfo] The value
* indicating whether to mask security information. * indicating whether to mask security information.
* @member {boolean} [processingSettings.preserveInterchange] The value * @property {boolean} [processingSettings.preserveInterchange] The value
* indicating whether to preserve interchange. * indicating whether to preserve interchange.
* @member {boolean} [processingSettings.suspendInterchangeOnError] The value * @property {boolean} [processingSettings.suspendInterchangeOnError] The
* indicating whether to suspend interchange on error. * value indicating whether to suspend interchange on error.
* @member {boolean} * @property {boolean}
* [processingSettings.createEmptyXmlTagsForTrailingSeparators] The value * [processingSettings.createEmptyXmlTagsForTrailingSeparators] The value
* indicating whether to create empty xml tags for trailing separators. * indicating whether to create empty xml tags for trailing separators.
* @member {boolean} [processingSettings.useDotAsDecimalSeparator] The value * @property {boolean} [processingSettings.useDotAsDecimalSeparator] The
* indicating whether to use dot as decimal separator. * value indicating whether to use dot as decimal separator.
* @member {array} [envelopeOverrides] The EDIFACT envelope override * @property {array} [envelopeOverrides] The EDIFACT envelope override
* settings. * settings.
* @member {array} [messageFilterList] The EDIFACT message filter list. * @property {array} [messageFilterList] The EDIFACT message filter list.
* @member {array} schemaReferences The EDIFACT schema references. * @property {array} schemaReferences The EDIFACT schema references.
* @member {array} [validationOverrides] The EDIFACT validation override * @property {array} [validationOverrides] The EDIFACT validation override
* settings.
* @member {array} [edifactDelimiterOverrides] The EDIFACT delimiter override
* settings. * settings.
* @property {array} [edifactDelimiterOverrides] The EDIFACT delimiter
* override settings.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,14 +17,15 @@
class EdifactSchemaReference { class EdifactSchemaReference {
/** /**
* Create a EdifactSchemaReference. * Create a EdifactSchemaReference.
* @member {string} messageId The message id. * @property {string} messageId The message id.
* @member {string} messageVersion The message version. * @property {string} messageVersion The message version.
* @member {string} messageRelease The message release version. * @property {string} messageRelease The message release version.
* @member {string} [senderApplicationId] The sender application id. * @property {string} [senderApplicationId] The sender application id.
* @member {string} [senderApplicationQualifier] The sender application * @property {string} [senderApplicationQualifier] The sender application
* qualifier. * qualifier.
* @member {string} [associationAssignedCode] The association assigned code. * @property {string} [associationAssignedCode] The association assigned
* @member {string} schemaName The schema name. * code.
* @property {string} schemaName The schema name.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,20 +17,20 @@
class EdifactValidationOverride { class EdifactValidationOverride {
/** /**
* Create a EdifactValidationOverride. * Create a EdifactValidationOverride.
* @member {string} messageId The message id on which the validation settings * @property {string} messageId The message id on which the validation
* has to be applied. * settings has to be applied.
* @member {boolean} enforceCharacterSet The value indicating whether to * @property {boolean} enforceCharacterSet The value indicating whether to
* validate character Set. * validate character Set.
* @member {boolean} validateEdiTypes The value indicating whether to * @property {boolean} validateEdiTypes The value indicating whether to
* validate EDI types. * validate EDI types.
* @member {boolean} validateXsdTypes The value indicating whether to * @property {boolean} validateXsdTypes The value indicating whether to
* validate XSD types. * validate XSD types.
* @member {boolean} allowLeadingAndTrailingSpacesAndZeroes The value * @property {boolean} allowLeadingAndTrailingSpacesAndZeroes The value
* indicating whether to allow leading and trailing spaces and zeroes. * indicating whether to allow leading and trailing spaces and zeroes.
* @member {string} trailingSeparatorPolicy The trailing separator policy. * @property {string} trailingSeparatorPolicy The trailing separator policy.
* Possible values include: 'NotSpecified', 'NotAllowed', 'Optional', * Possible values include: 'NotSpecified', 'NotAllowed', 'Optional',
* 'Mandatory' * 'Mandatory'
* @member {boolean} trimLeadingAndTrailingSpacesAndZeroes The value * @property {boolean} trimLeadingAndTrailingSpacesAndZeroes The value
* indicating whether to trim leading and trailing spaces and zeroes. * indicating whether to trim leading and trailing spaces and zeroes.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,25 +17,25 @@
class EdifactValidationSettings { class EdifactValidationSettings {
/** /**
* Create a EdifactValidationSettings. * Create a EdifactValidationSettings.
* @member {boolean} validateCharacterSet The value indicating whether to * @property {boolean} validateCharacterSet The value indicating whether to
* validate character set in the message. * validate character set in the message.
* @member {boolean} checkDuplicateInterchangeControlNumber The value * @property {boolean} checkDuplicateInterchangeControlNumber The value
* indicating whether to check for duplicate interchange control number. * indicating whether to check for duplicate interchange control number.
* @member {number} interchangeControlNumberValidityDays The validity period * @property {number} interchangeControlNumberValidityDays The validity
* of interchange control number. * period of interchange control number.
* @member {boolean} checkDuplicateGroupControlNumber The value indicating * @property {boolean} checkDuplicateGroupControlNumber The value indicating
* whether to check for duplicate group control number. * whether to check for duplicate group control number.
* @member {boolean} checkDuplicateTransactionSetControlNumber The value * @property {boolean} checkDuplicateTransactionSetControlNumber The value
* indicating whether to check for duplicate transaction set control number. * indicating whether to check for duplicate transaction set control number.
* @member {boolean} validateEdiTypes The value indicating whether to Whether * @property {boolean} validateEdiTypes The value indicating whether to
* to validate EDI types. * Whether to validate EDI types.
* @member {boolean} validateXsdTypes The value indicating whether to Whether * @property {boolean} validateXsdTypes The value indicating whether to
* to validate XSD types. * Whether to validate XSD types.
* @member {boolean} allowLeadingAndTrailingSpacesAndZeroes The value * @property {boolean} allowLeadingAndTrailingSpacesAndZeroes The value
* indicating whether to allow leading and trailing spaces and zeroes. * indicating whether to allow leading and trailing spaces and zeroes.
* @member {boolean} trimLeadingAndTrailingSpacesAndZeroes The value * @property {boolean} trimLeadingAndTrailingSpacesAndZeroes The value
* indicating whether to trim leading and trailing spaces and zeroes. * indicating whether to trim leading and trailing spaces and zeroes.
* @member {string} trailingSeparatorPolicy The trailing separator policy. * @property {string} trailingSeparatorPolicy The trailing separator policy.
* Possible values include: 'NotSpecified', 'NotAllowed', 'Optional', * Possible values include: 'NotSpecified', 'NotAllowed', 'Optional',
* 'Mandatory' * 'Mandatory'
*/ */

Просмотреть файл

@ -17,7 +17,7 @@
class ErrorInfo { class ErrorInfo {
/** /**
* Create a ErrorInfo. * Create a ErrorInfo.
* @member {string} code The error code. * @property {string} code The error code.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -18,8 +18,8 @@
class ErrorProperties { class ErrorProperties {
/** /**
* Create a ErrorProperties. * Create a ErrorProperties.
* @member {string} [code] Error code. * @property {string} [code] Error code.
* @member {string} [message] Error message indicating why the operation * @property {string} [message] Error message indicating why the operation
* failed. * failed.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -18,9 +18,9 @@
class ErrorResponse { class ErrorResponse {
/** /**
* Create a ErrorResponse. * Create a ErrorResponse.
* @member {object} [error] The error properties. * @property {object} [error] The error properties.
* @member {string} [error.code] Error code. * @property {string} [error.code] Error code.
* @member {string} [error.message] Error message indicating why the * @property {string} [error.message] Error message indicating why the
* operation failed. * operation failed.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -16,12 +16,12 @@
class Expression { class Expression {
/** /**
* Create a Expression. * Create a Expression.
* @member {string} [text] * @property {string} [text]
* @member {object} [value] * @property {object} [value]
* @member {array} [subexpressions] * @property {array} [subexpressions]
* @member {object} [error] * @property {object} [error]
* @member {string} [error.message] The error message. * @property {string} [error.message] The error message.
* @member {array} [error.details] The error details. * @property {array} [error.details] The error details.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -19,7 +19,7 @@ const models = require('./index');
class ExpressionRoot extends models['Expression'] { class ExpressionRoot extends models['Expression'] {
/** /**
* Create a ExpressionRoot. * Create a ExpressionRoot.
* @member {string} [path] The path. * @property {string} [path] The path.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -16,7 +16,7 @@
class ExpressionTraces extends Array { class ExpressionTraces extends Array {
/** /**
* Create a ExpressionTraces. * Create a ExpressionTraces.
* @member {array} [inputs] * @property {array} [inputs]
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -17,7 +17,7 @@
class GenerateUpgradedDefinitionParameters { class GenerateUpgradedDefinitionParameters {
/** /**
* Create a GenerateUpgradedDefinitionParameters. * Create a GenerateUpgradedDefinitionParameters.
* @member {string} [targetSchemaVersion] The target schema version. * @property {string} [targetSchemaVersion] The target schema version.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,8 +17,8 @@
class GetCallbackUrlParameters { class GetCallbackUrlParameters {
/** /**
* Create a GetCallbackUrlParameters. * Create a GetCallbackUrlParameters.
* @member {date} [notAfter] The expiry time. * @property {date} [notAfter] The expiry time.
* @member {string} [keyType] The key type. Possible values include: * @property {string} [keyType] The key type. Possible values include:
* 'NotSpecified', 'Primary', 'Secondary' * 'NotSpecified', 'Primary', 'Secondary'
*/ */
constructor() { constructor() {

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -20,9 +20,9 @@ const models = require('./index');
class IntegrationAccount extends models['Resource'] { class IntegrationAccount extends models['Resource'] {
/** /**
* Create a IntegrationAccount. * Create a IntegrationAccount.
* @member {object} [properties] The integration account properties. * @property {object} [properties] The integration account properties.
* @member {object} [sku] The sku. * @property {object} [sku] The sku.
* @member {string} [sku.name] The sku name. Possible values include: * @property {string} [sku.name] The sku name. Possible values include:
* 'NotSpecified', 'Free', 'Basic', 'Standard' * 'NotSpecified', 'Free', 'Basic', 'Standard'
*/ */
constructor() { constructor() {

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -17,7 +17,7 @@
class IntegrationAccountAgreementFilter { class IntegrationAccountAgreementFilter {
/** /**
* Create a IntegrationAccountAgreementFilter. * Create a IntegrationAccountAgreementFilter.
* @member {string} agreementType The agreement type of integration account * @property {string} agreementType The agreement type of integration account
* agreement. Possible values include: 'NotSpecified', 'AS2', 'X12', * agreement. Possible values include: 'NotSpecified', 'AS2', 'X12',
* 'Edifact' * 'Edifact'
*/ */

Просмотреть файл

@ -16,7 +16,7 @@
class IntegrationAccountAgreementListResult extends Array { class IntegrationAccountAgreementListResult extends Array {
/** /**
* Create a IntegrationAccountAgreementListResult. * Create a IntegrationAccountAgreementListResult.
* @member {string} [nextLink] The URL to get the next set of results. * @property {string} [nextLink] The URL to get the next set of results.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -20,17 +20,17 @@ const models = require('./index');
class IntegrationAccountCertificate extends models['Resource'] { class IntegrationAccountCertificate extends models['Resource'] {
/** /**
* Create a IntegrationAccountCertificate. * Create a IntegrationAccountCertificate.
* @member {date} [createdTime] The created time. * @property {date} [createdTime] The created time.
* @member {date} [changedTime] The changed time. * @property {date} [changedTime] The changed time.
* @member {object} [metadata] The metadata. * @property {object} [metadata] The metadata.
* @member {object} [key] The key details in the key vault. * @property {object} [key] The key details in the key vault.
* @member {object} [key.keyVault] The key vault reference. * @property {object} [key.keyVault] The key vault reference.
* @member {string} [key.keyVault.id] The resource id. * @property {string} [key.keyVault.id] The resource id.
* @member {string} [key.keyVault.name] The resource name. * @property {string} [key.keyVault.name] The resource name.
* @member {string} [key.keyVault.type] The resource type. * @property {string} [key.keyVault.type] The resource type.
* @member {string} [key.keyName] The private key name in key vault. * @property {string} [key.keyName] The private key name in key vault.
* @member {string} [key.keyVersion] The private key version in key vault. * @property {string} [key.keyVersion] The private key version in key vault.
* @member {string} [publicCertificate] The public certificate. * @property {string} [publicCertificate] The public certificate.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -16,7 +16,7 @@
class IntegrationAccountCertificateListResult extends Array { class IntegrationAccountCertificateListResult extends Array {
/** /**
* Create a IntegrationAccountCertificateListResult. * Create a IntegrationAccountCertificateListResult.
* @member {string} [nextLink] The URL to get the next set of results. * @property {string} [nextLink] The URL to get the next set of results.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -16,7 +16,7 @@
class IntegrationAccountListResult extends Array { class IntegrationAccountListResult extends Array {
/** /**
* Create a IntegrationAccountListResult. * Create a IntegrationAccountListResult.
* @member {string} [nextLink] The URL to get the next set of results. * @property {string} [nextLink] The URL to get the next set of results.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -20,26 +20,26 @@ const models = require('./index');
class IntegrationAccountMap extends models['Resource'] { class IntegrationAccountMap extends models['Resource'] {
/** /**
* Create a IntegrationAccountMap. * Create a IntegrationAccountMap.
* @member {string} mapType The map type. Possible values include: * @property {string} mapType The map type. Possible values include:
* 'NotSpecified', 'Xslt', 'Xslt20', 'Xslt30', 'Liquid' * 'NotSpecified', 'Xslt', 'Xslt20', 'Xslt30', 'Liquid'
* @member {object} [parametersSchema] The parameters schema of integration * @property {object} [parametersSchema] The parameters schema of integration
* account map. * account map.
* @member {string} [parametersSchema.ref] The reference name. * @property {string} [parametersSchema.ref] The reference name.
* @member {date} [createdTime] The created time. * @property {date} [createdTime] The created time.
* @member {date} [changedTime] The changed time. * @property {date} [changedTime] The changed time.
* @member {string} [content] The content. * @property {string} [content] The content.
* @member {string} [contentType] The content type. * @property {string} [contentType] The content type.
* @member {object} [contentLink] The content link. * @property {object} [contentLink] The content link.
* @member {string} [contentLink.uri] The content link URI. * @property {string} [contentLink.uri] The content link URI.
* @member {string} [contentLink.contentVersion] The content version. * @property {string} [contentLink.contentVersion] The content version.
* @member {number} [contentLink.contentSize] The content size. * @property {number} [contentLink.contentSize] The content size.
* @member {object} [contentLink.contentHash] The content hash. * @property {object} [contentLink.contentHash] The content hash.
* @member {string} [contentLink.contentHash.algorithm] The algorithm of the * @property {string} [contentLink.contentHash.algorithm] The algorithm of
* the content hash.
* @property {string} [contentLink.contentHash.value] The value of the
* content hash. * content hash.
* @member {string} [contentLink.contentHash.value] The value of the content * @property {object} [contentLink.metadata] The metadata.
* hash. * @property {object} [metadata] The metadata.
* @member {object} [contentLink.metadata] The metadata.
* @member {object} [metadata] The metadata.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -17,8 +17,9 @@
class IntegrationAccountMapFilter { class IntegrationAccountMapFilter {
/** /**
* Create a IntegrationAccountMapFilter. * Create a IntegrationAccountMapFilter.
* @member {string} mapType The map type of integration account map. Possible * @property {string} mapType The map type of integration account map.
* values include: 'NotSpecified', 'Xslt', 'Xslt20', 'Xslt30', 'Liquid' * Possible values include: 'NotSpecified', 'Xslt', 'Xslt20', 'Xslt30',
* 'Liquid'
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -16,7 +16,7 @@
class IntegrationAccountMapListResult extends Array { class IntegrationAccountMapListResult extends Array {
/** /**
* Create a IntegrationAccountMapListResult. * Create a IntegrationAccountMapListResult.
* @member {string} [nextLink] The URL to get the next set of results. * @property {string} [nextLink] The URL to get the next set of results.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -17,7 +17,7 @@
class IntegrationAccountMapPropertiesParametersSchema { class IntegrationAccountMapPropertiesParametersSchema {
/** /**
* Create a IntegrationAccountMapPropertiesParametersSchema. * Create a IntegrationAccountMapPropertiesParametersSchema.
* @member {string} [ref] The reference name. * @property {string} [ref] The reference name.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -20,14 +20,14 @@ const models = require('./index');
class IntegrationAccountPartner extends models['Resource'] { class IntegrationAccountPartner extends models['Resource'] {
/** /**
* Create a IntegrationAccountPartner. * Create a IntegrationAccountPartner.
* @member {string} partnerType The partner type. Possible values include: * @property {string} partnerType The partner type. Possible values include:
* 'NotSpecified', 'B2B' * 'NotSpecified', 'B2B'
* @member {date} [createdTime] The created time. * @property {date} [createdTime] The created time.
* @member {date} [changedTime] The changed time. * @property {date} [changedTime] The changed time.
* @member {object} [metadata] The metadata. * @property {object} [metadata] The metadata.
* @member {object} content The partner content. * @property {object} content The partner content.
* @member {object} [content.b2b] The B2B partner content. * @property {object} [content.b2b] The B2B partner content.
* @member {array} [content.b2b.businessIdentities] The list of partner * @property {array} [content.b2b.businessIdentities] The list of partner
* business identities. * business identities.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,7 +17,7 @@
class IntegrationAccountPartnerFilter { class IntegrationAccountPartnerFilter {
/** /**
* Create a IntegrationAccountPartnerFilter. * Create a IntegrationAccountPartnerFilter.
* @member {string} partnerType The partner type of integration account * @property {string} partnerType The partner type of integration account
* partner. Possible values include: 'NotSpecified', 'B2B' * partner. Possible values include: 'NotSpecified', 'B2B'
*/ */
constructor() { constructor() {

Просмотреть файл

@ -16,7 +16,7 @@
class IntegrationAccountPartnerListResult extends Array { class IntegrationAccountPartnerListResult extends Array {
/** /**
* Create a IntegrationAccountPartnerListResult. * Create a IntegrationAccountPartnerListResult.
* @member {string} [nextLink] The URL to get the next set of results. * @property {string} [nextLink] The URL to get the next set of results.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -20,26 +20,26 @@ const models = require('./index');
class IntegrationAccountSchema extends models['Resource'] { class IntegrationAccountSchema extends models['Resource'] {
/** /**
* Create a IntegrationAccountSchema. * Create a IntegrationAccountSchema.
* @member {string} schemaType The schema type. Possible values include: * @property {string} schemaType The schema type. Possible values include:
* 'NotSpecified', 'Xml' * 'NotSpecified', 'Xml'
* @member {string} [targetNamespace] The target namespace of the schema. * @property {string} [targetNamespace] The target namespace of the schema.
* @member {string} [documentName] The document name. * @property {string} [documentName] The document name.
* @member {string} [fileName] The file name. * @property {string} [fileName] The file name.
* @member {date} [createdTime] The created time. * @property {date} [createdTime] The created time.
* @member {date} [changedTime] The changed time. * @property {date} [changedTime] The changed time.
* @member {object} [metadata] The metadata. * @property {object} [metadata] The metadata.
* @member {string} [content] The content. * @property {string} [content] The content.
* @member {string} [contentType] The content type. * @property {string} [contentType] The content type.
* @member {object} [contentLink] The content link. * @property {object} [contentLink] The content link.
* @member {string} [contentLink.uri] The content link URI. * @property {string} [contentLink.uri] The content link URI.
* @member {string} [contentLink.contentVersion] The content version. * @property {string} [contentLink.contentVersion] The content version.
* @member {number} [contentLink.contentSize] The content size. * @property {number} [contentLink.contentSize] The content size.
* @member {object} [contentLink.contentHash] The content hash. * @property {object} [contentLink.contentHash] The content hash.
* @member {string} [contentLink.contentHash.algorithm] The algorithm of the * @property {string} [contentLink.contentHash.algorithm] The algorithm of
* the content hash.
* @property {string} [contentLink.contentHash.value] The value of the
* content hash. * content hash.
* @member {string} [contentLink.contentHash.value] The value of the content * @property {object} [contentLink.metadata] The metadata.
* hash.
* @member {object} [contentLink.metadata] The metadata.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -17,8 +17,8 @@
class IntegrationAccountSchemaFilter { class IntegrationAccountSchemaFilter {
/** /**
* Create a IntegrationAccountSchemaFilter. * Create a IntegrationAccountSchemaFilter.
* @member {string} schemaType The schema type of integration account schema. * @property {string} schemaType The schema type of integration account
* Possible values include: 'NotSpecified', 'Xml' * schema. Possible values include: 'NotSpecified', 'Xml'
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -16,7 +16,7 @@
class IntegrationAccountSchemaListResult extends Array { class IntegrationAccountSchemaListResult extends Array {
/** /**
* Create a IntegrationAccountSchemaListResult. * Create a IntegrationAccountSchemaListResult.
* @member {string} [nextLink] The URL to get the next set of results. * @property {string} [nextLink] The URL to get the next set of results.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -20,9 +20,9 @@ const models = require('./index');
class IntegrationAccountSession extends models['Resource'] { class IntegrationAccountSession extends models['Resource'] {
/** /**
* Create a IntegrationAccountSession. * Create a IntegrationAccountSession.
* @member {date} [createdTime] The created time. * @property {date} [createdTime] The created time.
* @member {date} [changedTime] The changed time. * @property {date} [changedTime] The changed time.
* @member {object} [content] The session content. * @property {object} [content] The session content.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -17,7 +17,7 @@
class IntegrationAccountSessionFilter { class IntegrationAccountSessionFilter {
/** /**
* Create a IntegrationAccountSessionFilter. * Create a IntegrationAccountSessionFilter.
* @member {date} changedTime The changed time of integration account * @property {date} changedTime The changed time of integration account
* sessions. * sessions.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -16,7 +16,7 @@
class IntegrationAccountSessionListResult extends Array { class IntegrationAccountSessionListResult extends Array {
/** /**
* Create a IntegrationAccountSessionListResult. * Create a IntegrationAccountSessionListResult.
* @member {string} [nextLink] The URL to get the next set of results. * @property {string} [nextLink] The URL to get the next set of results.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -17,7 +17,7 @@
class IntegrationAccountSku { class IntegrationAccountSku {
/** /**
* Create a IntegrationAccountSku. * Create a IntegrationAccountSku.
* @member {string} name The sku name. Possible values include: * @property {string} name The sku name. Possible values include:
* 'NotSpecified', 'Free', 'Basic', 'Standard' * 'NotSpecified', 'Free', 'Basic', 'Standard'
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,8 +17,8 @@
class JsonSchema { class JsonSchema {
/** /**
* Create a JsonSchema. * Create a JsonSchema.
* @member {string} [title] The JSON title. * @property {string} [title] The JSON title.
* @member {string} [content] The JSON content. * @property {string} [content] The JSON content.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,11 +17,12 @@
class KeyVaultKey { class KeyVaultKey {
/** /**
* Create a KeyVaultKey. * Create a KeyVaultKey.
* @member {string} [kid] The key id. * @property {string} [kid] The key id.
* @member {object} [attributes] The key attributes. * @property {object} [attributes] The key attributes.
* @member {boolean} [attributes.enabled] Whether the key is enabled or not. * @property {boolean} [attributes.enabled] Whether the key is enabled or
* @member {number} [attributes.created] When the key was created. * not.
* @member {number} [attributes.updated] When the key was updated. * @property {number} [attributes.created] When the key was created.
* @property {number} [attributes.updated] When the key was updated.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,9 +17,9 @@
class KeyVaultKeyAttributes { class KeyVaultKeyAttributes {
/** /**
* Create a KeyVaultKeyAttributes. * Create a KeyVaultKeyAttributes.
* @member {boolean} [enabled] Whether the key is enabled or not. * @property {boolean} [enabled] Whether the key is enabled or not.
* @member {number} [created] When the key was created. * @property {number} [created] When the key was created.
* @member {number} [updated] When the key was updated. * @property {number} [updated] When the key was updated.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -16,7 +16,7 @@
class KeyVaultKeyCollection extends Array { class KeyVaultKeyCollection extends Array {
/** /**
* Create a KeyVaultKeyCollection. * Create a KeyVaultKeyCollection.
* @member {string} [skipToken] The skip token. * @property {string} [skipToken] The skip token.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -17,12 +17,12 @@
class KeyVaultKeyReference { class KeyVaultKeyReference {
/** /**
* Create a KeyVaultKeyReference. * Create a KeyVaultKeyReference.
* @member {object} keyVault The key vault reference. * @property {object} keyVault The key vault reference.
* @member {string} [keyVault.id] The resource id. * @property {string} [keyVault.id] The resource id.
* @member {string} [keyVault.name] The resource name. * @property {string} [keyVault.name] The resource name.
* @member {string} [keyVault.type] The resource type. * @property {string} [keyVault.type] The resource type.
* @member {string} keyName The private key name in key vault. * @property {string} keyName The private key name in key vault.
* @member {string} [keyVersion] The private key version in key vault. * @property {string} [keyVersion] The private key version in key vault.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,9 +17,9 @@
class KeyVaultKeyReferenceKeyVault { class KeyVaultKeyReferenceKeyVault {
/** /**
* Create a KeyVaultKeyReferenceKeyVault. * Create a KeyVaultKeyReferenceKeyVault.
* @member {string} [id] The resource id. * @property {string} [id] The resource id.
* @member {string} [name] The resource name. * @property {string} [name] The resource name.
* @member {string} [type] The resource type. * @property {string} [type] The resource type.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,8 +17,8 @@
class ListKeyVaultKeysDefinition { class ListKeyVaultKeysDefinition {
/** /**
* Create a ListKeyVaultKeysDefinition. * Create a ListKeyVaultKeysDefinition.
* @member {object} keyVault The key vault reference. * @property {object} keyVault The key vault reference.
* @member {string} [skipToken] The skip token. * @property {string} [skipToken] The skip token.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,13 +17,14 @@
class Operation { class Operation {
/** /**
* Create a Operation. * Create a Operation.
* @member {string} [name] Operation name: {provider}/{resource}/{operation} * @property {string} [name] Operation name:
* @member {object} [display] The object that represents the operation. * {provider}/{resource}/{operation}
* @member {string} [display.provider] Service provider: Microsoft.Logic * @property {object} [display] The object that represents the operation.
* @member {string} [display.resource] Resource on which the operation is * @property {string} [display.provider] Service provider: Microsoft.Logic
* @property {string} [display.resource] Resource on which the operation is
* performed: Profile, endpoint, etc. * performed: Profile, endpoint, etc.
* @member {string} [display.operation] Operation type: Read, write, delete, * @property {string} [display.operation] Operation type: Read, write,
* etc. * delete, etc.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,10 +17,10 @@
class OperationDisplay { class OperationDisplay {
/** /**
* Create a OperationDisplay. * Create a OperationDisplay.
* @member {string} [provider] Service provider: Microsoft.Logic * @property {string} [provider] Service provider: Microsoft.Logic
* @member {string} [resource] Resource on which the operation is performed: * @property {string} [resource] Resource on which the operation is
* Profile, endpoint, etc. * performed: Profile, endpoint, etc.
* @member {string} [operation] Operation type: Read, write, delete, etc. * @property {string} [operation] Operation type: Read, write, delete, etc.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,7 +17,7 @@
class OperationListResult extends Array { class OperationListResult extends Array {
/** /**
* Create a OperationListResult. * Create a OperationListResult.
* @member {string} [nextLink] URL to get the next set of operation list * @property {string} [nextLink] URL to get the next set of operation list
* results if there are any. * results if there are any.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -20,32 +20,32 @@ const models = require('./index');
class OperationResult extends models['OperationResultProperties'] { class OperationResult extends models['OperationResultProperties'] {
/** /**
* Create a OperationResult. * Create a OperationResult.
* @member {string} [trackingId] Gets the tracking id. * @property {string} [trackingId] Gets the tracking id.
* @member {object} [inputs] Gets the inputs. * @property {object} [inputs] Gets the inputs.
* @member {object} [inputsLink] Gets the link to inputs. * @property {object} [inputsLink] Gets the link to inputs.
* @member {string} [inputsLink.uri] The content link URI. * @property {string} [inputsLink.uri] The content link URI.
* @member {string} [inputsLink.contentVersion] The content version. * @property {string} [inputsLink.contentVersion] The content version.
* @member {number} [inputsLink.contentSize] The content size. * @property {number} [inputsLink.contentSize] The content size.
* @member {object} [inputsLink.contentHash] The content hash. * @property {object} [inputsLink.contentHash] The content hash.
* @member {string} [inputsLink.contentHash.algorithm] The algorithm of the * @property {string} [inputsLink.contentHash.algorithm] The algorithm of the
* content hash. * content hash.
* @member {string} [inputsLink.contentHash.value] The value of the content * @property {string} [inputsLink.contentHash.value] The value of the content
* hash. * hash.
* @member {object} [inputsLink.metadata] The metadata. * @property {object} [inputsLink.metadata] The metadata.
* @member {object} [outputs] Gets the outputs. * @property {object} [outputs] Gets the outputs.
* @member {object} [outputsLink] Gets the link to outputs. * @property {object} [outputsLink] Gets the link to outputs.
* @member {string} [outputsLink.uri] The content link URI. * @property {string} [outputsLink.uri] The content link URI.
* @member {string} [outputsLink.contentVersion] The content version. * @property {string} [outputsLink.contentVersion] The content version.
* @member {number} [outputsLink.contentSize] The content size. * @property {number} [outputsLink.contentSize] The content size.
* @member {object} [outputsLink.contentHash] The content hash. * @property {object} [outputsLink.contentHash] The content hash.
* @member {string} [outputsLink.contentHash.algorithm] The algorithm of the * @property {string} [outputsLink.contentHash.algorithm] The algorithm of
* the content hash.
* @property {string} [outputsLink.contentHash.value] The value of the
* content hash. * content hash.
* @member {string} [outputsLink.contentHash.value] The value of the content * @property {object} [outputsLink.metadata] The metadata.
* hash. * @property {object} [trackedProperties] Gets the tracked properties.
* @member {object} [outputsLink.metadata] The metadata. * @property {array} [retryHistory] Gets the retry histories.
* @member {object} [trackedProperties] Gets the tracked properties. * @property {number} [iterationCount]
* @member {array} [retryHistory] Gets the retry histories.
* @member {number} [iterationCount]
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -17,18 +17,18 @@
class OperationResultProperties { class OperationResultProperties {
/** /**
* Create a OperationResultProperties. * Create a OperationResultProperties.
* @member {date} [startTime] The start time of the workflow scope * @property {date} [startTime] The start time of the workflow scope
* repetition. * repetition.
* @member {date} [endTime] The end time of the workflow scope repetition. * @property {date} [endTime] The end time of the workflow scope repetition.
* @member {object} [correlation] The correlation properties. * @property {object} [correlation] The correlation properties.
* @member {string} [correlation.actionTrackingId] The action tracking * @property {string} [correlation.actionTrackingId] The action tracking
* identifier. * identifier.
* @member {string} [status] The status of the workflow scope repetition. * @property {string} [status] The status of the workflow scope repetition.
* Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', * Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting',
* 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', * 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted',
* 'TimedOut', 'Aborted', 'Ignored' * 'TimedOut', 'Aborted', 'Ignored'
* @member {string} [code] The workflow scope repetition code. * @property {string} [code] The workflow scope repetition code.
* @member {object} [error] * @property {object} [error]
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,8 +17,8 @@
class PartnerContent { class PartnerContent {
/** /**
* Create a PartnerContent. * Create a PartnerContent.
* @member {object} [b2b] The B2B partner content. * @property {object} [b2b] The B2B partner content.
* @member {array} [b2b.businessIdentities] The list of partner business * @property {array} [b2b.businessIdentities] The list of partner business
* identities. * identities.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,11 +17,11 @@
class RecurrenceSchedule { class RecurrenceSchedule {
/** /**
* Create a RecurrenceSchedule. * Create a RecurrenceSchedule.
* @member {array} [minutes] The minutes. * @property {array} [minutes] The minutes.
* @member {array} [hours] The hours. * @property {array} [hours] The hours.
* @member {array} [weekDays] The days of the week. * @property {array} [weekDays] The days of the week.
* @member {array} [monthDays] The month days. * @property {array} [monthDays] The month days.
* @member {array} [monthlyOccurrences] The monthly occurrences. * @property {array} [monthlyOccurrences] The monthly occurrences.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,10 +17,10 @@
class RecurrenceScheduleOccurrence { class RecurrenceScheduleOccurrence {
/** /**
* Create a RecurrenceScheduleOccurrence. * Create a RecurrenceScheduleOccurrence.
* @member {string} [day] The day of the week. Possible values include: * @property {string} [day] The day of the week. Possible values include:
* 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', * 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday',
* 'Saturday' * 'Saturday'
* @member {number} [occurrence] The occurrence. * @property {number} [occurrence] The occurrence.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,7 +17,7 @@
class RegenerateActionParameter { class RegenerateActionParameter {
/** /**
* Create a RegenerateActionParameter. * Create a RegenerateActionParameter.
* @member {string} [keyType] The key type. Possible values include: * @property {string} [keyType] The key type. Possible values include:
* 'NotSpecified', 'Primary', 'Secondary' * 'NotSpecified', 'Primary', 'Secondary'
*/ */
constructor() { constructor() {

Просмотреть файл

@ -17,8 +17,8 @@
class RepetitionIndex { class RepetitionIndex {
/** /**
* Create a RepetitionIndex. * Create a RepetitionIndex.
* @member {string} [scopeName] The scope. * @property {string} [scopeName] The scope.
* @member {number} itemIndex The index. * @property {number} itemIndex The index.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,10 +17,10 @@
class Request { class Request {
/** /**
* Create a Request. * Create a Request.
* @member {object} [headers] A list of all the headers attached to the * @property {object} [headers] A list of all the headers attached to the
* request. * request.
* @member {string} [uri] The destination for the request. * @property {string} [uri] The destination for the request.
* @member {string} [method] The HTTP method used for the request. * @property {string} [method] The HTTP method used for the request.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -20,34 +20,36 @@ const models = require('./index');
class RequestHistory extends models['Resource'] { class RequestHistory extends models['Resource'] {
/** /**
* Create a RequestHistory. * Create a RequestHistory.
* @member {object} [properties] The request history properties. * @property {object} [properties] The request history properties.
* @member {date} [properties.startTime] The time the request started. * @property {date} [properties.startTime] The time the request started.
* @member {date} [properties.endTime] The time the request ended. * @property {date} [properties.endTime] The time the request ended.
* @member {object} [properties.request] The request. * @property {object} [properties.request] The request.
* @member {object} [properties.request.headers] A list of all the headers * @property {object} [properties.request.headers] A list of all the headers
* attached to the request. * attached to the request.
* @member {string} [properties.request.uri] The destination for the request. * @property {string} [properties.request.uri] The destination for the
* @member {string} [properties.request.method] The HTTP method used for the
* request. * request.
* @member {object} [properties.response] The response. * @property {string} [properties.request.method] The HTTP method used for
* @member {object} [properties.response.headers] A list of all the headers * the request.
* @property {object} [properties.response] The response.
* @property {object} [properties.response.headers] A list of all the headers
* attached to the response. * attached to the response.
* @member {number} [properties.response.statusCode] The status code of the * @property {number} [properties.response.statusCode] The status code of the
* response. * response.
* @member {object} [properties.response.bodyLink] Details on the location of * @property {object} [properties.response.bodyLink] Details on the location
* the body content. * of the body content.
* @member {string} [properties.response.bodyLink.uri] The content link URI. * @property {string} [properties.response.bodyLink.uri] The content link
* @member {string} [properties.response.bodyLink.contentVersion] The content * URI.
* version. * @property {string} [properties.response.bodyLink.contentVersion] The
* @member {number} [properties.response.bodyLink.contentSize] The content * content version.
* @property {number} [properties.response.bodyLink.contentSize] The content
* size. * size.
* @member {object} [properties.response.bodyLink.contentHash] The content * @property {object} [properties.response.bodyLink.contentHash] The content
* hash. * hash.
* @member {string} [properties.response.bodyLink.contentHash.algorithm] The * @property {string} [properties.response.bodyLink.contentHash.algorithm]
* algorithm of the content hash. * The algorithm of the content hash.
* @member {string} [properties.response.bodyLink.contentHash.value] The * @property {string} [properties.response.bodyLink.contentHash.value] The
* value of the content hash. * value of the content hash.
* @member {object} [properties.response.bodyLink.metadata] The metadata. * @property {object} [properties.response.bodyLink.metadata] The metadata.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -16,7 +16,7 @@
class RequestHistoryListResult extends Array { class RequestHistoryListResult extends Array {
/** /**
* Create a RequestHistoryListResult. * Create a RequestHistoryListResult.
* @member {string} [nextLink] The URL to get the next set of results. * @property {string} [nextLink] The URL to get the next set of results.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -17,28 +17,28 @@
class RequestHistoryProperties { class RequestHistoryProperties {
/** /**
* Create a RequestHistoryProperties. * Create a RequestHistoryProperties.
* @member {date} [startTime] The time the request started. * @property {date} [startTime] The time the request started.
* @member {date} [endTime] The time the request ended. * @property {date} [endTime] The time the request ended.
* @member {object} [request] The request. * @property {object} [request] The request.
* @member {object} [request.headers] A list of all the headers attached to * @property {object} [request.headers] A list of all the headers attached to
* the request. * the request.
* @member {string} [request.uri] The destination for the request. * @property {string} [request.uri] The destination for the request.
* @member {string} [request.method] The HTTP method used for the request. * @property {string} [request.method] The HTTP method used for the request.
* @member {object} [response] The response. * @property {object} [response] The response.
* @member {object} [response.headers] A list of all the headers attached to * @property {object} [response.headers] A list of all the headers attached
* the response. * to the response.
* @member {number} [response.statusCode] The status code of the response. * @property {number} [response.statusCode] The status code of the response.
* @member {object} [response.bodyLink] Details on the location of the body * @property {object} [response.bodyLink] Details on the location of the body
* content. * content.
* @member {string} [response.bodyLink.uri] The content link URI. * @property {string} [response.bodyLink.uri] The content link URI.
* @member {string} [response.bodyLink.contentVersion] The content version. * @property {string} [response.bodyLink.contentVersion] The content version.
* @member {number} [response.bodyLink.contentSize] The content size. * @property {number} [response.bodyLink.contentSize] The content size.
* @member {object} [response.bodyLink.contentHash] The content hash. * @property {object} [response.bodyLink.contentHash] The content hash.
* @member {string} [response.bodyLink.contentHash.algorithm] The algorithm * @property {string} [response.bodyLink.contentHash.algorithm] The algorithm
* of the content hash. * of the content hash.
* @member {string} [response.bodyLink.contentHash.value] The value of the * @property {string} [response.bodyLink.contentHash.value] The value of the
* content hash. * content hash.
* @member {object} [response.bodyLink.metadata] The metadata. * @property {object} [response.bodyLink.metadata] The metadata.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -20,11 +20,11 @@ const models = require('./index');
class Resource extends models['BaseResource'] { class Resource extends models['BaseResource'] {
/** /**
* Create a Resource. * Create a Resource.
* @member {string} [id] The resource id. * @property {string} [id] The resource id.
* @member {string} [name] Gets the resource name. * @property {string} [name] Gets the resource name.
* @member {string} [type] Gets the resource type. * @property {string} [type] Gets the resource type.
* @member {string} [location] The resource location. * @property {string} [location] The resource location.
* @member {object} [tags] The resource tags. * @property {object} [tags] The resource tags.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -17,9 +17,9 @@
class ResourceReference { class ResourceReference {
/** /**
* Create a ResourceReference. * Create a ResourceReference.
* @member {string} [id] The resource id. * @property {string} [id] The resource id.
* @member {string} [name] Gets the resource name. * @property {string} [name] Gets the resource name.
* @member {string} [type] Gets the resource type. * @property {string} [type] Gets the resource type.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,19 +17,19 @@
class Response { class Response {
/** /**
* Create a Response. * Create a Response.
* @member {object} [headers] A list of all the headers attached to the * @property {object} [headers] A list of all the headers attached to the
* response. * response.
* @member {number} [statusCode] The status code of the response. * @property {number} [statusCode] The status code of the response.
* @member {object} [bodyLink] Details on the location of the body content. * @property {object} [bodyLink] Details on the location of the body content.
* @member {string} [bodyLink.uri] The content link URI. * @property {string} [bodyLink.uri] The content link URI.
* @member {string} [bodyLink.contentVersion] The content version. * @property {string} [bodyLink.contentVersion] The content version.
* @member {number} [bodyLink.contentSize] The content size. * @property {number} [bodyLink.contentSize] The content size.
* @member {object} [bodyLink.contentHash] The content hash. * @property {object} [bodyLink.contentHash] The content hash.
* @member {string} [bodyLink.contentHash.algorithm] The algorithm of the * @property {string} [bodyLink.contentHash.algorithm] The algorithm of the
* content hash. * content hash.
* @member {string} [bodyLink.contentHash.value] The value of the content * @property {string} [bodyLink.contentHash.value] The value of the content
* hash. * hash.
* @member {object} [bodyLink.metadata] The metadata. * @property {object} [bodyLink.metadata] The metadata.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,15 +17,15 @@
class RetryHistory { class RetryHistory {
/** /**
* Create a RetryHistory. * Create a RetryHistory.
* @member {date} [startTime] Gets the start time. * @property {date} [startTime] Gets the start time.
* @member {date} [endTime] Gets the end time. * @property {date} [endTime] Gets the end time.
* @member {string} [code] Gets the status code. * @property {string} [code] Gets the status code.
* @member {string} [clientRequestId] Gets the client request Id. * @property {string} [clientRequestId] Gets the client request Id.
* @member {string} [serviceRequestId] Gets the service request Id. * @property {string} [serviceRequestId] Gets the service request Id.
* @member {object} [error] Gets the error response. * @property {object} [error] Gets the error response.
* @member {object} [error.error] The error properties. * @property {object} [error.error] The error properties.
* @member {string} [error.error.code] Error code. * @property {string} [error.error.code] Error code.
* @member {string} [error.error.message] Error message indicating why the * @property {string} [error.error.message] Error message indicating why the
* operation failed. * operation failed.
*/ */
constructor() { constructor() {

Просмотреть файл

@ -20,7 +20,7 @@ const models = require('./index');
class RunActionCorrelation extends models['RunCorrelation'] { class RunActionCorrelation extends models['RunCorrelation'] {
/** /**
* Create a RunActionCorrelation. * Create a RunActionCorrelation.
* @member {string} [actionTrackingId] The action tracking identifier. * @property {string} [actionTrackingId] The action tracking identifier.
*/ */
constructor() { constructor() {
super(); super();

Просмотреть файл

@ -17,8 +17,8 @@
class RunCorrelation { class RunCorrelation {
/** /**
* Create a RunCorrelation. * Create a RunCorrelation.
* @member {string} [clientTrackingId] The client tracking identifier. * @property {string} [clientTrackingId] The client tracking identifier.
* @member {array} [clientKeywords] The client keywords. * @property {array} [clientKeywords] The client keywords.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -16,44 +16,45 @@
class SetTriggerStateActionDefinition { class SetTriggerStateActionDefinition {
/** /**
* Create a SetTriggerStateActionDefinition. * Create a SetTriggerStateActionDefinition.
* @member {object} source * @property {object} source
* @member {string} [source.provisioningState] Gets the provisioning state. * @property {string} [source.provisioningState] Gets the provisioning state.
* Possible values include: 'NotSpecified', 'Accepted', 'Running', 'Ready', * Possible values include: 'NotSpecified', 'Accepted', 'Running', 'Ready',
* 'Creating', 'Created', 'Deleting', 'Deleted', 'Canceled', 'Failed', * 'Creating', 'Created', 'Deleting', 'Deleted', 'Canceled', 'Failed',
* 'Succeeded', 'Moving', 'Updating', 'Registering', 'Registered', * 'Succeeded', 'Moving', 'Updating', 'Registering', 'Registered',
* 'Unregistering', 'Unregistered', 'Completed' * 'Unregistering', 'Unregistered', 'Completed'
* @member {date} [source.createdTime] Gets the created time. * @property {date} [source.createdTime] Gets the created time.
* @member {date} [source.changedTime] Gets the changed time. * @property {date} [source.changedTime] Gets the changed time.
* @member {string} [source.state] Gets the state. Possible values include: * @property {string} [source.state] Gets the state. Possible values include:
* 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', 'Suspended' * 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', 'Suspended'
* @member {string} [source.status] Gets the status. Possible values include: * @property {string} [source.status] Gets the status. Possible values
* 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', * include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded',
* 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', * 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut',
* 'Ignored' * 'Aborted', 'Ignored'
* @member {date} [source.lastExecutionTime] Gets the last execution time. * @property {date} [source.lastExecutionTime] Gets the last execution time.
* @member {date} [source.nextExecutionTime] Gets the next execution time. * @property {date} [source.nextExecutionTime] Gets the next execution time.
* @member {object} [source.recurrence] Gets the workflow trigger recurrence. * @property {object} [source.recurrence] Gets the workflow trigger
* @member {string} [source.recurrence.frequency] The frequency. Possible * recurrence.
* @property {string} [source.recurrence.frequency] The frequency. Possible
* values include: 'NotSpecified', 'Second', 'Minute', 'Hour', 'Day', 'Week', * values include: 'NotSpecified', 'Second', 'Minute', 'Hour', 'Day', 'Week',
* 'Month', 'Year' * 'Month', 'Year'
* @member {number} [source.recurrence.interval] The interval. * @property {number} [source.recurrence.interval] The interval.
* @member {string} [source.recurrence.startTime] The start time. * @property {string} [source.recurrence.startTime] The start time.
* @member {string} [source.recurrence.endTime] The end time. * @property {string} [source.recurrence.endTime] The end time.
* @member {string} [source.recurrence.timeZone] The time zone. * @property {string} [source.recurrence.timeZone] The time zone.
* @member {object} [source.recurrence.schedule] The recurrence schedule. * @property {object} [source.recurrence.schedule] The recurrence schedule.
* @member {array} [source.recurrence.schedule.minutes] The minutes. * @property {array} [source.recurrence.schedule.minutes] The minutes.
* @member {array} [source.recurrence.schedule.hours] The hours. * @property {array} [source.recurrence.schedule.hours] The hours.
* @member {array} [source.recurrence.schedule.weekDays] The days of the * @property {array} [source.recurrence.schedule.weekDays] The days of the
* week. * week.
* @member {array} [source.recurrence.schedule.monthDays] The month days. * @property {array} [source.recurrence.schedule.monthDays] The month days.
* @member {array} [source.recurrence.schedule.monthlyOccurrences] The * @property {array} [source.recurrence.schedule.monthlyOccurrences] The
* monthly occurrences. * monthly occurrences.
* @member {object} [source.workflow] Gets the reference to workflow. * @property {object} [source.workflow] Gets the reference to workflow.
* @member {string} [source.workflow.id] The resource id. * @property {string} [source.workflow.id] The resource id.
* @member {string} [source.workflow.name] Gets the resource name. * @property {string} [source.workflow.name] Gets the resource name.
* @member {string} [source.workflow.type] Gets the resource type. * @property {string} [source.workflow.type] Gets the resource type.
* @member {string} [source.name] Gets the workflow trigger name. * @property {string} [source.name] Gets the workflow trigger name.
* @member {string} [source.type] Gets the workflow trigger type. * @property {string} [source.type] Gets the workflow trigger type.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -17,12 +17,12 @@
class Sku { class Sku {
/** /**
* Create a Sku. * Create a Sku.
* @member {string} name The name. Possible values include: 'NotSpecified', * @property {string} name The name. Possible values include: 'NotSpecified',
* 'Free', 'Shared', 'Basic', 'Standard', 'Premium' * 'Free', 'Shared', 'Basic', 'Standard', 'Premium'
* @member {object} [plan] The reference to plan. * @property {object} [plan] The reference to plan.
* @member {string} [plan.id] The resource id. * @property {string} [plan.id] The resource id.
* @member {string} [plan.name] Gets the resource name. * @property {string} [plan.name] Gets the resource name.
* @member {string} [plan.type] Gets the resource type. * @property {string} [plan.type] Gets the resource type.
*/ */
constructor() { constructor() {
} }

Просмотреть файл

@ -20,7 +20,7 @@ const models = require('./index');
class SubResource extends models['BaseResource'] { class SubResource extends models['BaseResource'] {
/** /**
* Create a SubResource. * Create a SubResource.
* @member {string} [id] The resource id. * @property {string} [id] The resource id.
*/ */
constructor() { constructor() {
super(); super();

Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше