@aws-sdk/client-pinpoint-sms-voice-v2 3.1008.0 → 3.1009.0

package/README.md

@@ -9,8 +9,9 @@ AWS SDK for JavaScript PinpointSMSVoiceV2 Client for Node.js, Browser and React
 <p>Welcome to the <i>End User Messaging SMS, version 2 API Reference</i>. This guide provides information about End User Messaging SMS, version 2 API resources, including supported HTTP methods, parameters, and schemas.</p> <p>Amazon Pinpoint is an Amazon Web Services service that you can use to engage with your recipients across multiple messaging channels. The End User Messaging SMS, version 2 API provides programmatic access to options that are unique to the SMS and voice channels. End User Messaging SMS, version 2 resources such as phone numbers, sender IDs, and opt-out lists can be used by the Amazon Pinpoint API.</p> <p>If you're new to End User Messaging SMS, it's also helpful to review the <a href="https://docs.aws.amazon.com/sms-voice/latest/userguide/what-is-service.html"> End User Messaging SMS User Guide</a>, where you'll find tutorials, code samples, and procedures that demonstrate how to use End User Messaging SMS features programmatically and how to integrate functionality into mobile apps and other types of applications. The guide also provides key information, such as End User Messaging SMS integration with other Amazon Web Services services, and the quotas that apply to use of the service.</p> <p> <b>Regional availability</b> </p> <p>The <i>End User Messaging SMS version 2 API Reference</i> is available in several Amazon Web Services Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see <a href="https://docs.aws.amazon.com/hgeneral/latest/gr/rande.html#pinpoint_region">Amazon Web Services Service Endpoints</a> and <a href="https://docs.aws.amazon.com/general/latest/gr/pinpoint.html">Amazon Pinpoint endpoints and quotas</a> in the Amazon Web Services General Reference. To learn more about Amazon Web Services Regions, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html">Managing Amazon Web Services Regions</a> in the Amazon Web Services General Reference.</p> <p>In each Region, Amazon Web Services maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see <a href="http://aws.amazon.com/about-aws/global-infrastructure/">Amazon Web Services Global Infrastructure.</a> </p>
 
 ## Installing
-To install this package, simply type add or install @aws-sdk/client-pinpoint-sms-voice-v2
-using your favorite package manager:
+
+To install this package, use the CLI of your favorite package manager:
+
 - `npm install @aws-sdk/client-pinpoint-sms-voice-v2`
 - `yarn add @aws-sdk/client-pinpoint-sms-voice-v2`
 - `pnpm add @aws-sdk/client-pinpoint-sms-voice-v2`
@@ -35,15 +36,15 @@ import { PinpointSMSVoiceV2Client, ListTagsForResourceCommand } from "@aws-sdk/c
 
 ### Usage
 
-To send a request, you:
+To send a request:
 
-- Initiate client with configuration (e.g. credentials, region).
-- Initiate command with input parameters.
-- Call `send` operation on client with command object as input.
-- If you are using a custom http handler, you may call `destroy()` to close open connections.
+- Instantiate a client with configuration (e.g. credentials, region).
+  - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
+  - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
+- Instantiate a command with input parameters.
+- Call the `send` operation on the client, providing the command object as input.
 
 ```js
-// a client can be shared by different commands.
 const client = new PinpointSMSVoiceV2Client({ region: "REGION" });
 
 const params = { /** input parameters */ };
@@ -52,7 +53,7 @@ const command = new ListTagsForResourceCommand(params);
 
 #### Async/await
 
-We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
+We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
 operator to wait for the promise returned by send operation as follows:
 
 ```js
@@ -67,26 +68,9 @@ try {
 }
 ```
 
-Async-await is clean, concise, intuitive, easy to debug and has better error handling
-as compared to using Promise chains or callbacks.
-
 #### Promises
 
-You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
-to execute send operation.
-
-```js
-client.send(command).then(
-  (data) => {
-    // process data.
-  },
-  (error) => {
-    // error handling.
-  }
-);
-```
-
-Promises can also be called using `.catch()` and `.finally()` as follows:
+You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
 
 ```js
 client
@@ -102,27 +86,21 @@ client
   });
 ```
 
-#### Callbacks
-
-We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
-but they are supported by the send operation.
+#### Aggregated client
 
-```js
-// callbacks.
-client.send(command, (err, data) => {
-  // process err and data.
-});
-```
+The aggregated client class is exported from the same package, but without the "Client" suffix.
 
-#### v2 compatible style
+`PinpointSMSVoiceV2` extends `PinpointSMSVoiceV2Client` and additionally supports all operations, waiters, and paginators as methods.
+This style may be familiar to you from the AWS SDK for JavaScript v2.
 
-The client can also send requests using v2 compatible style.
-However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
-on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
+If you are bundling the AWS SDK, we recommend using only the bare-bones client (`PinpointSMSVoiceV2Client`).
+More details are in the blog post on
+[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
 
 ```ts
-import * as AWS from "@aws-sdk/client-pinpoint-sms-voice-v2";
-const client = new AWS.PinpointSMSVoiceV2({ region: "REGION" });
+import { PinpointSMSVoiceV2 } from "@aws-sdk/client-pinpoint-sms-voice-v2";
+
+const client = new PinpointSMSVoiceV2({ region: "REGION" });
 
 // async/await.
 try {
@@ -142,7 +120,7 @@ client
     // error handling.
   });
 
