Skip to content

Commit 15f931b

Browse files
author
awstools
committed
feat(client-b2bi): Updated APIs to support inbound EDI split capabilities and additional Partnership-level configurations of generated EDI files' contents and format.
1 parent 95ccc93 commit 15f931b

32 files changed

+1153
-321
lines changed

‎clients/client-b2bi/README.md‎

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,7 @@
66

77
AWS SDK for JavaScript B2bi Client for Node.js, Browser and React Native.
88

9-
<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>
10-
<p>B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud
11-
scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange
12-
transactional data with trading partners, such as suppliers and end customers, using
13-
standardized formats such as X12.</p>
14-
<note>
15-
<p>Rather than actually running a command, you can use the
16-
<code>--generate-cli-skeleton</code> parameter with any API call to generate and display
17-
a parameter template. You can then use the generated template to customize and use as input
18-
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>
19-
</note>
9+
<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>
2010

2111
## Installing
2212

‎clients/client-b2bi/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@
5656
"@smithy/util-middleware": "^4.0.4",
5757
"@smithy/util-retry": "^4.0.6",
5858
"@smithy/util-utf8": "^4.0.0",
59+
"@smithy/util-waiter": "^4.0.6",
5960
"@types/uuid": "^9.0.1",
6061
"tslib": "^2.6.2",
6162
"uuid": "^9.0.1"

‎clients/client-b2bi/src/B2bi.ts‎

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -616,17 +616,7 @@ export interface B2bi {
616616
}
617617

618618
/**
619-
* <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>
620-
* <p>B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud
621-
* scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange
622-
* transactional data with trading partners, such as suppliers and end customers, using
623-
* standardized formats such as X12.</p>
624-
* <note>
625-
* <p>Rather than actually running a command, you can use the
626-
* <code>--generate-cli-skeleton</code> parameter with any API call to generate and display
627-
* a parameter template. You can then use the generated template to customize and use as input
628-
* 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>
629-
* </note>
619+
* <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>
630620
* @public
631621
*/
632622
export class B2bi extends B2biClient implements B2bi {}

‎clients/client-b2bi/src/B2biClient.ts‎

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -364,17 +364,7 @@ export type B2biClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpH
364364
export interface B2biClientResolvedConfig extends B2biClientResolvedConfigType {}
365365

366366
/**
367-
* <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>
368-
* <p>B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud
369-
* scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange
370-
* transactional data with trading partners, such as suppliers and end customers, using
371-
* standardized formats such as X12.</p>
372-
* <note>
373-
* <p>Rather than actually running a command, you can use the
374-
* <code>--generate-cli-skeleton</code> parameter with any API call to generate and display
375-
* a parameter template. You can then use the generated template to customize and use as input
376-
* 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>
377-
* </note>
367+
* <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>
378368
* @public
379369
*/
380370
export class B2biClient extends __Client<

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

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ export interface CreatePartnershipCommandInput extends CreatePartnershipRequest
3333
export interface CreatePartnershipCommandOutput extends CreatePartnershipResponse, __MetadataBearer {}
3434

