@aws-sdk/client-marketplace-reporting 3.1008.0 → 3.1009.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 (2) hide show
  1. package/README.md +26 -46
  2. package/package.json +33 -33
package/README.md CHANGED
@@ -64,8 +64,9 @@ Organizations</a> in the <i>Amazon Web Services Marketplace Buyer Guide</i>.</p>
64
64
  </ul>
65
65
 
66
66
  ## Installing
67
- To install this package, simply type add or install @aws-sdk/client-marketplace-reporting
68
- using your favorite package manager:
67
+
68
+ To install this package, use the CLI of your favorite package manager:
69
+
69
70
  - `npm install @aws-sdk/client-marketplace-reporting`
70
71
  - `yarn add @aws-sdk/client-marketplace-reporting`
71
72
  - `pnpm add @aws-sdk/client-marketplace-reporting`
@@ -90,15 +91,15 @@ import { MarketplaceReportingClient, GetBuyerDashboardCommand } from "@aws-sdk/c
90
91
 
91
92
  ### Usage
92
93
 
93
- To send a request, you:
94
+ To send a request:
94
95
 
95
- - Initiate client with configuration (e.g. credentials, region).
96
- - Initiate command with input parameters.
97
- - Call `send` operation on client with command object as input.
98
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
96
+ - Instantiate a client with configuration (e.g. credentials, region).
97
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
98
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
99
+ - Instantiate a command with input parameters.
100
+ - Call the `send` operation on the client, providing the command object as input.
99
101
 
100
102
  ```js
101
- // a client can be shared by different commands.
102
103
  const client = new MarketplaceReportingClient({ region: "REGION" });
103
104
 
104
105
  const params = { /** input parameters */ };
@@ -107,7 +108,7 @@ const command = new GetBuyerDashboardCommand(params);
107
108
 
108
109
  #### Async/await
109
110
 
110
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
111
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
111
112
  operator to wait for the promise returned by send operation as follows:
112
113
 
113
114
  ```js
@@ -122,26 +123,9 @@ try {
122
123
  }
123
124
  ```
124
125
 
125
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
126
- as compared to using Promise chains or callbacks.
127
-
128
126
  #### Promises
129
127
 
130
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
131
- to execute send operation.
132
-
133
- ```js
134
- client.send(command).then(
135
- (data) => {
136
- // process data.
137
- },
138
- (error) => {
139
- // error handling.
140
- }
141
- );
142
- ```
143
-
144
- Promises can also be called using `.catch()` and `.finally()` as follows:
128
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
145
129
 
146
130
  ```js
147
131
  client
@@ -157,27 +141,21 @@ client
157
141
  });
158
142
  ```
159
143
 
160
- #### Callbacks
161
-
162
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
163
- but they are supported by the send operation.
144
+ #### Aggregated client
164
145
 
165
- ```js
166
- // callbacks.
167
- client.send(command, (err, data) => {
168
- // process err and data.
169
- });
170
- ```
146
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
171
147
 
172
- #### v2 compatible style
148
+ `MarketplaceReporting` extends `MarketplaceReportingClient` and additionally supports all operations, waiters, and paginators as methods.
149
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
173
150
 
174
- The client can also send requests using v2 compatible style.
175
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
176
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
151
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`MarketplaceReportingClient`).
152
+ More details are in the blog post on
153
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
177
154
 
178
155
  ```ts
179
- import * as AWS from "@aws-sdk/client-marketplace-reporting";
180
- const client = new AWS.MarketplaceReporting({ region: "REGION" });
156
+ import { MarketplaceReporting } from "@aws-sdk/client-marketplace-reporting";
157
+
158
+ const client = new MarketplaceReporting({ region: "REGION" });
181
159
 
182
160
  // async/await.
183
161
  try {
@@ -197,7 +175,7 @@ client
197
175
  // error handling.
198
176
  });
199
177
 
200
- // callbacks.
178
+ // callbacks (not recommended).
201
179
  client.getBuyerDashboard(params, (err, data) => {
202
180
  // process err and data.
203
181
  });
@@ -225,12 +203,14 @@ try {
225
203
  }
