@aws-sdk/client-connectcases 3.738.0 → 3.743.0

package/dist-types/commands/DeleteFieldCommand.d.ts

@@ -35,24 +35,25 @@ declare const DeleteFieldCommand_base: {
  *             </li>
  *             <li>
  *                <p>You cannot update a deleted field by calling <code>UpdateField</code>; it throws a
- *           <code>ValidationException</code>.</p>
+ *             <code>ValidationException</code>.</p>
  *             </li>
  *             <li>
  *                <p>Deleted fields are not included in the <code>ListFields</code> response.</p>
  *             </li>
  *             <li>
- *                <p>Calling <code>CreateCase</code> with a deleted field throws a <code>ValidationException</code> denoting
- *           which field IDs in the request have been deleted.</p>
+ *                <p>Calling <code>CreateCase</code> with a deleted field throws a
+ *             <code>ValidationException</code> denoting which field IDs in the request have been
+ *           deleted.</p>
  *             </li>
  *             <li>
- *                <p>Calling <code>GetCase</code> with a deleted field ID returns the deleted field's value if one
- *           exists.</p>
+ *                <p>Calling <code>GetCase</code> with a deleted field ID returns the deleted field's value
+ *           if one exists.</p>
  *             </li>
  *             <li>
- *                <p>Calling <code>UpdateCase</code> with a deleted field ID throws a <code>ValidationException</code> if the
- *           case does not already contain a value for the deleted field. Otherwise it succeeds,
- *           allowing you to update or remove (using <code>emptyValue: \{\}</code>) the field's value from the
- *           case.</p>
+ *                <p>Calling <code>UpdateCase</code> with a deleted field ID throws a
+ *             <code>ValidationException</code> if the case does not already contain a value for the
+ *           deleted field. Otherwise it succeeds, allowing you to update or remove (using
+ *             <code>emptyValue: \{\}</code>) the field's value from the case.</p>
  *             </li>
  *             <li>
  *                <p>
@@ -63,18 +64,20 @@ declare const DeleteFieldCommand_base: {
  *                   <code>GetLayout</code> does not return field IDs for deleted fields.</p>
  *             </li>
  *             <li>
- *                <p>Calling <code>SearchCases</code> with the deleted field ID as a filter returns any cases that
- *           have a value for the deleted field that matches the filter criteria.</p>
+ *                <p>Calling <code>SearchCases</code> with the deleted field ID as a filter returns any
+ *           cases that have a value for the deleted field that matches the filter criteria.</p>
  *             </li>
  *             <li>
- *                <p>Calling <code>SearchCases</code> with a <code>searchTerm</code> value that matches a deleted field's value on a
- *           case returns the case in the response.</p>
+ *                <p>Calling <code>SearchCases</code> with a <code>searchTerm</code> value that matches a
+ *           deleted field's value on a case returns the case in the response.</p>
  *             </li>
  *             <li>
- *                <p>Calling <code>BatchPutFieldOptions</code> with a deleted field ID throw a <code>ValidationException</code>.</p>
+ *                <p>Calling <code>BatchPutFieldOptions</code> with a deleted field ID throw a
+ *             <code>ValidationException</code>.</p>
  *             </li>
  *             <li>
- *                <p>Calling <code>GetCaseEventConfiguration</code> does not return field IDs for deleted fields.</p>
+ *                <p>Calling <code>GetCaseEventConfiguration</code> does not return field IDs for deleted
+ *           fields.</p>
  *             </li>
  *          </ul>
  * @example

package/dist-types/commands/DeleteLayoutCommand.d.ts

@@ -27,7 +27,8 @@ declare const DeleteLayoutCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Deletes a layout from a cases template. You can delete up to 100 layouts per domain.</p>
+ * <p>Deletes a layout from a cases template. You can delete up to 100 layouts per
+ *       domain.</p>
  *
  *          <p>After a layout is deleted:</p>
  *          <ul>
@@ -36,7 +37,7 @@ declare const DeleteLayoutCommand_base: {
  *             </li>
  *             <li>
  *                <p>You cannot update a deleted layout by calling <code>UpdateLayout</code>; it throws a
- *           <code>ValidationException</code>.</p>
+ *             <code>ValidationException</code>.</p>
  *             </li>
  *             <li>
  *                <p>Deleted layouts are not included in the <code>ListLayouts</code> response.</p>

package/dist-types/commands/GetTemplateCommand.d.ts

@@ -27,7 +27,29 @@ declare const GetTemplateCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns the details for the requested template. </p>
+ * <p>Returns the details for the requested template. Other template APIs are: </p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html">CreateTemplate</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html">DeleteTemplate</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html">ListTemplates</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html">UpdateTemplate</a>
+ *                </p>
+ *             </li>
+ *          </ul>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -60,6 +82,12 @@ declare const GetTemplateCommand_base: {
  * //   deleted: true || false,
  * //   createdTime: new Date("TIMESTAMP"),
  * //   lastModifiedTime: new Date("TIMESTAMP"),
+ * //   rules: [ // TemplateCaseRuleList
+ * //     { // TemplateRule
+ * //       caseRuleId: "STRING_VALUE", // required
+ * //       fieldId: "STRING_VALUE", // required
+ * //     },
+ * //   ],
  * // };
  *
  * ```

package/dist-types/commands/ListCaseRulesCommand.d.ts

@@ -0,0 +1,101 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
+import { ListCaseRulesRequest, ListCaseRulesResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListCaseRulesCommand}.
+ */
+export interface ListCaseRulesCommandInput extends ListCaseRulesRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListCaseRulesCommand}.
+ */
+export interface ListCaseRulesCommandOutput extends ListCaseRulesResponse, __MetadataBearer {
+}
+declare const ListCaseRulesCommand_base: {
+    new (input: ListCaseRulesCommandInput): import("@smithy/smithy-client").CommandImpl<ListCaseRulesCommandInput, ListCaseRulesCommandOutput, ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListCaseRulesCommandInput): import("@smithy/smithy-client").CommandImpl<ListCaseRulesCommandInput, ListCaseRulesCommandOutput, ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Lists all case rules in a Cases domain. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>.  For more
+ *       information about case field conditions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html">Add case field conditions to a
+ *         case template</a>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConnectCasesClient, ListCaseRulesCommand } from "@aws-sdk/client-connectcases"; // ES Modules import
+ * // const { ConnectCasesClient, ListCaseRulesCommand } = require("@aws-sdk/client-connectcases"); // CommonJS import
+ * const client = new ConnectCasesClient(config);
+ * const input = { // ListCaseRulesRequest
+ *   domainId: "STRING_VALUE", // required
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListCaseRulesCommand(input);
+ * const response = await client.send(command);
+ * // { // ListCaseRulesResponse
+ * //   caseRules: [ // CaseRuleSummaryList // required
+ * //     { // CaseRuleSummary
+ * //       caseRuleId: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE", // required
+ * //       caseRuleArn: "STRING_VALUE", // required
+ * //       ruleType: "STRING_VALUE", // required
+ * //       description: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListCaseRulesCommandInput - {@link ListCaseRulesCommandInput}
+ * @returns {@link ListCaseRulesCommandOutput}
+ * @see {@link ListCaseRulesCommandInput} for command's `input` shape.
+ * @see {@link ListCaseRulesCommandOutput} for command's `response` shape.
+ * @see {@link ConnectCasesClientResolvedConfig | config} for ConnectCasesClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>We couldn't process your request because of an issue with the server. Try again
+ *       later.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>We couldn't find the requested resource. Check that your resources exists and were created
+ *       in the same Amazon Web Services Region as your request, and try your request again.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request isn't valid. Check the syntax and try again.</p>
+ *
+ * @throws {@link ConnectCasesServiceException}
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
+ *
+ * @public
+ */
+export declare class ListCaseRulesCommand extends ListCaseRulesCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListCaseRulesRequest;
+            output: ListCaseRulesResponse;
+        };
+        sdk: {
+            input: ListCaseRulesCommandInput;
+            output: ListCaseRulesCommandOutput;
+        };
+    };
+}

package/dist-types/commands/ListTemplatesCommand.d.ts

@@ -29,6 +29,29 @@ declare const ListTemplatesCommand_base: {
 /**
  * <p>Lists all of the templates in a Cases domain. Each list item is a condensed summary
  *       object of the template. </p>
+ *          <p> Other template APIs are: </p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html">CreateTemplate</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html">DeleteTemplate</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html">GetTemplate</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html">UpdateTemplate</a>
+ *                </p>
+ *             </li>
+ *          </ul>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateCaseCommand.d.ts

@@ -30,7 +30,6 @@ declare const UpdateCaseCommand_base: {
  * <note>
  *             <p>If you provide a value for <code>PerformedBy.UserArn</code> you must also have <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html">connect:DescribeUser</a> permission on the User ARN resource that you provide</p>
  *          </note>
- *
  *          <p>Updates the values of fields on a case. Fields to be updated are received as an array of
  *       id/value pairs identical to the <code>CreateCase</code> input .</p>
  *          <p>If the action is successful, the service sends back an HTTP 200 response with an empty

package/dist-types/commands/UpdateCaseRuleCommand.d.ts

@@ -0,0 +1,129 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
+import { UpdateCaseRuleRequest, UpdateCaseRuleResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateCaseRuleCommand}.
+ */
+export interface UpdateCaseRuleCommandInput extends UpdateCaseRuleRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateCaseRuleCommand}.
+ */
+export interface UpdateCaseRuleCommandOutput extends UpdateCaseRuleResponse, __MetadataBearer {
+}
+declare const UpdateCaseRuleCommand_base: {
+    new (input: UpdateCaseRuleCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateCaseRuleCommandInput, UpdateCaseRuleCommandOutput, ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateCaseRuleCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateCaseRuleCommandInput, UpdateCaseRuleCommandOutput, ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates a case rule. In the Amazon Connect admin website, case rules are known as <i>case field conditions</i>.  For more
+ *       information about case field conditions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html">Add case field conditions to a
+ *         case template</a>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ConnectCasesClient, UpdateCaseRuleCommand } from "@aws-sdk/client-connectcases"; // ES Modules import
+ * // const { ConnectCasesClient, UpdateCaseRuleCommand } = require("@aws-sdk/client-connectcases"); // CommonJS import
+ * const client = new ConnectCasesClient(config);
+ * const input = { // UpdateCaseRuleRequest
+ *   domainId: "STRING_VALUE", // required
+ *   caseRuleId: "STRING_VALUE", // required
+ *   name: "STRING_VALUE",
+ *   description: "STRING_VALUE",
+ *   rule: { // CaseRuleDetails Union: only one key present
+ *     required: { // RequiredCaseRule
+ *       defaultValue: true || false, // required
+ *       conditions: [ // BooleanConditionList // required
+ *         { // BooleanCondition Union: only one key present
+ *           equalTo: { // BooleanOperands
+ *             operandOne: { // OperandOne Union: only one key present
+ *               fieldId: "STRING_VALUE",
+ *             },
+ *             operandTwo: { // OperandTwo Union: only one key present
+ *               stringValue: "STRING_VALUE",
+ *               booleanValue: true || false,
+ *               doubleValue: Number("double"),
+ *               emptyValue: {},
+ *             },
+ *             result: true || false, // required
+ *           },
+ *           notEqualTo: {
+ *             operandOne: {//  Union: only one key present
+ *               fieldId: "STRING_VALUE",
+ *             },
+ *             operandTwo: {//  Union: only one key present
+ *               stringValue: "STRING_VALUE",
+ *               booleanValue: true || false,
+ *               doubleValue: Number("double"),
+ *               emptyValue: {},
+ *             },
+ *             result: true || false, // required
+ *           },
+ *         },
+ *       ],
+ *     },
+ *   },
+ * };
+ * const command = new UpdateCaseRuleCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param UpdateCaseRuleCommandInput - {@link UpdateCaseRuleCommandInput}
+ * @returns {@link UpdateCaseRuleCommandOutput}
+ * @see {@link UpdateCaseRuleCommandInput} for command's `input` shape.
+ * @see {@link UpdateCaseRuleCommandOutput} for command's `response` shape.
+ * @see {@link ConnectCasesClientResolvedConfig | config} for ConnectCasesClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The requested operation would cause a conflict with the current state of a service
+ *       resource associated with the request. Resolve the conflict before retrying this request. See
+ *       the accompanying error message for details.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>We couldn't process your request because of an issue with the server. Try again
+ *       later.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>We couldn't find the requested resource. Check that your resources exists and were created
+ *       in the same Amazon Web Services Region as your request, and try your request again.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request isn't valid. Check the syntax and try again.</p>
+ *
+ * @throws {@link ConnectCasesServiceException}
+ * <p>Base exception class for all service exceptions from ConnectCases service.</p>
+ *
+ * @public
+ */
+export declare class UpdateCaseRuleCommand extends UpdateCaseRuleCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateCaseRuleRequest;
+            output: {};
+        };
+        sdk: {
+            input: UpdateCaseRuleCommandInput;
+            output: UpdateCaseRuleCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateTemplateCommand.d.ts

@@ -32,6 +32,29 @@ declare const UpdateTemplateCommand_base: {
  *       <code>layoutConfiguration</code>, <code>requiredFields</code>, and <code>status</code>. At
  *       least one of these attributes must not be null. If a null value is provided for a given
  *       attribute, that attribute is ignored and its current value is preserved.</p>
+ *          <p>Other template APIs are:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html">CreateTemplate</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html">DeleteTemplate</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html">GetTemplate</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html">ListTemplates</a>
+ *                </p>
+ *             </li>
+ *          </ul>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -52,6 +75,12 @@ declare const UpdateTemplateCommand_base: {
  *     },
  *   ],
  *   status: "STRING_VALUE",
+ *   rules: [ // TemplateCaseRuleList
+ *     { // TemplateRule
+ *       caseRuleId: "STRING_VALUE", // required
+ *       fieldId: "STRING_VALUE", // required
+ *     },
+ *   ],
  * };
  * const command = new UpdateTemplateCommand(input);
  * const response = await client.send(command);

package/dist-types/commands/index.d.ts

@@ -1,11 +1,14 @@
+export * from "./BatchGetCaseRuleCommand";
 export * from "./BatchGetFieldCommand";
 export * from "./BatchPutFieldOptionsCommand";
 export * from "./CreateCaseCommand";
+export * from "./CreateCaseRuleCommand";
 export * from "./CreateDomainCommand";
 export * from "./CreateFieldCommand";
 export * from "./CreateLayoutCommand";
 export * from "./CreateRelatedItemCommand";
 export * from "./CreateTemplateCommand";
+export * from "./DeleteCaseRuleCommand";
 export * from "./DeleteDomainCommand";
 export * from "./DeleteFieldCommand";
 export * from "./DeleteLayoutCommand";
@@ -16,6 +19,7 @@ export * from "./GetCaseEventConfigurationCommand";
 export * from "./GetDomainCommand";
 export * from "./GetLayoutCommand";
 export * from "./GetTemplateCommand";
+export * from "./ListCaseRulesCommand";
 export * from "./ListCasesForContactCommand";
 export * from "./ListDomainsCommand";
 export * from "./ListFieldOptionsCommand";
@@ -29,6 +33,7 @@ export * from "./SearchRelatedItemsCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateCaseCommand";
+export * from "./UpdateCaseRuleCommand";
 export * from "./UpdateFieldCommand";
 export * from "./UpdateLayoutCommand";
 export * from "./UpdateTemplateCommand";

package/dist-types/index.d.ts

@@ -1,5 +1,19 @@
 /**
- * <p>With Amazon Connect Cases, your agents can track and manage customer issues that require
+ * <ul>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_Connect_Cases.html">Cases
+ *             actions</a>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_Connect_Cases.html">Cases data
+ *             types</a>
+ *                </p>
+ *             </li>
+ *          </ul>
+ *          <p>With Amazon Connect Cases, your agents can track and manage customer issues that require
  *       multiple interactions, follow-up tasks, and teams in your contact center. A case represents a
  *       customer issue. It records the issue, the steps and interactions taken to resolve the issue,
  *       and the outcome. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Amazon Connect Cases</a> in the