-// callbacks.
+// callbacks (not recommended).
 client.listTagsForResource(params, (err, data) => {
   // process err and data.
 });
@@ -170,12 +148,14 @@ try {
 }
 ```
 
+See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
+
 ## Getting Help
 
 Please use these community resources for getting help.
-We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
+We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
 
-- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
+- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
   or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
 - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
   on AWS Developer Blog.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-pinpoint-sms-voice-v2",
   "description": "AWS SDK for JavaScript Pinpoint Sms Voice V2 Client for Node.js, Browser and React Native",
-  "version": "3.1008.0",
+  "version": "3.1009.0",
   "scripts": {
     "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
     "build:cjs": "node ../../scripts/compilation/inline client-pinpoint-sms-voice-v2",
@@ -21,41 +21,41 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
-    "@aws-sdk/core": "^3.973.19",
-    "@aws-sdk/credential-provider-node": "^3.972.20",
-    "@aws-sdk/middleware-host-header": "^3.972.7",
-    "@aws-sdk/middleware-logger": "^3.972.7",
-    "@aws-sdk/middleware-recursion-detection": "^3.972.7",
-    "@aws-sdk/middleware-user-agent": "^3.972.20",
-    "@aws-sdk/region-config-resolver": "^3.972.7",
-    "@aws-sdk/types": "^3.973.5",
-    "@aws-sdk/util-endpoints": "^3.996.4",
-    "@aws-sdk/util-user-agent-browser": "^3.972.7",
-    "@aws-sdk/util-user-agent-node": "^3.973.6",
-    "@smithy/config-resolver": "^4.4.10",
-    "@smithy/core": "^3.23.9",
-    "@smithy/fetch-http-handler": "^5.3.13",
-    "@smithy/hash-node": "^4.2.11",
-    "@smithy/invalid-dependency": "^4.2.11",
-    "@smithy/middleware-content-length": "^4.2.11",
-    "@smithy/middleware-endpoint": "^4.4.23",
-    "@smithy/middleware-retry": "^4.4.40",
-    "@smithy/middleware-serde": "^4.2.12",
-    "@smithy/middleware-stack": "^4.2.11",
-    "@smithy/node-config-provider": "^4.3.11",
-    "@smithy/node-http-handler": "^4.4.14",
-    "@smithy/protocol-http": "^5.3.11",
-    "@smithy/smithy-client": "^4.12.3",
-    "@smithy/types": "^4.13.0",
-    "@smithy/url-parser": "^4.2.11",
+    "@aws-sdk/core": "^3.973.20",
+    "@aws-sdk/credential-provider-node": "^3.972.21",
+    "@aws-sdk/middleware-host-header": "^3.972.8",
+    "@aws-sdk/middleware-logger": "^3.972.8",
+    "@aws-sdk/middleware-recursion-detection": "^3.972.8",
+    "@aws-sdk/middleware-user-agent": "^3.972.21",
+    "@aws-sdk/region-config-resolver": "^3.972.8",
+    "@aws-sdk/types": "^3.973.6",
+    "@aws-sdk/util-endpoints": "^3.996.5",
+    "@aws-sdk/util-user-agent-browser": "^3.972.8",
+    "@aws-sdk/util-user-agent-node": "^3.973.7",
+    "@smithy/config-resolver": "^4.4.11",
+    "@smithy/core": "^3.23.11",
+    "@smithy/fetch-http-handler": "^5.3.15",
+    "@smithy/hash-node": "^4.2.12",
+    "@smithy/invalid-dependency": "^4.2.12",
+    "@smithy/middleware-content-length": "^4.2.12",
+    "@smithy/middleware-endpoint": "^4.4.25",
+    "@smithy/middleware-retry": "^4.4.42",
+    "@smithy/middleware-serde": "^4.2.14",
+    "@smithy/middleware-stack": "^4.2.12",
+    "@smithy/node-config-provider": "^4.3.12",
+    "@smithy/node-http-handler": "^4.4.16",
+    "@smithy/protocol-http": "^5.3.12",
+    "@smithy/smithy-client": "^4.12.5",
+    "@smithy/types": "^4.13.1",
+    "@smithy/url-parser": "^4.2.12",
     "@smithy/util-base64": "^4.3.2",
     "@smithy/util-body-length-browser": "^4.2.2",
     "@smithy/util-body-length-node": "^4.2.3",
-    "@smithy/util-defaults-mode-browser": "^4.3.39",
-    "@smithy/util-defaults-mode-node": "^4.2.42",
-    "@smithy/util-endpoints": "^3.3.2",
-    "@smithy/util-middleware": "^4.2.11",
-    "@smithy/util-retry": "^4.2.11",
+    "@smithy/util-defaults-mode-browser": "^4.3.41",
+    "@smithy/util-defaults-mode-node": "^4.2.44",
+    "@smithy/util-endpoints": "^3.3.3",
+    "@smithy/util-middleware": "^4.2.12",
+    "@smithy/util-retry": "^4.2.12",
     "@smithy/util-utf8": "^4.2.2",
     "tslib": "^2.6.2"
   },