226
204
  ```
227
205
 
206
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
207
+
228
208
  ## Getting Help
229
209
 
230
210
  Please use these community resources for getting help.
231
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
211
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
232
212
 
233
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
213
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
234
214
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
235
215
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
236
216
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-marketplace-reporting",
3
3
  "description": "AWS SDK for JavaScript Marketplace Reporting Client for Node.js, Browser and React Native",
4
- "version": "3.1008.0",
4
+ "version": "3.1009.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-marketplace-reporting",
@@ -21,41 +21,41 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "5.2.0",
23
23
  "@aws-crypto/sha256-js": "5.2.0",
24
- "@aws-sdk/core": "^3.973.19",
25
- "@aws-sdk/credential-provider-node": "^3.972.20",
26
- "@aws-sdk/middleware-host-header": "^3.972.7",
27
- "@aws-sdk/middleware-logger": "^3.972.7",
28
- "@aws-sdk/middleware-recursion-detection": "^3.972.7",
29
- "@aws-sdk/middleware-user-agent": "^3.972.20",
30
- "@aws-sdk/region-config-resolver": "^3.972.7",
31
- "@aws-sdk/types": "^3.973.5",
32
- "@aws-sdk/util-endpoints": "^3.996.4",
33
- "@aws-sdk/util-user-agent-browser": "^3.972.7",
34
- "@aws-sdk/util-user-agent-node": "^3.973.6",
35
- "@smithy/config-resolver": "^4.4.10",
36
- "@smithy/core": "^3.23.9",
37
- "@smithy/fetch-http-handler": "^5.3.13",
38
- "@smithy/hash-node": "^4.2.11",
39
- "@smithy/invalid-dependency": "^4.2.11",
40
- "@smithy/middleware-content-length": "^4.2.11",
41
- "@smithy/middleware-endpoint": "^4.4.23",
42
- "@smithy/middleware-retry": "^4.4.40",
43
- "@smithy/middleware-serde": "^4.2.12",
44
- "@smithy/middleware-stack": "^4.2.11",
45
- "@smithy/node-config-provider": "^4.3.11",
46
- "@smithy/node-http-handler": "^4.4.14",
47
- "@smithy/protocol-http": "^5.3.11",
48
- "@smithy/smithy-client": "^4.12.3",
49
- "@smithy/types": "^4.13.0",
50
- "@smithy/url-parser": "^4.2.11",
24
+ "@aws-sdk/core": "^3.973.20",
25
+ "@aws-sdk/credential-provider-node": "^3.972.21",
26
+ "@aws-sdk/middleware-host-header": "^3.972.8",
27
+ "@aws-sdk/middleware-logger": "^3.972.8",
28
+ "@aws-sdk/middleware-recursion-detection": "^3.972.8",
29
+ "@aws-sdk/middleware-user-agent": "^3.972.21",
30
+ "@aws-sdk/region-config-resolver": "^3.972.8",
31
+ "@aws-sdk/types": "^3.973.6",
32
+ "@aws-sdk/util-endpoints": "^3.996.5",
33
+ "@aws-sdk/util-user-agent-browser": "^3.972.8",
34
+ "@aws-sdk/util-user-agent-node": "^3.973.7",
35
+ "@smithy/config-resolver": "^4.4.11",
36
+ "@smithy/core": "^3.23.11",
37
+ "@smithy/fetch-http-handler": "^5.3.15",
38
+ "@smithy/hash-node": "^4.2.12",
39
+ "@smithy/invalid-dependency": "^4.2.12",
40
+ "@smithy/middleware-content-length": "^4.2.12",
41
+ "@smithy/middleware-endpoint": "^4.4.25",
42
+ "@smithy/middleware-retry": "^4.4.42",
43
+ "@smithy/middleware-serde": "^4.2.14",
44
+ "@smithy/middleware-stack": "^4.2.12",
45
+ "@smithy/node-config-provider": "^4.3.12",
46
+ "@smithy/node-http-handler": "^4.4.16",
47
+ "@smithy/protocol-http": "^5.3.12",
48
+ "@smithy/smithy-client": "^4.12.5",
49
+ "@smithy/types": "^4.13.1",
50
+ "@smithy/url-parser": "^4.2.12",
51
51
  "@smithy/util-base64": "^4.3.2",
52
52
  "@smithy/util-body-length-browser": "^4.2.2",
53
53
  "@smithy/util-body-length-node": "^4.2.3",
54
- "@smithy/util-defaults-mode-browser": "^4.3.39",
55
- "@smithy/util-defaults-mode-node": "^4.2.42",
56
- "@smithy/util-endpoints": "^3.3.2",
57
- "@smithy/util-middleware": "^4.2.11",
58
- "@smithy/util-retry": "^4.2.11",
54
+ "@smithy/util-defaults-mode-browser": "^4.3.41",
55
+ "@smithy/util-defaults-mode-node": "^4.2.44",
56
+ "@smithy/util-endpoints": "^3.3.3",
57
+ "@smithy/util-middleware": "^4.2.12",
58
+ "@smithy/util-retry": "^4.2.12",
59
59
  "@smithy/util-utf8": "^4.2.2",
60
60
  "tslib": "^2.6.2"
61
61
  },