feat(client-b2bi): Updated APIs to support inbound EDI split capabilities and additional Partnership-level configurations of generated EDI files' contents and format.

Author: awstools

clients/client-b2bi/README.md

@@ -6,17 +6,7 @@
 
 AWS SDK for JavaScript B2bi Client for Node.js, Browser and React Native.
 
-<p>This is the <i>Amazon Web Services B2B Data Interchange API Reference</i>. It provides descriptions, API request parameters, and the XML response for each of the B2BI API actions.</p>
-<p>B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud
-scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange
-transactional data with trading partners, such as suppliers and end customers, using
-standardized formats such as X12.</p>
-<note>
-<p>Rather than actually running a command, you can use the
-<code>--generate-cli-skeleton</code> parameter with any API call to generate and display
-a parameter template. You can then use the generated template to customize and use as input
-on a later command. For details, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-skeleton.html#cli-usage-skeleton-generate">Generate and use a parameter skeleton file</a>.</p>
-</note>
+<p>This is the <i>Amazon Web Services B2B Data Interchange API Reference</i>. It provides descriptions, API request parameters, and the XML response for each of the B2BI API actions.</p> <p>B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange transactional data with trading partners, such as suppliers and end customers, using standardized formats such as X12.</p> <note> <p>Rather than actually running a command, you can use the <code>--generate-cli-skeleton</code> parameter with any API call to generate and display a parameter template. You can then use the generated template to customize and use as input on a later command. For details, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-skeleton.html#cli-usage-skeleton-generate">Generate and use a parameter skeleton file</a>.</p> </note>
 
 ## Installing
 

clients/client-b2bi/package.json

@@ -56,6 +56,7 @@
     "@smithy/util-middleware": "^4.0.4",
     "@smithy/util-retry": "^4.0.6",
     "@smithy/util-utf8": "^4.0.0",
+    "@smithy/util-waiter": "^4.0.6",
     "@types/uuid": "^9.0.1",
     "tslib": "^2.6.2",
     "uuid": "^9.0.1"

clients/client-b2bi/src/B2bi.ts

@@ -616,17 +616,7 @@ export interface B2bi {
 }
 
 /**
- * <p>This is the <i>Amazon Web Services B2B Data Interchange API Reference</i>. It provides descriptions, API request parameters, and the XML response for each of the B2BI API actions.</p>
- *          <p>B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud
- *          scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange
- *          transactional data with trading partners, such as suppliers and end customers, using
- *          standardized formats such as X12.</p>
- *          <note>
- *             <p>Rather than actually running a command, you can use the
- *             <code>--generate-cli-skeleton</code> parameter with any API call to generate and display
- *             a parameter template. You can then use the generated template to customize and use as input
- *             on a later command. For details, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-skeleton.html#cli-usage-skeleton-generate">Generate and use a parameter skeleton file</a>.</p>
- *          </note>
+ * <p>This is the <i>Amazon Web Services B2B Data Interchange API Reference</i>. It provides descriptions, API request parameters, and the XML response for each of the B2BI API actions.</p> <p>B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange transactional data with trading partners, such as suppliers and end customers, using standardized formats such as X12.</p> <note> <p>Rather than actually running a command, you can use the <code>--generate-cli-skeleton</code> parameter with any API call to generate and display a parameter template. You can then use the generated template to customize and use as input on a later command. For details, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-skeleton.html#cli-usage-skeleton-generate">Generate and use a parameter skeleton file</a>.</p> </note>
  * @public
  */
 export class B2bi extends B2biClient implements B2bi {}

clients/client-b2bi/src/B2biClient.ts

@@ -364,17 +364,7 @@ export type B2biClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpH
 export interface B2biClientResolvedConfig extends B2biClientResolvedConfigType {}
 
 /**
- * <p>This is the <i>Amazon Web Services B2B Data Interchange API Reference</i>. It provides descriptions, API request parameters, and the XML response for each of the B2BI API actions.</p>
- *          <p>B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud
- *          scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange
- *          transactional data with trading partners, such as suppliers and end customers, using
- *          standardized formats such as X12.</p>
- *          <note>
- *             <p>Rather than actually running a command, you can use the
- *             <code>--generate-cli-skeleton</code> parameter with any API call to generate and display
- *             a parameter template. You can then use the generated template to customize and use as input
- *             on a later command. For details, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-skeleton.html#cli-usage-skeleton-generate">Generate and use a parameter skeleton file</a>.</p>
- *          </note>
+ * <p>This is the <i>Amazon Web Services B2B Data Interchange API Reference</i>. It provides descriptions, API request parameters, and the XML response for each of the B2BI API actions.</p> <p>B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange transactional data with trading partners, such as suppliers and end customers, using standardized formats such as X12.</p> <note> <p>Rather than actually running a command, you can use the <code>--generate-cli-skeleton</code> parameter with any API call to generate and display a parameter template. You can then use the generated template to customize and use as input on a later command. For details, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-skeleton.html#cli-usage-skeleton-generate">Generate and use a parameter skeleton file</a>.</p> </note>
  * @public
  */
 export class B2biClient extends __Client<