3535
/**
36-
* <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
37-
* together a profile and one or more trading capabilities.</p>
36+
* <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>
3837
* @example
3938
* Use a bare-bones client and the command you need to make an API call.
4039
* ```javascript
@@ -73,6 +72,25 @@ export interface CreatePartnershipCommandOutput extends CreatePartnershipRespons
7372
* segmentTerminator: "STRING_VALUE",
7473
* },
7574
* validateEdi: true || false,
75+
* controlNumbers: { // X12ControlNumbers
76+
* startingInterchangeControlNumber: Number("int"),
77+
* startingFunctionalGroupControlNumber: Number("int"),
78+
* startingTransactionSetControlNumber: Number("int"),
79+
* },
80+
* gs05TimeFormat: "HHMM" || "HHMMSS" || "HHMMSSDD",
81+
* },
82+
* wrapOptions: { // WrapOptions
83+
* wrapBy: "SEGMENT" || "ONE_LINE" || "LINE_LENGTH", // required
84+
* lineTerminator: "CRLF" || "LF" || "CR",
85+
* lineLength: Number("int"),
86+
* },
87+
* },
88+
* },
89+
* inboundEdi: { // InboundEdiOptions
90+
* x12: { // X12InboundEdiOptions
91+
* acknowledgmentOptions: { // X12AcknowledgmentOptions
92+
* functionalAcknowledgment: "DO_NOT_GENERATE" || "GENERATE_ALL_SEGMENTS" || "GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP", // required
93+
* technicalAcknowledgment: "DO_NOT_GENERATE" || "GENERATE_ALL_SEGMENTS", // required
7694
* },
7795
* },
7896
* },
@@ -121,6 +139,25 @@ export interface CreatePartnershipCommandOutput extends CreatePartnershipRespons
121139
* // segmentTerminator: "STRING_VALUE",
122140
* // },
123141
* // validateEdi: true || false,
142+
* // controlNumbers: { // X12ControlNumbers
143+
* // startingInterchangeControlNumber: Number("int"),
144+
* // startingFunctionalGroupControlNumber: Number("int"),
145+
* // startingTransactionSetControlNumber: Number("int"),
146+
* // },
147+
* // gs05TimeFormat: "HHMM" || "HHMMSS" || "HHMMSSDD",
148+
* // },
149+
* // wrapOptions: { // WrapOptions
150+
* // wrapBy: "SEGMENT" || "ONE_LINE" || "LINE_LENGTH", // required
151+
* // lineTerminator: "CRLF" || "LF" || "CR",
152+
* // lineLength: Number("int"),
153+
* // },
154+
* // },
155+
* // },
156+
* // inboundEdi: { // InboundEdiOptions
157+
* // x12: { // X12InboundEdiOptions
158+
* // acknowledgmentOptions: { // X12AcknowledgmentOptions
159+
* // functionalAcknowledgment: "DO_NOT_GENERATE" || "GENERATE_ALL_SEGMENTS" || "GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP", // required
160+
* // technicalAcknowledgment: "DO_NOT_GENERATE" || "GENERATE_ALL_SEGMENTS", // required
124161
* // },
125162
* // },
126163
* // },

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ export interface CreateProfileCommandInput extends CreateProfileRequest {}
3333
export interface CreateProfileCommandOutput extends CreateProfileResponse, __MetadataBearer {}
3434

3535
/**
36-
* <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
37-
* a private network.</p>
36+
* <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>
3837
* @example
3938
* Use a bare-bones client and the command you need to make an API call.
4039
* ```javascript

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

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,7 @@ export interface CreateStarterMappingTemplateCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <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>
37-
* <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.
38-
* 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
39-
* into the JSON or XML file that is used to generate the EDI.</p>
40-
* <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.
41-
* </p>
42-
* <p> Currently, we only support generating a template that can generate the input to produce an Outbound X12 EDI file.</p>
36+
* <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>
4337
* @example
4438
* Use a bare-bones client and the command you need to make an API call.
4539
* ```javascript

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

Lines changed: 15 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -28,39 +28,7 @@ export interface CreateTransformerCommandInput extends CreateTransformerRequest
2828
export interface CreateTransformerCommandOutput extends CreateTransformerResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios:</p>
32-
* <ul>
33-
* <li>
34-
* <p>
35-
* <i>Inbound EDI</i>: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange
36-
* converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer,
37-
* 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>
38-
* </li>
39-
* <li>
40-
* <p>
41-
* <i>Outbound EDI</i>: the Amazon Web Services customer has a JSON or XML file containing data that they wish to use
42-
* in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate
43-
* a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.</p>
44-
* </li>
45-
* </ul>
46-
* <note>
47-
* <p>The following fields are provided for backwards compatibility only: <code>fileFormat</code>,
48-
* <code>mappingTemplate</code>, <code>ediType</code>, and <code>sampleDocument</code>.</p>
49-
* <ul>
50-
* <li>
51-
* <p>Use the <code>mapping</code> data type in place of <code>mappingTemplate</code> and <code>fileFormat</code>
52-
* </p>
53-
* </li>
54-
* <li>
55-
* <p>Use the <code>sampleDocuments</code> data type in place of <code>sampleDocument</code>
56-
* </p>
57-
* </li>
58-
* <li>
59-
* <p>Use either the <code>inputConversion</code> or <code>outputConversion</code> in place of <code>ediType</code>
60-
* </p>
61-
* </li>
62-
* </ul>
63-
* </note>
31+
* <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>
6432
* @example
6533
* Use a bare-bones client and the command you need to make an API call.
6634
* ```javascript
@@ -93,6 +61,13 @@ export interface CreateTransformerCommandOutput extends CreateTransformerRespons
9361
* version: "VERSION_4010" || "VERSION_4030" || "VERSION_4050" || "VERSION_4060" || "VERSION_5010" || "VERSION_5010_HIPAA",
9462
* },
9563
* },
64+
* advancedOptions: { // AdvancedOptions
65+
* x12: { // X12AdvancedOptions
66+
* splitOptions: { // X12SplitOptions
67+
* splitBy: "NONE" || "TRANSACTION", // required
68+
* },
69+
* },
70+
* },
9671
* },
9772
* mapping: { // Mapping
9873
* templateLanguage: "XSLT" || "JSONATA", // required
@@ -142,6 +117,13 @@ export interface CreateTransformerCommandOutput extends CreateTransformerRespons
142117
* // version: "VERSION_4010" || "VERSION_4030" || "VERSION_4050" || "VERSION_4060" || "VERSION_5010" || "VERSION_5010_HIPAA",
143118
* // },
144119
* // },
120+
* // advancedOptions: { // AdvancedOptions
121+
* // x12: { // X12AdvancedOptions
122+
* // splitOptions: { // X12SplitOptions
123+
* // splitBy: "NONE" || "TRANSACTION", // required
124+
* // },
125+
* // },
126+
* // },
145127
* // },
146128
* // mapping: { // Mapping
147129
* // templateLanguage: "XSLT" || "JSONATA", // required

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface DeletePartnershipCommandInput extends DeletePartnershipRequest
2828
export interface DeletePartnershipCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes the specified partnership. A partnership represents the connection between you and your trading partner. It ties
32-
* together a profile and one or more trading capabilities.</p>
31+
* <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>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface DeleteProfileCommandInput extends DeleteProfileRequest {}
2828
export interface DeleteProfileCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes the specified profile. A profile is the mechanism used to create the concept of
32-
* a private network.</p>
31+
* <p>Deletes the specified profile. A profile is the mechanism used to create the concept of a private network.</p>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript

0 commit comments

Comments
 (0)