@aws-sdk/client-customer-profiles 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
@@ -27,8 +27,9 @@ customer information from third party applications, such as Salesforce (CRM), Se
27
27
  Profiles</a> in the <i>Amazon Connect Administrator's Guide</i>. </p>
28
28
 
29
29
  ## Installing
30
- To install this package, simply type add or install @aws-sdk/client-customer-profiles
31
- using your favorite package manager:
30
+
31
+ To install this package, use the CLI of your favorite package manager:
32
+
32
33
  - `npm install @aws-sdk/client-customer-profiles`
33
34
  - `yarn add @aws-sdk/client-customer-profiles`
34
35
  - `pnpm add @aws-sdk/client-customer-profiles`
@@ -53,15 +54,15 @@ import { CustomerProfilesClient, ListDomainsCommand } from "@aws-sdk/client-cust
53
54
 
54
55
  ### Usage
55
56
 
56
- To send a request, you:
57
+ To send a request:
57
58
 
58
- - Initiate client with configuration (e.g. credentials, region).
59
- - Initiate command with input parameters.
60
- - Call `send` operation on client with command object as input.
61
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
59
+ - Instantiate a client with configuration (e.g. credentials, region).
60
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
61
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
62
+ - Instantiate a command with input parameters.
63
+ - Call the `send` operation on the client, providing the command object as input.
62
64
 
63
65
  ```js
64
- // a client can be shared by different commands.
65
66
  const client = new CustomerProfilesClient({ region: "REGION" });
66
67
 
67
68
  const params = { /** input parameters */ };
@@ -70,7 +71,7 @@ const command = new ListDomainsCommand(params);
70
71
 
71
72
  #### Async/await
72
73
 
73
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
74
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
74
75
  operator to wait for the promise returned by send operation as follows:
75
76
 
76
77
  ```js
@@ -85,26 +86,9 @@ try {
85
86
  }
86
87
  ```
87
88
 
88
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
89
- as compared to using Promise chains or callbacks.
90
-
91
89
  #### Promises
92
90
 
93
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
94
- to execute send operation.
95
-
96
- ```js
97
- client.send(command).then(
98
- (data) => {
99
- // process data.
100
- },
101
- (error) => {
102
- // error handling.
103
- }
104
- );
105
- ```
106
-
107
- Promises can also be called using `.catch()` and `.finally()` as follows:
91
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
108
92
 
109
93
  ```js
110
94
  client
@@ -120,27 +104,21 @@ client
120
104
  });
121
105
  ```
122
106
 
123
- #### Callbacks
124
-
125
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
126
- but they are supported by the send operation.
107
+ #### Aggregated client
127
108
 
128
- ```js
129
- // callbacks.
130
- client.send(command, (err, data) => {
131
- // process err and data.
132
- });
133
- ```
109
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
134
110
 
135
- #### v2 compatible style
111
+ `CustomerProfiles` extends `CustomerProfilesClient` and additionally supports all operations, waiters, and paginators as methods.
112
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
136
113
 
137
- The client can also send requests using v2 compatible style.
138
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
139
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
114
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`CustomerProfilesClient`).
115
+ More details are in the blog post on
116
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
140
117
 
141
118
  ```ts
142
- import * as AWS from "@aws-sdk/client-customer-profiles";
143
- const client = new AWS.CustomerProfiles({ region: "REGION" });
119
+ import { CustomerProfiles } from "@aws-sdk/client-customer-profiles";
120
+
121
+ const client = new CustomerProfiles({ region: "REGION" });
144
122
 
145
123
  // async/await.
146
124
  try {
@@ -160,7 +138,7 @@ client
160
138
  // error handling.
161
139
  });
162
140
 
163
- // callbacks.
141
+ // callbacks (not recommended).
164
142
  client.listDomains(params, (err, data) => {
165
143
  // process err and data.
166
144
  });
@@ -188,12 +166,14 @@ try {
188
166
  }
189
167
  ```
190
168
 
169
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
170
+
191
171
  ## Getting Help
192
172
 
193
173
  Please use these community resources for getting help.
194
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
174
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
195
175
 
196
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
176
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
197
177
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
198
178
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
199
179
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-customer-profiles",
3
3
  "description": "AWS SDK for JavaScript Customer Profiles 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-customer-profiles",
@@ -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
  },