feat(client-connect): Add support for Push Notifications for Amazon Connect chat. With Push Notifications enabled an alert could be sent to customers about new messages even when they aren't actively using the mobile application.

Author: awstools

clients/client-connect/README.md

@@ -28,8 +28,8 @@ touch with the appropriate agents.</p>
 are also limits to the number of requests that you can make per second. For more information, see
 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator
 Guide</i>.</p>
-<p>You can use an endpoint to connect programmatically to an Amazon Web Services service. For
-a list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
+<p>You can use an endpoint to connect programmatically to an Amazon Web Services service. For a
+list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
 
 ## Installing
 
@@ -513,6 +513,14 @@ CreatePrompt
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/CreatePromptCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/CreatePromptCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/CreatePromptCommandOutput/)
 
+</details>
+<details>
+<summary>
+CreatePushNotificationRegistration
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/CreatePushNotificationRegistrationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/CreatePushNotificationRegistrationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/CreatePushNotificationRegistrationCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -713,6 +721,14 @@ DeletePrompt
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/DeletePromptCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/DeletePromptCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/DeletePromptCommandOutput/)
 
+</details>
+<details>
+<summary>
+DeletePushNotificationRegistration
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/connect/command/DeletePushNotificationRegistrationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/DeletePushNotificationRegistrationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-connect/Interface/DeletePushNotificationRegistrationCommandOutput/)
+
 </details>
 <details>
 <summary>

clients/client-connect/src/Connect.ts

@@ -182,6 +182,11 @@ import {
   CreatePromptCommandInput,
   CreatePromptCommandOutput,
 } from "./commands/CreatePromptCommand";