clients/client-b2bi/src/commands/CreatePartnershipCommand.ts

@@ -33,8 +33,7 @@ export interface CreatePartnershipCommandInput extends CreatePartnershipRequest
 export interface CreatePartnershipCommandOutput extends CreatePartnershipResponse, __MetadataBearer {}
 
 /**
- * <p>Creates a partnership between a customer and a trading partner, based on the supplied parameters. A partnership represents the connection between you and your trading partner. It ties
- *    together a profile and one or more trading capabilities.</p>
+ * <p>Creates a partnership between a customer and a trading partner, based on the supplied parameters. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -73,6 +72,25 @@ export interface CreatePartnershipCommandOutput extends CreatePartnershipRespons
  *             segmentTerminator: "STRING_VALUE",
  *           },
  *           validateEdi: true || false,
+ *           controlNumbers: { // X12ControlNumbers
+ *             startingInterchangeControlNumber: Number("int"),
+ *             startingFunctionalGroupControlNumber: Number("int"),
+ *             startingTransactionSetControlNumber: Number("int"),
+ *           },
+ *           gs05TimeFormat: "HHMM" || "HHMMSS" || "HHMMSSDD",
+ *         },
+ *         wrapOptions: { // WrapOptions
+ *           wrapBy: "SEGMENT" || "ONE_LINE" || "LINE_LENGTH", // required
+ *           lineTerminator: "CRLF" || "LF" || "CR",
+ *           lineLength: Number("int"),
+ *         },
+ *       },
+ *     },
+ *     inboundEdi: { // InboundEdiOptions
+ *       x12: { // X12InboundEdiOptions
+ *         acknowledgmentOptions: { // X12AcknowledgmentOptions
+ *           functionalAcknowledgment: "DO_NOT_GENERATE" || "GENERATE_ALL_SEGMENTS" || "GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP", // required
+ *           technicalAcknowledgment: "DO_NOT_GENERATE" || "GENERATE_ALL_SEGMENTS", // required
  *         },
  *       },
  *     },
@@ -121,6 +139,25 @@ export interface CreatePartnershipCommandOutput extends CreatePartnershipRespons
  * //             segmentTerminator: "STRING_VALUE",
  * //           },
  * //           validateEdi: true || false,
+ * //           controlNumbers: { // X12ControlNumbers
+ * //             startingInterchangeControlNumber: Number("int"),
+ * //             startingFunctionalGroupControlNumber: Number("int"),
+ * //             startingTransactionSetControlNumber: Number("int"),
+ * //           },
+ * //           gs05TimeFormat: "HHMM" || "HHMMSS" || "HHMMSSDD",
+ * //         },
+ * //         wrapOptions: { // WrapOptions
+ * //           wrapBy: "SEGMENT" || "ONE_LINE" || "LINE_LENGTH", // required
+ * //           lineTerminator: "CRLF" || "LF" || "CR",
+ * //           lineLength: Number("int"),
+ * //         },
+ * //       },
+ * //     },
+ * //     inboundEdi: { // InboundEdiOptions
+ * //       x12: { // X12InboundEdiOptions
+ * //         acknowledgmentOptions: { // X12AcknowledgmentOptions
+ * //           functionalAcknowledgment: "DO_NOT_GENERATE" || "GENERATE_ALL_SEGMENTS" || "GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP", // required
+ * //           technicalAcknowledgment: "DO_NOT_GENERATE" || "GENERATE_ALL_SEGMENTS", // required
  * //         },
  * //       },
  * //     },

clients/client-b2bi/src/commands/CreateProfileCommand.ts

@@ -33,8 +33,7 @@ export interface CreateProfileCommandInput extends CreateProfileRequest {}
 export interface CreateProfileCommandOutput extends CreateProfileResponse, __MetadataBearer {}
 
 /**
- * <p>Creates a customer profile. You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of
- *    a private network.</p>
+ * <p>Creates a customer profile. You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of a private network.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/CreateStarterMappingTemplateCommand.ts

@@ -33,13 +33,7 @@ export interface CreateStarterMappingTemplateCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI.</p>
- *          <p>If you provide a sample EDI file with the same structure as the EDI files that you wish to generate, then the service can generate a mapping template.
- *       The starter template contains placeholder values which you can replace with JSONata or XSLT expressions to take data from your input file and insert it
- *       into the JSON or XML file that is used to generate the EDI.</p>
- *          <p>If you do not provide a sample EDI file, then the service can generate a mapping template based on the EDI settings in the <code>templateDetails</code> parameter.
- *    </p>
- *          <p> Currently, we only support generating a template that can generate the input to produce an Outbound X12 EDI file.</p>
+ * <p>Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI.</p> <p>If you provide a sample EDI file with the same structure as the EDI files that you wish to generate, then the service can generate a mapping template. The starter template contains placeholder values which you can replace with JSONata or XSLT expressions to take data from your input file and insert it into the JSON or XML file that is used to generate the EDI.</p> <p>If you do not provide a sample EDI file, then the service can generate a mapping template based on the EDI settings in the <code>templateDetails</code> parameter. </p> <p> Currently, we only support generating a template that can generate the input to produce an Outbound X12 EDI file.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/CreateTransformerCommand.ts

@@ -28,39 +28,7 @@ export interface CreateTransformerCommandInput extends CreateTransformerRequest
 export interface CreateTransformerCommandOutput extends CreateTransformerResponse, __MetadataBearer {}
 
 /**
- * <p>Creates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <i>Inbound EDI</i>: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange
- *                converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer,
- *                in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <i>Outbound EDI</i>: the Amazon Web Services customer has a JSON or XML file containing data that they wish to use
- *                in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate
- *                a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.</p>
- *             </li>
- *          </ul>
- *          <note>
- *             <p>The following fields are provided for backwards compatibility only: <code>fileFormat</code>,
- *             <code>mappingTemplate</code>, <code>ediType</code>, and <code>sampleDocument</code>.</p>
- *             <ul>
- *                <li>
- *                   <p>Use the <code>mapping</code> data type in place of <code>mappingTemplate</code> and <code>fileFormat</code>
- *                   </p>
- *                </li>
- *                <li>
- *                   <p>Use the <code>sampleDocuments</code> data type in place of <code>sampleDocument</code>
- *                   </p>
- *                </li>
- *                <li>
- *                   <p>Use either the <code>inputConversion</code> or <code>outputConversion</code> in place of <code>ediType</code>
- *                   </p>
- *                </li>
- *             </ul>
- *          </note>
+ * <p>Creates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios:</p> <ul> <li> <p> <i>Inbound EDI</i>: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.</p> </li> <li> <p> <i>Outbound EDI</i>: the Amazon Web Services customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.</p> </li> </ul> <note> <p>The following fields are provided for backwards compatibility only: <code>fileFormat</code>, <code>mappingTemplate</code>, <code>ediType</code>, and <code>sampleDocument</code>.</p> <ul> <li> <p>Use the <code>mapping</code> data type in place of <code>mappingTemplate</code> and <code>fileFormat</code> </p> </li> <li> <p>Use the <code>sampleDocuments</code> data type in place of <code>sampleDocument</code> </p> </li> <li> <p>Use either the <code>inputConversion</code> or <code>outputConversion</code> in place of <code>ediType</code> </p> </li> </ul> </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -93,6 +61,13 @@ export interface CreateTransformerCommandOutput extends CreateTransformerRespons
  *         version: "VERSION_4010" || "VERSION_4030" || "VERSION_4050" || "VERSION_4060" || "VERSION_5010" || "VERSION_5010_HIPAA",
  *       },
  *     },
+ *     advancedOptions: { // AdvancedOptions
+ *       x12: { // X12AdvancedOptions
+ *         splitOptions: { // X12SplitOptions
+ *           splitBy: "NONE" || "TRANSACTION", // required
+ *         },
+ *       },
+ *     },
  *   },
  *   mapping: { // Mapping
  *     templateLanguage: "XSLT" || "JSONATA", // required
@@ -142,6 +117,13 @@ export interface CreateTransformerCommandOutput extends CreateTransformerRespons
  * //         version: "VERSION_4010" || "VERSION_4030" || "VERSION_4050" || "VERSION_4060" || "VERSION_5010" || "VERSION_5010_HIPAA",
  * //       },
  * //     },
+ * //     advancedOptions: { // AdvancedOptions
+ * //       x12: { // X12AdvancedOptions
+ * //         splitOptions: { // X12SplitOptions
+ * //           splitBy: "NONE" || "TRANSACTION", // required
+ * //         },
+ * //       },
+ * //     },
  * //   },
  * //   mapping: { // Mapping
  * //     templateLanguage: "XSLT" || "JSONATA", // required

clients/client-b2bi/src/commands/DeletePartnershipCommand.ts

@@ -28,8 +28,7 @@ export interface DeletePartnershipCommandInput extends DeletePartnershipRequest
 export interface DeletePartnershipCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes the specified partnership. A partnership represents the connection between you and your trading partner. It ties
- *    together a profile and one or more trading capabilities.</p>
+ * <p>Deletes the specified partnership. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/DeleteProfileCommand.ts

@@ -28,8 +28,7 @@ export interface DeleteProfileCommandInput extends DeleteProfileRequest {}
 export interface DeleteProfileCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes the specified profile. A profile is the mechanism used to create the concept of
- *    a private network.</p>
+ * <p>Deletes the specified profile. A profile is the mechanism used to create the concept of a private network.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript