@aws-sdk/client-b2bi 3.459.0 → 3.460.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. package/dist-types/commands/CreateCapabilityCommand.d.ts +78 -0
  2. package/dist-types/commands/CreatePartnershipCommand.d.ts +39 -0
  3. package/dist-types/commands/CreateProfileCommand.d.ts +35 -0
  4. package/dist-types/commands/CreateTransformerCommand.d.ts +45 -0
  5. package/dist-types/commands/DeleteCapabilityCommand.d.ts +11 -0
  6. package/dist-types/commands/DeletePartnershipCommand.d.ts +11 -0
  7. package/dist-types/commands/DeleteProfileCommand.d.ts +11 -0
  8. package/dist-types/commands/DeleteTransformerCommand.d.ts +11 -0
  9. package/dist-types/commands/GetCapabilityCommand.d.ts +46 -0
  10. package/dist-types/commands/GetPartnershipCommand.d.ts +27 -0
  11. package/dist-types/commands/GetProfileCommand.d.ts +24 -0
  12. package/dist-types/commands/GetTransformerCommand.d.ts +30 -0
  13. package/dist-types/commands/GetTransformerJobCommand.d.ts +24 -0
  14. package/dist-types/commands/ListCapabilitiesCommand.d.ts +26 -0
  15. package/dist-types/commands/ListPartnershipsCommand.d.ts +31 -0
  16. package/dist-types/commands/ListProfilesCommand.d.ts +27 -0
  17. package/dist-types/commands/ListTagsForResourceCommand.d.ts +21 -0
  18. package/dist-types/commands/ListTransformersCommand.d.ts +35 -0
  19. package/dist-types/commands/StartTransformerJobCommand.d.ts +25 -0
  20. package/dist-types/commands/TagResourceCommand.d.ts +17 -0
  21. package/dist-types/commands/TestMappingCommand.d.ts +18 -0
  22. package/dist-types/commands/TestParsingCommand.d.ts +26 -0
  23. package/dist-types/commands/UntagResourceCommand.d.ts +14 -0
  24. package/dist-types/commands/UpdateCapabilityCommand.d.ts +72 -0
  25. package/dist-types/commands/UpdatePartnershipCommand.d.ts +31 -0
  26. package/dist-types/commands/UpdateProfileCommand.d.ts +29 -0
  27. package/dist-types/commands/UpdateTransformerCommand.d.ts +41 -0
  28. package/package.json +12 -12
@@ -133,6 +133,84 @@ export interface CreateCapabilityCommandOutput extends CreateCapabilityResponse,
133
133
  * @throws {@link B2biServiceException}
134
134
  * <p>Base exception class for all service exceptions from B2bi service.</p>
135
135
  *
136
+ * @example Sample CreateCapability call
137
+ * ```javascript
138
+ * //
139
+ * const input = {
140
+ * "name": "b2biexample",
141
+ * "type": "edi",
142
+ * "clientToken": "foo",
143
+ * "configuration": {
144
+ * "edi": {
145
+ * "type": {
146
+ * "x12Details": {
147
+ * "version": "VERSION_4010",
148
+ * "transactionSet": "X12_110"
149
+ * }
150
+ * },
151
+ * "inputLocation": {
152
+ * "key": "input/",
153
+ * "bucketName": "test-bucket"
154
+ * },
155
+ * "outputLocation": {
156
+ * "key": "output/",
157
+ * "bucketName": "test-bucket"
158
+ * },
159
+ * "transformerId": "tr-9a893cf536df4658b"
160
+ * }
161
+ * },
162
+ * "instructionsDocuments": [
163
+ * {
164
+ * "key": "instructiondoc.txt",
165
+ * "bucketName": "test-bucket"
166
+ * }
167
+ * ],
168
+ * "tags": [
169
+ * {
170
+ * "Key": "capabilityKey1",
171
+ * "Value": "capabilityValue1"
172
+ * }
173
+ * ]
174
+ * };
175
+ * const command = new CreateCapabilityCommand(input);
176
+ * const response = await client.send(command);
177
+ * /* response ==
178
+ * {
179
+ * "name": "b2biexample",
180
+ * "type": "edi",
181
+ * "capabilityArn": "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348",
182
+ * "capabilityId": "ca-963a8121e4fc4e348",
183
+ * "configuration": {
184
+ * "edi": {
185
+ * "type": {
186
+ * "x12Details": {
187
+ * "version": "VERSION_4010",
188
+ * "transactionSet": "X12_110"
189
+ * }
190
+ * },
191
+ * "inputLocation": {
192
+ * "key": "input/",
193
+ * "bucketName": "test-bucket"
194
+ * },
195
+ * "outputLocation": {
196
+ * "key": "output/",
197
+ * "bucketName": "test-bucket"
198
+ * },
199
+ * "transformerId": "tr-9a893cf536df4658b"
200
+ * }
201
+ * },
202
+ * "createdAt": "2023-11-01T21:51:05.504Z",
203
+ * "instructionsDocuments": [
204
+ * {
205
+ * "key": "instructiondoc.txt",
206
+ * "bucketName": "test-bucket"
207
+ * }
208
+ * ]
209
+ * }
210
+ * *\/
211
+ * // example id: example-1
212
+ * ```
213
+ *
136
214
  */
137
215
  export declare class CreateCapabilityCommand extends $Command<CreateCapabilityCommandInput, CreateCapabilityCommandOutput, B2biClientResolvedConfig> {
138
216
  readonly input: CreateCapabilityCommandInput;
@@ -94,6 +94,45 @@ export interface CreatePartnershipCommandOutput extends CreatePartnershipRespons
94
94
  * @throws {@link B2biServiceException}
95
95
  * <p>Base exception class for all service exceptions from B2bi service.</p>
96
96
  *
97
+ * @example Sample CreatePartnership call
98
+ * ```javascript
99
+ * //
100
+ * const input = {
101
+ * "name": "b2bipartner",
102
+ * "capabilities": [
103
+ * "ca-963a8121e4fc4e348"
104
+ * ],
105
+ * "clientToken": "foo",
106
+ * "email": "john@example.com",
107
+ * "phone": "5555555555",
108
+ * "profileId": "p-60fbc37c87f04fce9",
109
+ * "tags": [
110
+ * {
111
+ * "Key": "sampleKey1",
112
+ * "Value": "sampleValue1"
113
+ * }
114
+ * ]
115
+ * };
116
+ * const command = new CreatePartnershipCommand(input);
117
+ * const response = await client.send(command);
118
+ * /* response ==
119
+ * {
120
+ * "name": "b2bipartner",
121
+ * "capabilities": [
122
+ * "ca-963a8121e4fc4e348"
123
+ * ],
124
+ * "createdAt": "2023-11-01T21:51:05.504Z",
125
+ * "email": "john@example.com",
126
+ * "partnershipArn": "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-60fbc37c87f04fce9",
127
+ * "partnershipId": "ps-219fa02f5b4242af8",
128
+ * "phone": "5555555555",
129
+ * "profileId": "p-60fbc37c87f04fce9",
130
+ * "tradingPartnerId": "tp-2a17ca447f6f4a8a8"
131
+ * }
132
+ * *\/
133
+ * // example id: example-1
134
+ * ```
135
+ *
97
136
  */
98
137
  export declare class CreatePartnershipCommand extends $Command<CreatePartnershipCommandInput, CreatePartnershipCommandOutput, B2biClientResolvedConfig> {
99
138
  readonly input: CreatePartnershipCommandInput;
@@ -90,6 +90,41 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __Met
90
90
  * @throws {@link B2biServiceException}
91
91
  * <p>Base exception class for all service exceptions from B2bi service.</p>
92
92
  *
93
+ * @example Sample CreateProfile call
94
+ * ```javascript
95
+ * //
96
+ * const input = {
97
+ * "name": "Shipping Profile",
98
+ * "businessName": "John's Shipping",
99
+ * "clientToken": "foo",
100
+ * "email": "john@example.com",
101
+ * "logging": "ENABLED",
102
+ * "phone": "5555555555",
103
+ * "tags": [
104
+ * {
105
+ * "Key": "sampleKey",
106
+ * "Value": "sampleValue"
107
+ * }
108
+ * ]
109
+ * };
110
+ * const command = new CreateProfileCommand(input);
111
+ * const response = await client.send(command);
112
+ * /* response ==
113
+ * {
114
+ * "name": "Shipping Profile",
115
+ * "businessName": "John's Trucking",
116
+ * "createdAt": "2023-11-01T21:51:05.504Z",
117
+ * "email": "john@example.com",
118
+ * "logGroupName": "b2bi/p-60fbc37c87f04fce9-Logs",
119
+ * "logging": "ENABLED",
120
+ * "phone": "5555555555",
121
+ * "profileArn": "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9",
122
+ * "profileId": "p-60fbc37c87f04fce9"
123
+ * }
124
+ * *\/
125
+ * // example id: example-1
126
+ * ```
127
+ *
93
128
  */
94
129
  export declare class CreateProfileCommand extends $Command<CreateProfileCommandInput, CreateProfileCommandOutput, B2biClientResolvedConfig> {
95
130
  readonly input: CreateProfileCommandInput;
@@ -100,6 +100,51 @@ export interface CreateTransformerCommandOutput extends CreateTransformerRespons
100
100
  * @throws {@link B2biServiceException}
101
101
  * <p>Base exception class for all service exceptions from B2bi service.</p>
102
102
  *
103
+ * @example Sample CreateTransformer call
104
+ * ```javascript
105
+ * //
106
+ * const input = {
107
+ * "name": "transformJSON",
108
+ * "clientToken": "foo",
109
+ * "ediType": {
110
+ * "x12Details": {
111
+ * "version": "VERSION_4010",
112
+ * "transactionSet": "X12_110"
113
+ * }
114
+ * },
115
+ * "fileFormat": "JSON",
116
+ * "mappingTemplate": "{}",
117
+ * "sampleDocument": "s3://test-bucket/sampleDoc.txt",
118
+ * "tags": [
119
+ * {
120
+ * "Key": "sampleKey",
121
+ * "Value": "sampleValue"
122
+ * }
123
+ * ]
124
+ * };
125
+ * const command = new CreateTransformerCommand(input);
126
+ * const response = await client.send(command);
127
+ * /* response ==
128
+ * {
129
+ * "name": "transformJSON",
130
+ * "createdAt": "2023-11-01T21:51:05.504Z",
131
+ * "ediType": {
132
+ * "x12Details": {
133
+ * "version": "VERSION_4010",
134
+ * "transactionSet": "X12_110"
135
+ * }
136
+ * },
137
+ * "fileFormat": "JSON",
138
+ * "mappingTemplate": "$",
139
+ * "sampleDocument": "s3://test-bucket/sampleDoc.txt",
140
+ * "status": "inactive",
141
+ * "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9",
142
+ * "transformerId": "tr-974c129999f84d8c9"
143
+ * }
144
+ * *\/
145
+ * // example id: example-1
146
+ * ```
147
+ *
103
148
  */
104
149
  export declare class CreateTransformerCommand extends $Command<CreateTransformerCommandInput, CreateTransformerCommandOutput, B2biClientResolvedConfig> {
105
150
  readonly input: CreateTransformerCommandInput;
@@ -66,6 +66,17 @@ export interface DeleteCapabilityCommandOutput extends __MetadataBearer {
66
66
  * @throws {@link B2biServiceException}
67
67
  * <p>Base exception class for all service exceptions from B2bi service.</p>
68
68
  *
69
+ * @example Sample DeleteCapabilty call
70
+ * ```javascript
71
+ * //
72
+ * const input = {
73
+ * "capabilityId": "ca-963a8121e4fc4e348"
74
+ * };
75
+ * const command = new DeleteCapabilityCommand(input);
76
+ * await client.send(command);
77
+ * // example id: example-1
78
+ * ```
79
+ *
69
80
  */
70
81
  export declare class DeleteCapabilityCommand extends $Command<DeleteCapabilityCommandInput, DeleteCapabilityCommandOutput, B2biClientResolvedConfig> {
71
82
  readonly input: DeleteCapabilityCommandInput;
@@ -66,6 +66,17 @@ export interface DeletePartnershipCommandOutput extends __MetadataBearer {
66
66
  * @throws {@link B2biServiceException}
67
67
  * <p>Base exception class for all service exceptions from B2bi service.</p>
68
68
  *
69
+ * @example Sample DeletePartnership call
70
+ * ```javascript
71
+ * //
72
+ * const input = {
73
+ * "partnershipId": "ps-219fa02f5b4242af8"
74
+ * };
75
+ * const command = new DeletePartnershipCommand(input);
76
+ * await client.send(command);
77
+ * // example id: example-1
78
+ * ```
79
+ *
69
80
  */
70
81
  export declare class DeletePartnershipCommand extends $Command<DeletePartnershipCommandInput, DeletePartnershipCommandOutput, B2biClientResolvedConfig> {
71
82
  readonly input: DeletePartnershipCommandInput;
@@ -66,6 +66,17 @@ export interface DeleteProfileCommandOutput extends __MetadataBearer {
66
66
  * @throws {@link B2biServiceException}
67
67
  * <p>Base exception class for all service exceptions from B2bi service.</p>
68
68
  *
69
+ * @example Sample DeleteProfile call
70
+ * ```javascript
71
+ * //
72
+ * const input = {
73
+ * "profileId": "p-60fbc37c87f04fce9"
74
+ * };
75
+ * const command = new DeleteProfileCommand(input);
76
+ * await client.send(command);
77
+ * // example id: example-1
78
+ * ```
79
+ *
69
80
  */
70
81
  export declare class DeleteProfileCommand extends $Command<DeleteProfileCommandInput, DeleteProfileCommandOutput, B2biClientResolvedConfig> {
71
82
  readonly input: DeleteProfileCommandInput;
@@ -66,6 +66,17 @@ export interface DeleteTransformerCommandOutput extends __MetadataBearer {
66
66
  * @throws {@link B2biServiceException}
67
67
  * <p>Base exception class for all service exceptions from B2bi service.</p>
68
68
  *
69
+ * @example Sample DeleteTransformer call
70
+ * ```javascript
71
+ * //
72
+ * const input = {
73
+ * "transformerId": "tr-974c129999f84d8c9"
74
+ * };
75
+ * const command = new DeleteTransformerCommand(input);
76
+ * await client.send(command);
77
+ * // example id: example-1
78
+ * ```
79
+ *
69
80
  */
70
81
  export declare class DeleteTransformerCommand extends $Command<DeleteTransformerCommandInput, DeleteTransformerCommandOutput, B2biClientResolvedConfig> {
71
82
  readonly input: DeleteTransformerCommandInput;
@@ -95,6 +95,52 @@ export interface GetCapabilityCommandOutput extends GetCapabilityResponse, __Met
95
95
  * @throws {@link B2biServiceException}
96
96
  * <p>Base exception class for all service exceptions from B2bi service.</p>
97
97
  *
98
+ * @example Sample GetCapabilty call
99
+ * ```javascript
100
+ * //
101
+ * const input = {
102
+ * "capabilityId": "ca-963a8121e4fc4e348"
103
+ * };
104
+ * const command = new GetCapabilityCommand(input);
105
+ * const response = await client.send(command);
106
+ * /* response ==
107
+ * {
108
+ * "name": "b2biexample",
109
+ * "type": "edi",
110
+ * "capabilityArn": "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348",
111
+ * "capabilityId": "ca-963a8121e4fc4e348",
112
+ * "configuration": {
113
+ * "edi": {
114
+ * "type": {
115
+ * "x12Details": {
116
+ * "version": "VERSION_4010",
117
+ * "transactionSet": "X12_110"
118
+ * }
119
+ * },
120
+ * "inputLocation": {
121
+ * "key": "input/",
122
+ * "bucketName": "test-bucket"
123
+ * },
124
+ * "outputLocation": {
125
+ * "key": "output/",
126
+ * "bucketName": "test-bucket"
127
+ * },
128
+ * "transformerId": "tr-9a893cf536df4658b"
129
+ * }
130
+ * },
131
+ * "createdAt": "2023-11-01T21:51:05.504Z",
132
+ * "instructionsDocuments": [
133
+ * {
134
+ * "key": "instructiondoc.txt",
135
+ * "bucketName": "test-bucket"
136
+ * }
137
+ * ],
138
+ * "modifiedAt": "2023-11-02T21:51:05.504Z"
139
+ * }
140
+ * *\/
141
+ * // example id: example-1
142
+ * ```
143
+ *
98
144
  */
99
145
  export declare class GetCapabilityCommand extends $Command<GetCapabilityCommandInput, GetCapabilityCommandOutput, B2biClientResolvedConfig> {
100
146
  readonly input: GetCapabilityCommandInput;
@@ -76,6 +76,33 @@ export interface GetPartnershipCommandOutput extends GetPartnershipResponse, __M
76
76
  * @throws {@link B2biServiceException}
77
77
  * <p>Base exception class for all service exceptions from B2bi service.</p>
78
78
  *
79
+ * @example Sample GetPartnership call
80
+ * ```javascript
81
+ * //
82
+ * const input = {
83
+ * "partnershipId": "ps-219fa02f5b4242af8"
84
+ * };
85
+ * const command = new GetPartnershipCommand(input);
86
+ * const response = await client.send(command);
87
+ * /* response ==
88
+ * {
89
+ * "name": "b2bipartner",
90
+ * "capabilities": [
91
+ * "ca-963a8121e4fc4e348"
92
+ * ],
93
+ * "createdAt": "2023-11-01T21:51:05.504Z",
94
+ * "email": "john@example.com",
95
+ * "modifiedAt": "2023-11-01T21:51:05.504Z",
96
+ * "partnershipArn": "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-219fa02f5b4242af8",
97
+ * "partnershipId": "ps-219fa02f5b4242af8",
98
+ * "phone": "5555555555",
99
+ * "profileId": "p-60fbc37c87f04fce9",
100
+ * "tradingPartnerId": "tp-2a17ca447f6f4a8a8"
101
+ * }
102
+ * *\/
103
+ * // example id: example-1
104
+ * ```
105
+ *
79
106
  */
80
107
  export declare class GetPartnershipCommand extends $Command<GetPartnershipCommandInput, GetPartnershipCommandOutput, B2biClientResolvedConfig> {
81
108
  readonly input: GetPartnershipCommandInput;
@@ -74,6 +74,30 @@ export interface GetProfileCommandOutput extends GetProfileResponse, __MetadataB
74
74
  * @throws {@link B2biServiceException}
75
75
  * <p>Base exception class for all service exceptions from B2bi service.</p>
76
76
  *
77
+ * @example Sample GetProfile call
78
+ * ```javascript
79
+ * //
80
+ * const input = {
81
+ * "profileId": "p-60fbc37c87f04fce9"
82
+ * };
83
+ * const command = new GetProfileCommand(input);
84
+ * const response = await client.send(command);
85
+ * /* response ==
86
+ * {
87
+ * "name": "Shipping Profile",
88
+ * "businessName": "John's Trucking",
89
+ * "createdAt": "2023-11-01T21:51:05.504Z",
90
+ * "email": "john@example.com",
91
+ * "logGroupName": "b2bi/p-60fbc37c87f04fce9-Logs",
92
+ * "logging": "ENABLED",
93
+ * "phone": "5555555555",
94
+ * "profileArn": "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9",
95
+ * "profileId": "p-60fbc37c87f04fce9"
96
+ * }
97
+ * *\/
98
+ * // example id: example-1
99
+ * ```
100
+ *
77
101
  */
78
102
  export declare class GetProfileCommand extends $Command<GetProfileCommandInput, GetProfileCommandOutput, B2biClientResolvedConfig> {
79
103
  readonly input: GetProfileCommandInput;
@@ -79,6 +79,36 @@ export interface GetTransformerCommandOutput extends GetTransformerResponse, __M
79
79
  * @throws {@link B2biServiceException}
80
80
  * <p>Base exception class for all service exceptions from B2bi service.</p>
81
81
  *
82
+ * @example Sample GetTransformer call
83
+ * ```javascript
84
+ * //
85
+ * const input = {
86
+ * "transformerId": "tr-974c129999f84d8c9"
87
+ * };
88
+ * const command = new GetTransformerCommand(input);
89
+ * const response = await client.send(command);
90
+ * /* response ==
91
+ * {
92
+ * "name": "transformJSON",
93
+ * "createdAt": "2023-11-01T21:51:05.504Z",
94
+ * "ediType": {
95
+ * "x12Details": {
96
+ * "version": "VERSION_4010",
97
+ * "transactionSet": "X12_110"
98
+ * }
99
+ * },
100
+ * "fileFormat": "JSON",
101
+ * "mappingTemplate": "$",
102
+ * "modifiedAt": "2023-11-01T21:51:05.504Z",
103
+ * "sampleDocument": "s3://test-bucket/sampleDoc.txt",
104
+ * "status": "inactive",
105
+ * "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9",
106
+ * "transformerId": "tr-974c129999f84d8c9"
107
+ * }
108
+ * *\/
109
+ * // example id: example-1
110
+ * ```
111
+ *
82
112
  */
83
113
  export declare class GetTransformerCommand extends $Command<GetTransformerCommandInput, GetTransformerCommandOutput, B2biClientResolvedConfig> {
84
114
  readonly input: GetTransformerCommandInput;
@@ -73,6 +73,30 @@ export interface GetTransformerJobCommandOutput extends GetTransformerJobRespons
73
73
  * @throws {@link B2biServiceException}
74
74
  * <p>Base exception class for all service exceptions from B2bi service.</p>
75
75
  *
76
+ * @example Sample GetTransformerJob call
77
+ * ```javascript
78
+ * //
79
+ * const input = {
80
+ * "transformerId": "tr-974c129999f84d8c9",
81
+ * "transformerJobId": "tj-vpYxfV7yQOqjMSYllEslLw"
82
+ * };
83
+ * const command = new GetTransformerJobCommand(input);
84
+ * const response = await client.send(command);
85
+ * /* response ==
86
+ * {
87
+ * "message": "Transformed, writing output",
88
+ * "outputFiles": [
89
+ * {
90
+ * "key": "output/sample-214.edi.2023-11-01T10:44:03.353Z.json",
91
+ * "bucketName": "gt-edi-test"
92
+ * }
93
+ * ],
94
+ * "status": "succeeded"
95
+ * }
96
+ * *\/
97
+ * // example id: example-1
98
+ * ```
99
+ *
76
100
  */
77
101
  export declare class GetTransformerJobCommand extends $Command<GetTransformerJobCommandInput, GetTransformerJobCommandOutput, B2biClientResolvedConfig> {
78
102
  readonly input: GetTransformerJobCommandInput;
@@ -60,6 +60,32 @@ export interface ListCapabilitiesCommandOutput extends ListCapabilitiesResponse,
60
60
  * @throws {@link B2biServiceException}
61
61
  * <p>Base exception class for all service exceptions from B2bi service.</p>
62
62
  *
63
+ * @example Sample ListCapabilities call
64
+ * ```javascript
65
+ * //
66
+ * const input = {
67
+ * "maxResults": 50,
68
+ * "nextToken": "foo"
69
+ * };
70
+ * const command = new ListCapabilitiesCommand(input);
71
+ * const response = await client.send(command);
72
+ * /* response ==
73
+ * {
74
+ * "capabilities": [
75
+ * {
76
+ * "name": "b2biexample",
77
+ * "type": "edi",
78
+ * "capabilityId": "ca-963a8121e4fc4e348",
79
+ * "createdAt": "2023-11-01T21:51:05.504Z",
80
+ * "modifiedAt": "2023-11-01T21:51:05.504Z"
81
+ * }
82
+ * ],
83
+ * "nextToken": "foo"
84
+ * }
85
+ * *\/
86
+ * // example id: example-1
87
+ * ```
88
+ *
63
89
  */
64
90
  export declare class ListCapabilitiesCommand extends $Command<ListCapabilitiesCommandInput, ListCapabilitiesCommandOutput, B2biClientResolvedConfig> {
65
91
  readonly input: ListCapabilitiesCommandInput;
@@ -80,6 +80,37 @@ export interface ListPartnershipsCommandOutput extends ListPartnershipsResponse,
80
80
  * @throws {@link B2biServiceException}
81
81
  * <p>Base exception class for all service exceptions from B2bi service.</p>
82
82
  *
83
+ * @example Sample ListPartnerships call
84
+ * ```javascript
85
+ * //
86
+ * const input = {
87
+ * "maxResults": 50,
88
+ * "nextToken": "foo",
89
+ * "profileId": "p-60fbc37c87f04fce9"
90
+ * };
91
+ * const command = new ListPartnershipsCommand(input);
92
+ * const response = await client.send(command);
93
+ * /* response ==
94
+ * {
95
+ * "nextToken": "string",
96
+ * "partnerships": [
97
+ * {
98
+ * "name": "b2bipartner",
99
+ * "capabilities": [
100
+ * "ca-963a8121e4fc4e348"
101
+ * ],
102
+ * "createdAt": "2023-11-01T21:51:05.504Z",
103
+ * "modifiedAt": "2023-11-01T21:51:05.504Z",
104
+ * "partnershipId": "ps-219fa02f5b4242af8",
105
+ * "profileId": "p-60fbc37c87f04fce9",
106
+ * "tradingPartnerId": "tp-2a17ca447f6f4a8a8"
107
+ * }
108
+ * ]
109
+ * }
110
+ * *\/
111
+ * // example id: example-1
112
+ * ```
113
+ *
83
114
  */
84
115
  export declare class ListPartnershipsCommand extends $Command<ListPartnershipsCommandInput, ListPartnershipsCommandOutput, B2biClientResolvedConfig> {
85
116
  readonly input: ListPartnershipsCommandInput;
@@ -62,6 +62,33 @@ export interface ListProfilesCommandOutput extends ListProfilesResponse, __Metad
62
62
  * @throws {@link B2biServiceException}
63
63
  * <p>Base exception class for all service exceptions from B2bi service.</p>
64
64
  *
65
+ * @example Sample ListProfiles call
66
+ * ```javascript
67
+ * //
68
+ * const input = {
69
+ * "maxResults": 50,
70
+ * "nextToken": "foo"
71
+ * };
72
+ * const command = new ListProfilesCommand(input);
73
+ * const response = await client.send(command);
74
+ * /* response ==
75
+ * {
76
+ * "nextToken": "foo",
77
+ * "profiles": [
78
+ * {
79
+ * "name": "Shipping Profile",
80
+ * "businessName": "John's Trucking",
81
+ * "createdAt": "2023-11-01T21:51:05.504Z",
82
+ * "logGroupName": "b2bi/p-60fbc37c87f04fce9-Logs",
83
+ * "logging": "ENABLED",
84
+ * "profileId": "p-60fbc37c87f04fce9"
85
+ * }
86
+ * ]
87
+ * }
88
+ * *\/
89
+ * // example id: example-1
90
+ * ```
91
+ *
65
92
  */
66
93
  export declare class ListProfilesCommand extends $Command<ListProfilesCommandInput, ListProfilesCommandOutput, B2biClientResolvedConfig> {
67
94
  readonly input: ListProfilesCommandInput;
@@ -61,6 +61,27 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
61
61
  * @throws {@link B2biServiceException}
62
62
  * <p>Base exception class for all service exceptions from B2bi service.</p>
63
63
  *
64
+ * @example Sample ListTagsForResources call
65
+ * ```javascript
66
+ * //
67
+ * const input = {
68
+ * "ResourceARN": "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9"
69
+ * };
70
+ * const command = new ListTagsForResourceCommand(input);
71
+ * const response = await client.send(command);
72
+ * /* response ==
73
+ * {
74
+ * "Tags": [
75
+ * {
76
+ * "Key": "sampleKey",
77
+ * "Value": "SampleValue"
78
+ * }
79
+ * ]
80
+ * }
81
+ * *\/
82
+ * // example id: example-1
83
+ * ```
84
+ *
64
85
  */
65
86
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, B2biClientResolvedConfig> {
66
87
  readonly input: ListTagsForResourceCommandInput;
@@ -69,6 +69,41 @@ export interface ListTransformersCommandOutput extends ListTransformersResponse,
69
69
  * @throws {@link B2biServiceException}
70
70
  * <p>Base exception class for all service exceptions from B2bi service.</p>
71
71
  *
72
+ * @example Sample ListTransformers call
73
+ * ```javascript
74
+ * //
75
+ * const input = {
76
+ * "maxResults": 50,
77
+ * "nextToken": "foo"
78
+ * };
79
+ * const command = new ListTransformersCommand(input);
80
+ * const response = await client.send(command);
81
+ * /* response ==
82
+ * {
83
+ * "nextToken": "foo",
84
+ * "transformers": [
85
+ * {
86
+ * "name": "transformJSON",
87
+ * "createdAt": "2023-11-01T21:51:05.504Z",
88
+ * "ediType": {
89
+ * "x12Details": {
90
+ * "version": "VERSION_4010",
91
+ * "transactionSet": "X12_110"
92
+ * }
93
+ * },
94
+ * "fileFormat": "JSON",
95
+ * "mappingTemplate": "$",
96
+ * "modifiedAt": "2023-11-01T21:51:05.504Z",
97
+ * "sampleDocument": "s3://test-bucket/sampleDoc.txt",
98
+ * "status": "inactive",
99
+ * "transformerId": "tr-974c129999f84d8c9"
100
+ * }
101
+ * ]
102
+ * }
103
+ * *\/
104
+ * // example id: example-1
105
+ * ```
106
+ *
72
107
  */
73
108
  export declare class ListTransformersCommand extends $Command<ListTransformersCommandInput, ListTransformersCommandOutput, B2biClientResolvedConfig> {
74
109
  readonly input: ListTransformersCommandInput;
@@ -74,6 +74,31 @@ export interface StartTransformerJobCommandOutput extends StartTransformerJobRes
74
74
  * @throws {@link B2biServiceException}
75
75
  * <p>Base exception class for all service exceptions from B2bi service.</p>
76
76
  *
77
+ * @example Sample StartTransformerJob call
78
+ * ```javascript
79
+ * //
80
+ * const input = {
81
+ * "clientToken": "foo",
82
+ * "inputFile": {
83
+ * "key": "input/inputFile.txt",
84
+ * "bucketName": "test-bucket"
85
+ * },
86
+ * "outputLocation": {
87
+ * "key": "output/",
88
+ * "bucketName": "test-bucket"
89
+ * },
90
+ * "transformerId": "tr-974c129999f84d8c9"
91
+ * };
92
+ * const command = new StartTransformerJobCommand(input);
93
+ * const response = await client.send(command);
94
+ * /* response ==
95
+ * {
96
+ * "transformerJobId": "tj-vpYxfV7yQOqjMSYllEslLw"
97
+ * }
98
+ * *\/
99
+ * // example id: example-1
100
+ * ```
101
+ *
77
102
  */
78
103
  export declare class StartTransformerJobCommand extends $Command<StartTransformerJobCommandInput, StartTransformerJobCommandOutput, B2biClientResolvedConfig> {
79
104
  readonly input: StartTransformerJobCommandInput;
@@ -64,6 +64,23 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
64
64
  * @throws {@link B2biServiceException}
65
65
  * <p>Base exception class for all service exceptions from B2bi service.</p>
66
66
  *
67
+ * @example Sample TagResource call
68
+ * ```javascript
69
+ * //
70
+ * const input = {
71
+ * "ResourceARN": "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9",
72
+ * "Tags": [
73
+ * {
74
+ * "Key": "sampleKey",
75
+ * "Value": "SampleValue"
76
+ * }
77
+ * ]
78
+ * };
79
+ * const command = new TagResourceCommand(input);
80
+ * await client.send(command);
81
+ * // example id: example-1
82
+ * ```
83
+ *
67
84
  */
68
85
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, B2biClientResolvedConfig> {
69
86
  readonly input: TagResourceCommandInput;
@@ -67,6 +67,24 @@ export interface TestMappingCommandOutput extends TestMappingResponse, __Metadat
67
67
  * @throws {@link B2biServiceException}
68
68
  * <p>Base exception class for all service exceptions from B2bi service.</p>
69
69
  *
70
+ * @example Sample TestMapping call
71
+ * ```javascript
72
+ * //
73
+ * const input = {
74
+ * "fileFormat": "JSON",
75
+ * "inputFileContent": "Sample file content",
76
+ * "mappingTemplate": "$"
77
+ * };
78
+ * const command = new TestMappingCommand(input);
79
+ * const response = await client.send(command);
80
+ * /* response ==
81
+ * {
82
+ * "mappedFileContent": "Sample file content"
83
+ * }
84
+ * *\/
85
+ * // example id: example-1
86
+ * ```
87
+ *
70
88
  */
71
89
  export declare class TestMappingCommand extends $Command<TestMappingCommandInput, TestMappingCommandOutput, B2biClientResolvedConfig> {
72
90
  readonly input: TestMappingCommandInput;
@@ -75,6 +75,32 @@ export interface TestParsingCommandOutput extends TestParsingResponse, __Metadat
75
75
  * @throws {@link B2biServiceException}
76
76
  * <p>Base exception class for all service exceptions from B2bi service.</p>
77
77
  *
78
+ * @example Sample TestParsing call
79
+ * ```javascript
80
+ * //
81
+ * const input = {
82
+ * "ediType": {
83
+ * "x12Details": {
84
+ * "version": "VERSION_4010",
85
+ * "transactionSet": "X12_110"
86
+ * }
87
+ * },
88
+ * "fileFormat": "JSON",
89
+ * "inputFile": {
90
+ * "key": "sampleFile.txt",
91
+ * "bucketName": "test-bucket"
92
+ * }
93
+ * };
94
+ * const command = new TestParsingCommand(input);
95
+ * const response = await client.send(command);
96
+ * /* response ==
97
+ * {
98
+ * "parsedFileContent": "Sample parsed file content"
99
+ * }
100
+ * *\/
101
+ * // example id: example-1
102
+ * ```
103
+ *
78
104
  */
79
105
  export declare class TestParsingCommand extends $Command<TestParsingCommandInput, TestParsingCommandOutput, B2biClientResolvedConfig> {
80
106
  readonly input: TestParsingCommandInput;
@@ -57,6 +57,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
57
57
  * @throws {@link B2biServiceException}
58
58
  * <p>Base exception class for all service exceptions from B2bi service.</p>
59
59
  *
60
+ * @example Sample UntagResource call
61
+ * ```javascript
62
+ * //
63
+ * const input = {
64
+ * "ResourceARN": "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9",
65
+ * "TagKeys": [
66
+ * "sampleKey"
67
+ * ]
68
+ * };
69
+ * const command = new UntagResourceCommand(input);
70
+ * await client.send(command);
71
+ * // example id: example-1
72
+ * ```
73
+ *
60
74
  */
61
75
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, B2biClientResolvedConfig> {
62
76
  readonly input: UntagResourceCommandInput;
@@ -128,6 +128,78 @@ export interface UpdateCapabilityCommandOutput extends UpdateCapabilityResponse,
128
128
  * @throws {@link B2biServiceException}
129
129
  * <p>Base exception class for all service exceptions from B2bi service.</p>
130
130
  *
131
+ * @example Sample UpdateCapability call
132
+ * ```javascript
133
+ * //
134
+ * const input = {
135
+ * "name": "b2biexample",
136
+ * "capabilityId": "ca-963a8121e4fc4e348",
137
+ * "configuration": {
138
+ * "edi": {
139
+ * "type": {
140
+ * "x12Details": {
141
+ * "version": "VERSION_4010",
142
+ * "transactionSet": "X12_110"
143
+ * }
144
+ * },
145
+ * "inputLocation": {
146
+ * "key": "input/",
147
+ * "bucketName": "test-bucket"
148
+ * },
149
+ * "outputLocation": {
150
+ * "key": "output/",
151
+ * "bucketName": "test-bucket"
152
+ * },
153
+ * "transformerId": "tr-9a893cf536df4658b"
154
+ * }
155
+ * },
156
+ * "instructionsDocuments": [
157
+ * {
158
+ * "key": "instructiondoc.txt",
159
+ * "bucketName": "test-bucket"
160
+ * }
161
+ * ]
162
+ * };
163
+ * const command = new UpdateCapabilityCommand(input);
164
+ * const response = await client.send(command);
165
+ * /* response ==
166
+ * {
167
+ * "name": "b2biexample",
168
+ * "type": "edi",
169
+ * "capabilityArn": "arn:aws:b2bi:us-west-2:123456789012:capability/ca-963a8121e4fc4e348",
170
+ * "capabilityId": "ca-963a8121e4fc4e348",
171
+ * "configuration": {
172
+ * "edi": {
173
+ * "type": {
174
+ * "x12Details": {
175
+ * "version": "VERSION_4010",
176
+ * "transactionSet": "X12_110"
177
+ * }
178
+ * },
179
+ * "inputLocation": {
180
+ * "key": "input/",
181
+ * "bucketName": "test-bucket"
182
+ * },
183
+ * "outputLocation": {
184
+ * "key": "output/",
185
+ * "bucketName": "test-bucket"
186
+ * },
187
+ * "transformerId": "tr-9a893cf536df4658b"
188
+ * }
189
+ * },
190
+ * "createdAt": "2023-11-01T21:51:05.504Z",
191
+ * "instructionsDocuments": [
192
+ * {
193
+ * "key": "instructiondoc.txt",
194
+ * "bucketName": "test-bucket"
195
+ * }
196
+ * ],
197
+ * "modifiedAt": "2023-11-01T21:51:05.504Z"
198
+ * }
199
+ * *\/
200
+ * // example id: example-1
201
+ * ```
202
+ *
131
203
  */
132
204
  export declare class UpdateCapabilityCommand extends $Command<UpdateCapabilityCommandInput, UpdateCapabilityCommandOutput, B2biClientResolvedConfig> {
133
205
  readonly input: UpdateCapabilityCommandInput;
@@ -86,6 +86,37 @@ export interface UpdatePartnershipCommandOutput extends UpdatePartnershipRespons
86
86
  * @throws {@link B2biServiceException}
87
87
  * <p>Base exception class for all service exceptions from B2bi service.</p>
88
88
  *
89
+ * @example Sample UpdatePartnership call
90
+ * ```javascript
91
+ * //
92
+ * const input = {
93
+ * "name": "b2bipartner",
94
+ * "capabilities": [
95
+ * "ca-963a8121e4fc4e348"
96
+ * ],
97
+ * "partnershipId": "ps-219fa02f5b4242af8"
98
+ * };
99
+ * const command = new UpdatePartnershipCommand(input);
100
+ * const response = await client.send(command);
101
+ * /* response ==
102
+ * {
103
+ * "name": "b2bipartner",
104
+ * "capabilities": [
105
+ * "ca-963a8121e4fc4e348"
106
+ * ],
107
+ * "createdAt": "2023-11-01T21:51:05.504Z",
108
+ * "email": "john@example.com",
109
+ * "modifiedAt": "2023-11-01T21:51:05.504Z",
110
+ * "partnershipArn": "arn:aws:b2bi:us-west-2:123456789012:partnership/ps-60fbc37c87f04fce9",
111
+ * "partnershipId": "ps-219fa02f5b4242af8",
112
+ * "phone": "5555555555",
113
+ * "profileId": "p-60fbc37c87f04fce9",
114
+ * "tradingPartnerId": "tp-2a17ca447f6f4a8a8"
115
+ * }
116
+ * *\/
117
+ * // example id: example-1
118
+ * ```
119
+ *
89
120
  */
90
121
  export declare class UpdatePartnershipCommand extends $Command<UpdatePartnershipCommandInput, UpdatePartnershipCommandOutput, B2biClientResolvedConfig> {
91
122
  readonly input: UpdatePartnershipCommandInput;
@@ -84,6 +84,35 @@ export interface UpdateProfileCommandOutput extends UpdateProfileResponse, __Met
84
84
  * @throws {@link B2biServiceException}
85
85
  * <p>Base exception class for all service exceptions from B2bi service.</p>
86
86
  *
87
+ * @example Sample UpdateProfile call
88
+ * ```javascript
89
+ * //
90
+ * const input = {
91
+ * "name": "Shipping Profile",
92
+ * "businessName": "John's Shipping",
93
+ * "email": "john@example.com",
94
+ * "phone": "5555555555",
95
+ * "profileId": "p-60fbc37c87f04fce9"
96
+ * };
97
+ * const command = new UpdateProfileCommand(input);
98
+ * const response = await client.send(command);
99
+ * /* response ==
100
+ * {
101
+ * "name": "Shipping Profile",
102
+ * "businessName": "John's Trucking",
103
+ * "createdAt": "2023-11-01T21:51:05.504Z",
104
+ * "email": "john@example.com",
105
+ * "logGroupName": "b2bi/p-60fbc37c87f04fce9-Logs",
106
+ * "logging": "ENABLED",
107
+ * "modifiedAt": "2023-11-02T21:51:05.504Z",
108
+ * "phone": "5555555555",
109
+ * "profileArn": "arn:aws:b2bi:us-west-2:123456789012:profile/p-60fbc37c87f04fce9",
110
+ * "profileId": "p-60fbc37c87f04fce9"
111
+ * }
112
+ * *\/
113
+ * // example id: example-1
114
+ * ```
115
+ *
87
116
  */
88
117
  export declare class UpdateProfileCommand extends $Command<UpdateProfileCommandInput, UpdateProfileCommandOutput, B2biClientResolvedConfig> {
89
118
  readonly input: UpdateProfileCommandInput;
@@ -96,6 +96,47 @@ export interface UpdateTransformerCommandOutput extends UpdateTransformerRespons
96
96
  * @throws {@link B2biServiceException}
97
97
  * <p>Base exception class for all service exceptions from B2bi service.</p>
98
98
  *
99
+ * @example Sample UpdateTransformer call
100
+ * ```javascript
101
+ * //
102
+ * const input = {
103
+ * "name": "transformJSON",
104
+ * "ediType": {
105
+ * "x12Details": {
106
+ * "version": "VERSION_4010",
107
+ * "transactionSet": "X12_110"
108
+ * }
109
+ * },
110
+ * "fileFormat": "JSON",
111
+ * "mappingTemplate": "{}",
112
+ * "sampleDocument": "s3://test-bucket/sampleDoc.txt",
113
+ * "status": "inactive",
114
+ * "transformerId": "tr-974c129999f84d8c9"
115
+ * };
116
+ * const command = new UpdateTransformerCommand(input);
117
+ * const response = await client.send(command);
118
+ * /* response ==
119
+ * {
120
+ * "name": "transformJSON",
121
+ * "createdAt": "2023-11-01T21:51:05.504Z",
122
+ * "ediType": {
123
+ * "x12Details": {
124
+ * "version": "VERSION_4010",
125
+ * "transactionSet": "X12_110"
126
+ * }
127
+ * },
128
+ * "fileFormat": "JSON",
129
+ * "mappingTemplate": "$",
130
+ * "modifiedAt": "2023-11-01T21:51:05.504Z",
131
+ * "sampleDocument": "s3://test-bucket/sampleDoc.txt",
132
+ * "status": "inactive",
133
+ * "transformerArn": "arn:aws:b2bi:us-west-2:607686414464:transformer/tr-974c129999f84d8c9",
134
+ * "transformerId": "tr-974c129999f84d8c9"
135
+ * }
136
+ * *\/
137
+ * // example id: example-1
138
+ * ```
139
+ *
99
140
  */
100
141
  export declare class UpdateTransformerCommand extends $Command<UpdateTransformerCommandInput, UpdateTransformerCommandOutput, B2biClientResolvedConfig> {
101
142
  readonly input: UpdateTransformerCommandInput;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-b2bi",
3
3
  "description": "AWS SDK for JavaScript B2bi Client for Node.js, Browser and React Native",
4
- "version": "3.459.0",
4
+ "version": "3.460.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,19 +21,19 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.458.0",
24
+ "@aws-sdk/client-sts": "3.460.0",
25
25
  "@aws-sdk/core": "3.451.0",
26
- "@aws-sdk/credential-provider-node": "3.458.0",
27
- "@aws-sdk/middleware-host-header": "3.451.0",
28
- "@aws-sdk/middleware-logger": "3.451.0",
29
- "@aws-sdk/middleware-recursion-detection": "3.451.0",
30
- "@aws-sdk/middleware-signing": "3.451.0",
31
- "@aws-sdk/middleware-user-agent": "3.451.0",
26
+ "@aws-sdk/credential-provider-node": "3.460.0",
27
+ "@aws-sdk/middleware-host-header": "3.460.0",
28
+ "@aws-sdk/middleware-logger": "3.460.0",
29
+ "@aws-sdk/middleware-recursion-detection": "3.460.0",
30
+ "@aws-sdk/middleware-signing": "3.460.0",
31
+ "@aws-sdk/middleware-user-agent": "3.460.0",
32
32
  "@aws-sdk/region-config-resolver": "3.451.0",
33
- "@aws-sdk/types": "3.451.0",
34
- "@aws-sdk/util-endpoints": "3.451.0",
35
- "@aws-sdk/util-user-agent-browser": "3.451.0",
36
- "@aws-sdk/util-user-agent-node": "3.451.0",
33
+ "@aws-sdk/types": "3.460.0",
34
+ "@aws-sdk/util-endpoints": "3.460.0",
35
+ "@aws-sdk/util-user-agent-browser": "3.460.0",
36
+ "@aws-sdk/util-user-agent-node": "3.460.0",
37
37
  "@smithy/config-resolver": "^2.0.18",
38
38
  "@smithy/fetch-http-handler": "^2.2.6",
39
39
  "@smithy/hash-node": "^2.0.15",