+import {
+  CreatePushNotificationRegistrationCommand,
+  CreatePushNotificationRegistrationCommandInput,
+  CreatePushNotificationRegistrationCommandOutput,
+} from "./commands/CreatePushNotificationRegistrationCommand";
 import { CreateQueueCommand, CreateQueueCommandInput, CreateQueueCommandOutput } from "./commands/CreateQueueCommand";
 import {
   CreateQuickConnectCommand,
@@ -291,6 +296,11 @@ import {
   DeletePromptCommandInput,
   DeletePromptCommandOutput,
 } from "./commands/DeletePromptCommand";
+import {
+  DeletePushNotificationRegistrationCommand,
+  DeletePushNotificationRegistrationCommandInput,
+  DeletePushNotificationRegistrationCommandOutput,
+} from "./commands/DeletePushNotificationRegistrationCommand";
 import { DeleteQueueCommand, DeleteQueueCommandInput, DeleteQueueCommandOutput } from "./commands/DeleteQueueCommand";
 import {
   DeleteQuickConnectCommand,
@@ -1311,6 +1321,7 @@ const commands = {
   CreatePersistentContactAssociationCommand,
   CreatePredefinedAttributeCommand,
   CreatePromptCommand,
+  CreatePushNotificationRegistrationCommand,
   CreateQueueCommand,
   CreateQuickConnectCommand,
   CreateRoutingProfileCommand,
@@ -1336,6 +1347,7 @@ const commands = {
   DeleteIntegrationAssociationCommand,
   DeletePredefinedAttributeCommand,
   DeletePromptCommand,
+  DeletePushNotificationRegistrationCommand,
   DeleteQueueCommand,
   DeleteQuickConnectCommand,
   DeleteRoutingProfileCommand,
@@ -2127,6 +2139,23 @@ export interface Connect {
     cb: (err: any, data?: CreatePromptCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link CreatePushNotificationRegistrationCommand}
+   */
+  createPushNotificationRegistration(
+    args: CreatePushNotificationRegistrationCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<CreatePushNotificationRegistrationCommandOutput>;
+  createPushNotificationRegistration(
+    args: CreatePushNotificationRegistrationCommandInput,
+    cb: (err: any, data?: CreatePushNotificationRegistrationCommandOutput) => void
+  ): void;
+  createPushNotificationRegistration(
+    args: CreatePushNotificationRegistrationCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: CreatePushNotificationRegistrationCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link CreateQueueCommand}
    */
@@ -2513,6 +2542,23 @@ export interface Connect {
     cb: (err: any, data?: DeletePromptCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link DeletePushNotificationRegistrationCommand}
+   */
+  deletePushNotificationRegistration(
+    args: DeletePushNotificationRegistrationCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<DeletePushNotificationRegistrationCommandOutput>;
+  deletePushNotificationRegistration(
+    args: DeletePushNotificationRegistrationCommandInput,
+    cb: (err: any, data?: DeletePushNotificationRegistrationCommandOutput) => void
+  ): void;
+  deletePushNotificationRegistration(
+    args: DeletePushNotificationRegistrationCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: DeletePushNotificationRegistrationCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link DeleteQueueCommand}
    */
@@ -5859,8 +5905,8 @@ export interface Connect {
  *    are also limits to the number of requests that you can make per second. For more information, see
  *     <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator
  *     Guide</i>.</p>
- *          <p>You can use an endpoint to connect programmatically to an Amazon Web Services service. For
- *    a list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
+ *          <p>You can use an endpoint to connect programmatically to an Amazon Web Services service. For a
+ *    list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
  * @public
  */
 export class Connect extends ConnectClient implements Connect {}

clients/client-connect/src/ConnectClient.ts

@@ -161,6 +161,10 @@ import {
   CreatePredefinedAttributeCommandOutput,
 } from "./commands/CreatePredefinedAttributeCommand";
 import { CreatePromptCommandInput, CreatePromptCommandOutput } from "./commands/CreatePromptCommand";
+import {
+  CreatePushNotificationRegistrationCommandInput,
+  CreatePushNotificationRegistrationCommandOutput,
+} from "./commands/CreatePushNotificationRegistrationCommand";
 import { CreateQueueCommandInput, CreateQueueCommandOutput } from "./commands/CreateQueueCommand";
 import { CreateQuickConnectCommandInput, CreateQuickConnectCommandOutput } from "./commands/CreateQuickConnectCommand";
 import {
@@ -219,6 +223,10 @@ import {
   DeletePredefinedAttributeCommandOutput,
 } from "./commands/DeletePredefinedAttributeCommand";
 import { DeletePromptCommandInput, DeletePromptCommandOutput } from "./commands/DeletePromptCommand";
+import {
+  DeletePushNotificationRegistrationCommandInput,
+  DeletePushNotificationRegistrationCommandOutput,
+} from "./commands/DeletePushNotificationRegistrationCommand";
 import { DeleteQueueCommandInput, DeleteQueueCommandOutput } from "./commands/DeleteQueueCommand";
 import { DeleteQuickConnectCommandInput, DeleteQuickConnectCommandOutput } from "./commands/DeleteQuickConnectCommand";
 import {
@@ -860,6 +868,7 @@ export type ServiceInputTypes =
   | CreatePersistentContactAssociationCommandInput
   | CreatePredefinedAttributeCommandInput
   | CreatePromptCommandInput
+  | CreatePushNotificationRegistrationCommandInput
   | CreateQueueCommandInput
   | CreateQuickConnectCommandInput
   | CreateRoutingProfileCommandInput
@@ -885,6 +894,7 @@ export type ServiceInputTypes =
   | DeleteIntegrationAssociationCommandInput
   | DeletePredefinedAttributeCommandInput
   | DeletePromptCommandInput
+  | DeletePushNotificationRegistrationCommandInput
   | DeleteQueueCommandInput
   | DeleteQuickConnectCommandInput
   | DeleteRoutingProfileCommandInput
@@ -1135,6 +1145,7 @@ export type ServiceOutputTypes =
   | CreatePersistentContactAssociationCommandOutput
   | CreatePredefinedAttributeCommandOutput
   | CreatePromptCommandOutput
+  | CreatePushNotificationRegistrationCommandOutput
   | CreateQueueCommandOutput
   | CreateQuickConnectCommandOutput
   | CreateRoutingProfileCommandOutput
@@ -1160,6 +1171,7 @@ export type ServiceOutputTypes =
   | DeleteIntegrationAssociationCommandOutput
   | DeletePredefinedAttributeCommandOutput
   | DeletePromptCommandOutput
+  | DeletePushNotificationRegistrationCommandOutput
   | DeleteQueueCommandOutput
   | DeleteQuickConnectCommandOutput
   | DeleteRoutingProfileCommandOutput
@@ -1564,8 +1576,8 @@ export interface ConnectClientResolvedConfig extends ConnectClientResolvedConfig
  *    are also limits to the number of requests that you can make per second. For more information, see
  *     <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator
  *     Guide</i>.</p>
- *          <p>You can use an endpoint to connect programmatically to an Amazon Web Services service. For
- *    a list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
+ *          <p>You can use an endpoint to connect programmatically to an Amazon Web Services service. For a
+ *    list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
  * @public
  */
 export class ConnectClient extends __Client<

clients/client-connect/src/commands/CreateContactCommand.ts

@@ -7,7 +7,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
 import { commonParams } from "../endpoint/EndpointParameters";
 import { CreateContactResponse } from "../models/models_0";
-import { CreateContactRequest, CreateContactRequestFilterSensitiveLog } from "../models/models_2";
+import { CreateContactRequest, CreateContactRequestFilterSensitiveLog } from "../models/models_3";
 import { de_CreateContactCommand, se_CreateContactCommand } from "../protocols/Aws_restJson1";
 
 /**

clients/client-connect/src/commands/CreateEvaluationFormCommand.ts

@@ -7,7 +7,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
 import { commonParams } from "../endpoint/EndpointParameters";
 import { CreateEvaluationFormResponse } from "../models/models_0";
-import { CreateEvaluationFormRequest } from "../models/models_2";
+import { CreateEvaluationFormRequest } from "../models/models_3";
 import { de_CreateEvaluationFormCommand, se_CreateEvaluationFormCommand } from "../protocols/Aws_restJson1";
 
 /**

clients/client-connect/src/commands/CreatePushNotificationRegistrationCommand.ts

@@ -0,0 +1,130 @@
+// smithy-typescript generated code
+import { getEndpointPlugin } from "@smithy/middleware-endpoint";
+import { getSerdePlugin } from "@smithy/middleware-serde";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+
+import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
+import { commonParams } from "../endpoint/EndpointParameters";
+import {
+  CreatePushNotificationRegistrationRequest,
+  CreatePushNotificationRegistrationResponse,
+} from "../models/models_0";
+import {
+  de_CreatePushNotificationRegistrationCommand,
+  se_CreatePushNotificationRegistrationCommand,
+} from "../protocols/Aws_restJson1";
+
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link CreatePushNotificationRegistrationCommand}.
+ */
+export interface CreatePushNotificationRegistrationCommandInput extends CreatePushNotificationRegistrationRequest {}
+/**
+ * @public
+ *
+ * The output of {@link CreatePushNotificationRegistrationCommand}.
+ */
+export interface CreatePushNotificationRegistrationCommandOutput
+  extends CreatePushNotificationRegistrationResponse,
+    __MetadataBearer {}
+
+/**
+ * <p>Creates registration for a device token and a chat contact to receive real-time push
+ *    notifications. For more information about push notifications, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/set-up-push-notifications-for-mobile-chat.html">Set up push
+ *     notifications in Amazon Connect for mobile chat</a> in the <i>Amazon Connect
+ *     Administrator Guide</i>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConnectClient, CreatePushNotificationRegistrationCommand } from "@aws-sdk/client-connect"; // ES Modules import
+ * // const { ConnectClient, CreatePushNotificationRegistrationCommand } = require("@aws-sdk/client-connect"); // CommonJS import
+ * const client = new ConnectClient(config);
+ * const input = { // CreatePushNotificationRegistrationRequest
+ *   InstanceId: "STRING_VALUE", // required
+ *   ClientToken: "STRING_VALUE",
+ *   PinpointAppArn: "STRING_VALUE", // required
+ *   DeviceToken: "STRING_VALUE", // required
+ *   DeviceType: "GCM" || "APNS" || "APNS_SANDBOX", // required
+ *   ContactConfiguration: { // ContactConfiguration
+ *     ContactId: "STRING_VALUE", // required
+ *     ParticipantRole: "AGENT" || "CUSTOMER" || "SYSTEM" || "CUSTOM_BOT" || "SUPERVISOR",
+ *     IncludeRawMessage: true || false,
+ *   },
+ * };
+ * const command = new CreatePushNotificationRegistrationCommand(input);
+ * const response = await client.send(command);
+ * // { // CreatePushNotificationRegistrationResponse
+ * //   RegistrationId: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param CreatePushNotificationRegistrationCommandInput - {@link CreatePushNotificationRegistrationCommandInput}
+ * @returns {@link CreatePushNotificationRegistrationCommandOutput}
+ * @see {@link CreatePushNotificationRegistrationCommandInput} for command's `input` shape.
+ * @see {@link CreatePushNotificationRegistrationCommandOutput} for command's `response` shape.
+ * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient permissions to perform this action.</p>
+ *
+ * @throws {@link InternalServiceException} (server fault)
+ *  <p>Request processing failed because of an error or failure with the service.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>One or more of the specified parameters are not valid.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The specified resource was not found.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>The service quota has been exceeded.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The throttling limit has been exceeded.</p>
+ *
+ * @throws {@link ConnectServiceException}
+ * <p>Base exception class for all service exceptions from Connect service.</p>
+ *
+ * @public
+ */
+export class CreatePushNotificationRegistrationCommand extends $Command
+  .classBuilder<
+    CreatePushNotificationRegistrationCommandInput,
+    CreatePushNotificationRegistrationCommandOutput,
+    ConnectClientResolvedConfig,
+    ServiceInputTypes,
+    ServiceOutputTypes
+  >()
+  .ep(commonParams)
+  .m(function (this: any, Command: any, cs: any, config: ConnectClientResolvedConfig, o: any) {
+    return [
+      getSerdePlugin(config, this.serialize, this.deserialize),
+      getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
+    ];
+  })
+  .s("AmazonConnectService", "CreatePushNotificationRegistration", {})
+  .n("ConnectClient", "CreatePushNotificationRegistrationCommand")
+  .f(void 0, void 0)
+  .ser(se_CreatePushNotificationRegistrationCommand)
+  .de(de_CreatePushNotificationRegistrationCommand)
+  .build() {
+  /** @internal type navigation helper, not in runtime. */
+  protected declare static __types: {
+    api: {
+      input: CreatePushNotificationRegistrationRequest;
+      output: CreatePushNotificationRegistrationResponse;
+    };
+    sdk: {
+      input: CreatePushNotificationRegistrationCommandInput;
+      output: CreatePushNotificationRegistrationCommandOutput;
+    };
+  };
+}