@aws-sdk/client-connectcases 3.278.0 → 3.281.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 (55) hide show
  1. package/README.md +248 -6
  2. package/dist-cjs/ConnectCases.js +15 -0
  3. package/dist-cjs/commands/DeleteDomainCommand.js +46 -0
  4. package/dist-cjs/commands/index.js +1 -0
  5. package/dist-cjs/endpoint/ruleset.js +3 -3
  6. package/dist-cjs/models/models_0.js +10 -2
  7. package/dist-cjs/protocols/Aws_restJson1.js +65 -2
  8. package/dist-es/ConnectCases.js +15 -0
  9. package/dist-es/commands/DeleteDomainCommand.js +42 -0
  10. package/dist-es/commands/index.js +1 -0
  11. package/dist-es/endpoint/ruleset.js +3 -3
  12. package/dist-es/models/models_0.js +6 -0
  13. package/dist-es/protocols/Aws_restJson1.js +61 -0
  14. package/dist-types/ConnectCases.d.ts +37 -9
  15. package/dist-types/ConnectCasesClient.d.ts +8 -8
  16. package/dist-types/commands/BatchGetFieldCommand.d.ts +6 -0
  17. package/dist-types/commands/BatchPutFieldOptionsCommand.d.ts +6 -0
  18. package/dist-types/commands/CreateCaseCommand.d.ts +23 -2
  19. package/dist-types/commands/CreateDomainCommand.d.ts +9 -1
  20. package/dist-types/commands/CreateFieldCommand.d.ts +6 -0
  21. package/dist-types/commands/CreateLayoutCommand.d.ts +6 -0
  22. package/dist-types/commands/CreateRelatedItemCommand.d.ts +6 -0
  23. package/dist-types/commands/CreateTemplateCommand.d.ts +6 -0
  24. package/dist-types/commands/DeleteDomainCommand.d.ts +43 -0
  25. package/dist-types/commands/GetCaseCommand.d.ts +6 -0
  26. package/dist-types/commands/GetCaseEventConfigurationCommand.d.ts +6 -0
  27. package/dist-types/commands/GetDomainCommand.d.ts +6 -0
  28. package/dist-types/commands/GetLayoutCommand.d.ts +6 -0
  29. package/dist-types/commands/GetTemplateCommand.d.ts +6 -0
  30. package/dist-types/commands/ListCasesForContactCommand.d.ts +6 -0
  31. package/dist-types/commands/ListDomainsCommand.d.ts +6 -0
  32. package/dist-types/commands/ListFieldOptionsCommand.d.ts +6 -0
  33. package/dist-types/commands/ListFieldsCommand.d.ts +6 -0
  34. package/dist-types/commands/ListLayoutsCommand.d.ts +6 -0
  35. package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -0
  36. package/dist-types/commands/ListTemplatesCommand.d.ts +6 -0
  37. package/dist-types/commands/PutCaseEventConfigurationCommand.d.ts +6 -0
  38. package/dist-types/commands/SearchCasesCommand.d.ts +11 -0
  39. package/dist-types/commands/SearchRelatedItemsCommand.d.ts +6 -0
  40. package/dist-types/commands/TagResourceCommand.d.ts +6 -0
  41. package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
  42. package/dist-types/commands/UpdateCaseCommand.d.ts +6 -0
  43. package/dist-types/commands/UpdateFieldCommand.d.ts +6 -0
  44. package/dist-types/commands/UpdateLayoutCommand.d.ts +6 -0
  45. package/dist-types/commands/UpdateTemplateCommand.d.ts +6 -0
  46. package/dist-types/commands/index.d.ts +1 -0
  47. package/dist-types/models/models_0.d.ts +16 -0
  48. package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
  49. package/dist-types/ts3.4/ConnectCases.d.ts +17 -0
  50. package/dist-types/ts3.4/ConnectCasesClient.d.ts +6 -0
  51. package/dist-types/ts3.4/commands/DeleteDomainCommand.d.ts +34 -0
  52. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  53. package/dist-types/ts3.4/models/models_0.d.ts +10 -0
  54. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
  55. package/package.json +6 -6
@@ -353,6 +353,12 @@ export const CreateDomainRequestFilterSensitiveLog = (obj) => ({
353
353
  export const CreateDomainResponseFilterSensitiveLog = (obj) => ({
354
354
  ...obj,
355
355
  });
356
+ export const DeleteDomainRequestFilterSensitiveLog = (obj) => ({
357
+ ...obj,
358
+ });
359
+ export const DeleteDomainResponseFilterSensitiveLog = (obj) => ({
360
+ ...obj,
361
+ });
356
362
  export const GetCaseEventConfigurationRequestFilterSensitiveLog = (obj) => ({
357
363
  ...obj,
358
364
  });
@@ -188,6 +188,22 @@ export const serializeAws_restJson1CreateTemplateCommand = async (input, context
188
188
  body,
189
189
  });
190
190
  };
191
+ export const serializeAws_restJson1DeleteDomainCommand = async (input, context) => {
192
+ const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
193
+ const headers = {};
194
+ let resolvedPath = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/domains/{domainId}";
195
+ resolvedPath = __resolvedPath(resolvedPath, input, "domainId", () => input.domainId, "{domainId}", false);
196
+ let body;
197
+ return new __HttpRequest({
198
+ protocol,
199
+ hostname,
200
+ port,
201
+ method: "DELETE",
202
+ headers,
203
+ path: resolvedPath,
204
+ body,
205
+ });
206
+ };
191
207
  export const serializeAws_restJson1GetCaseCommand = async (input, context) => {
192
208
  const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
193
209
  const headers = {
@@ -1059,6 +1075,51 @@ const deserializeAws_restJson1CreateTemplateCommandError = async (output, contex
1059
1075
  });
1060
1076
  }
1061
1077
  };
1078
+ export const deserializeAws_restJson1DeleteDomainCommand = async (output, context) => {
1079
+ if (output.statusCode !== 200 && output.statusCode >= 300) {
1080
+ return deserializeAws_restJson1DeleteDomainCommandError(output, context);
1081
+ }
1082
+ const contents = map({
1083
+ $metadata: deserializeMetadata(output),
1084
+ });
1085
+ await collectBody(output.body, context);
1086
+ return contents;
1087
+ };
1088
+ const deserializeAws_restJson1DeleteDomainCommandError = async (output, context) => {
1089
+ const parsedOutput = {
1090
+ ...output,
1091
+ body: await parseErrorBody(output.body, context),
1092
+ };
1093
+ const errorCode = loadRestJsonErrorCode(output, parsedOutput.body);
1094
+ switch (errorCode) {
1095
+ case "AccessDeniedException":
1096
+ case "com.amazonaws.connectcases#AccessDeniedException":
1097
+ throw await deserializeAws_restJson1AccessDeniedExceptionResponse(parsedOutput, context);
1098
+ case "ConflictException":
1099
+ case "com.amazonaws.connectcases#ConflictException":
1100
+ throw await deserializeAws_restJson1ConflictExceptionResponse(parsedOutput, context);
1101
+ case "InternalServerException":
1102
+ case "com.amazonaws.connectcases#InternalServerException":
1103
+ throw await deserializeAws_restJson1InternalServerExceptionResponse(parsedOutput, context);
1104
+ case "ResourceNotFoundException":
1105
+ case "com.amazonaws.connectcases#ResourceNotFoundException":
1106
+ throw await deserializeAws_restJson1ResourceNotFoundExceptionResponse(parsedOutput, context);
1107
+ case "ThrottlingException":
1108
+ case "com.amazonaws.connectcases#ThrottlingException":
1109
+ throw await deserializeAws_restJson1ThrottlingExceptionResponse(parsedOutput, context);
1110
+ case "ValidationException":
1111
+ case "com.amazonaws.connectcases#ValidationException":
1112
+ throw await deserializeAws_restJson1ValidationExceptionResponse(parsedOutput, context);
1113
+ default:
1114
+ const parsedBody = parsedOutput.body;
1115
+ throwDefaultError({
1116
+ output,
1117
+ parsedBody,
1118
+ exceptionCtor: __BaseException,
1119
+ errorCode,
1120
+ });
1121
+ }
1122
+ };
1062
1123
  export const deserializeAws_restJson1GetCaseCommand = async (output, context) => {
1063
1124
  if (output.statusCode !== 200 && output.statusCode >= 300) {
1064
1125
  return deserializeAws_restJson1GetCaseCommandError(output, context);
@@ -7,6 +7,7 @@ import { CreateFieldCommandInput, CreateFieldCommandOutput } from "./commands/Cr
7
7
  import { CreateLayoutCommandInput, CreateLayoutCommandOutput } from "./commands/CreateLayoutCommand";
8
8
  import { CreateRelatedItemCommandInput, CreateRelatedItemCommandOutput } from "./commands/CreateRelatedItemCommand";
9
9
  import { CreateTemplateCommandInput, CreateTemplateCommandOutput } from "./commands/CreateTemplateCommand";
10
+ import { DeleteDomainCommandInput, DeleteDomainCommandOutput } from "./commands/DeleteDomainCommand";
10
11
  import { GetCaseCommandInput, GetCaseCommandOutput } from "./commands/GetCaseCommand";
11
12
  import { GetCaseEventConfigurationCommandInput, GetCaseEventConfigurationCommandOutput } from "./commands/GetCaseEventConfigurationCommand";
12
13
  import { GetDomainCommandInput, GetDomainCommandOutput } from "./commands/GetDomainCommand";
@@ -30,12 +31,11 @@ import { UpdateLayoutCommandInput, UpdateLayoutCommandOutput } from "./commands/
30
31
  import { UpdateTemplateCommandInput, UpdateTemplateCommandOutput } from "./commands/UpdateTemplateCommand";
31
32
  import { ConnectCasesClient } from "./ConnectCasesClient";
32
33
  /**
33
- * <p>Welcome to the Amazon Connect Cases API Reference. This guide provides information about the
34
- * Amazon Connect Cases API, which you can use to create, update, get, and list Cases domains,
35
- * fields, field options, layouts, templates, cases, related items, and tags.</p>
36
- *
37
- * <p>For more information about Amazon Connect Cases, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Amazon Connect Cases</a> in the
38
- * <i>Amazon Connect Administrator Guide</i>. </p>
34
+ * <p>With Amazon Connect Cases, your agents can track and manage customer issues that require
35
+ * multiple interactions, follow-up tasks, and teams in your contact center. A case represents a
36
+ * customer issue. It records the issue, the steps and interactions taken to resolve the issue,
37
+ * 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
38
+ * <i>Amazon Connect Administrator Guide</i>.</p>
39
39
  */
40
40
  export declare class ConnectCases extends ConnectCasesClient {
41
41
  /**
@@ -55,8 +55,23 @@ export declare class ConnectCases extends ConnectCasesClient {
55
55
  * <p>Creates a case in the specified Cases domain. Case system and custom fields are taken
56
56
  * as an array id/value pairs with a declared data types.</p>
57
57
  * <note>
58
- * <p>
59
- * <code>customer_id</code> is a required field when creating a case.</p>
58
+ * <p>The following fields are required when creating a case:</p>
59
+ *
60
+ * <ul>
61
+ * <li>
62
+ * <p>
63
+ * <code>customer_id</code> - You must provide the full customer profile ARN in this
64
+ * format: <code>arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles
65
+ * domain name/profiles/profile ID</code>
66
+ * </p>
67
+ * </li>
68
+ * <li>
69
+ * <p>
70
+ * <code>title</code>
71
+ * </p>
72
+ * </li>
73
+ * </ul>
74
+ *
60
75
  * </note>
61
76
  */
62
77
  createCase(args: CreateCaseCommandInput, options?: __HttpHandlerOptions): Promise<CreateCaseCommandOutput>;
@@ -69,7 +84,9 @@ export declare class ConnectCases extends ConnectCasesClient {
69
84
  * <important>
70
85
  * <p>This will not associate your connect instance to Cases domain. Instead, use the
71
86
  * Amazon Connect
72
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateIntegrationAssociation.html">CreateIntegrationAssociation</a> API.</p>
87
+ * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateIntegrationAssociation.html">CreateIntegrationAssociation</a> API. You need specific IAM
88
+ * permissions to successfully associate the Cases domain. For more information, see
89
+ * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/required-permissions-iam-cases.html#onboard-cases-iam">Onboard to Cases</a>.</p>
73
90
  * </important>
74
91
  */
75
92
  createDomain(args: CreateDomainCommandInput, options?: __HttpHandlerOptions): Promise<CreateDomainCommandOutput>;
@@ -126,6 +143,12 @@ export declare class ConnectCases extends ConnectCasesClient {
126
143
  createTemplate(args: CreateTemplateCommandInput, options?: __HttpHandlerOptions): Promise<CreateTemplateCommandOutput>;
127
144
  createTemplate(args: CreateTemplateCommandInput, cb: (err: any, data?: CreateTemplateCommandOutput) => void): void;
128
145
  createTemplate(args: CreateTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTemplateCommandOutput) => void): void;
146
+ /**
147
+ * <p>Deletes a domain.</p>
148
+ */
149
+ deleteDomain(args: DeleteDomainCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDomainCommandOutput>;
150
+ deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void;
151
+ deleteDomain(args: DeleteDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void;
129
152
  /**
130
153
  * <p>Returns information about a specific case if it exists. </p>
131
154
  */
@@ -210,6 +233,11 @@ export declare class ConnectCases extends ConnectCasesClient {
210
233
  /**
211
234
  * <p>Searches for cases within their associated Cases domain. Search results are returned
212
235
  * as a paginated list of abridged case documents.</p>
236
+ * <note>
237
+ * <p>For <code>customer_id</code> you must provide the full customer profile ARN in this
238
+ * format: <code> arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain
239
+ * name/profiles/profile ID</code>. </p>
240
+ * </note>
213
241
  */
214
242
  searchCases(args: SearchCasesCommandInput, options?: __HttpHandlerOptions): Promise<SearchCasesCommandOutput>;
215
243
  searchCases(args: SearchCasesCommandInput, cb: (err: any, data?: SearchCasesCommandOutput) => void): void;
@@ -15,6 +15,7 @@ import { CreateFieldCommandInput, CreateFieldCommandOutput } from "./commands/Cr
15
15
  import { CreateLayoutCommandInput, CreateLayoutCommandOutput } from "./commands/CreateLayoutCommand";
16
16
  import { CreateRelatedItemCommandInput, CreateRelatedItemCommandOutput } from "./commands/CreateRelatedItemCommand";
17
17
  import { CreateTemplateCommandInput, CreateTemplateCommandOutput } from "./commands/CreateTemplateCommand";
18
+ import { DeleteDomainCommandInput, DeleteDomainCommandOutput } from "./commands/DeleteDomainCommand";
18
19
  import { GetCaseCommandInput, GetCaseCommandOutput } from "./commands/GetCaseCommand";
19
20
  import { GetCaseEventConfigurationCommandInput, GetCaseEventConfigurationCommandOutput } from "./commands/GetCaseEventConfigurationCommand";
20
21
  import { GetDomainCommandInput, GetDomainCommandOutput } from "./commands/GetDomainCommand";
@@ -37,8 +38,8 @@ import { UpdateFieldCommandInput, UpdateFieldCommandOutput } from "./commands/Up
37
38
  import { UpdateLayoutCommandInput, UpdateLayoutCommandOutput } from "./commands/UpdateLayoutCommand";
38
39
  import { UpdateTemplateCommandInput, UpdateTemplateCommandOutput } from "./commands/UpdateTemplateCommand";
39
40
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
40
- export declare type ServiceInputTypes = BatchGetFieldCommandInput | BatchPutFieldOptionsCommandInput | CreateCaseCommandInput | CreateDomainCommandInput | CreateFieldCommandInput | CreateLayoutCommandInput | CreateRelatedItemCommandInput | CreateTemplateCommandInput | GetCaseCommandInput | GetCaseEventConfigurationCommandInput | GetDomainCommandInput | GetLayoutCommandInput | GetTemplateCommandInput | ListCasesForContactCommandInput | ListDomainsCommandInput | ListFieldOptionsCommandInput | ListFieldsCommandInput | ListLayoutsCommandInput | ListTagsForResourceCommandInput | ListTemplatesCommandInput | PutCaseEventConfigurationCommandInput | SearchCasesCommandInput | SearchRelatedItemsCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCaseCommandInput | UpdateFieldCommandInput | UpdateLayoutCommandInput | UpdateTemplateCommandInput;
41
- export declare type ServiceOutputTypes = BatchGetFieldCommandOutput | BatchPutFieldOptionsCommandOutput | CreateCaseCommandOutput | CreateDomainCommandOutput | CreateFieldCommandOutput | CreateLayoutCommandOutput | CreateRelatedItemCommandOutput | CreateTemplateCommandOutput | GetCaseCommandOutput | GetCaseEventConfigurationCommandOutput | GetDomainCommandOutput | GetLayoutCommandOutput | GetTemplateCommandOutput | ListCasesForContactCommandOutput | ListDomainsCommandOutput | ListFieldOptionsCommandOutput | ListFieldsCommandOutput | ListLayoutsCommandOutput | ListTagsForResourceCommandOutput | ListTemplatesCommandOutput | PutCaseEventConfigurationCommandOutput | SearchCasesCommandOutput | SearchRelatedItemsCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCaseCommandOutput | UpdateFieldCommandOutput | UpdateLayoutCommandOutput | UpdateTemplateCommandOutput;
41
+ export declare type ServiceInputTypes = BatchGetFieldCommandInput | BatchPutFieldOptionsCommandInput | CreateCaseCommandInput | CreateDomainCommandInput | CreateFieldCommandInput | CreateLayoutCommandInput | CreateRelatedItemCommandInput | CreateTemplateCommandInput | DeleteDomainCommandInput | GetCaseCommandInput | GetCaseEventConfigurationCommandInput | GetDomainCommandInput | GetLayoutCommandInput | GetTemplateCommandInput | ListCasesForContactCommandInput | ListDomainsCommandInput | ListFieldOptionsCommandInput | ListFieldsCommandInput | ListLayoutsCommandInput | ListTagsForResourceCommandInput | ListTemplatesCommandInput | PutCaseEventConfigurationCommandInput | SearchCasesCommandInput | SearchRelatedItemsCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCaseCommandInput | UpdateFieldCommandInput | UpdateLayoutCommandInput | UpdateTemplateCommandInput;
42
+ export declare type ServiceOutputTypes = BatchGetFieldCommandOutput | BatchPutFieldOptionsCommandOutput | CreateCaseCommandOutput | CreateDomainCommandOutput | CreateFieldCommandOutput | CreateLayoutCommandOutput | CreateRelatedItemCommandOutput | CreateTemplateCommandOutput | DeleteDomainCommandOutput | GetCaseCommandOutput | GetCaseEventConfigurationCommandOutput | GetDomainCommandOutput | GetLayoutCommandOutput | GetTemplateCommandOutput | ListCasesForContactCommandOutput | ListDomainsCommandOutput | ListFieldOptionsCommandOutput | ListFieldsCommandOutput | ListLayoutsCommandOutput | ListTagsForResourceCommandOutput | ListTemplatesCommandOutput | PutCaseEventConfigurationCommandOutput | SearchCasesCommandOutput | SearchRelatedItemsCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCaseCommandOutput | UpdateFieldCommandOutput | UpdateLayoutCommandOutput | UpdateTemplateCommandOutput;
42
43
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
43
44
  /**
44
45
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
@@ -152,12 +153,11 @@ declare type ConnectCasesClientResolvedConfigType = __SmithyResolvedConfiguratio
152
153
  export interface ConnectCasesClientResolvedConfig extends ConnectCasesClientResolvedConfigType {
153
154
  }
154
155
  /**
155
- * <p>Welcome to the Amazon Connect Cases API Reference. This guide provides information about the
156
- * Amazon Connect Cases API, which you can use to create, update, get, and list Cases domains,
157
- * fields, field options, layouts, templates, cases, related items, and tags.</p>
158
- *
159
- * <p>For more information about Amazon Connect Cases, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Amazon Connect Cases</a> in the
160
- * <i>Amazon Connect Administrator Guide</i>. </p>
156
+ * <p>With Amazon Connect Cases, your agents can track and manage customer issues that require
157
+ * multiple interactions, follow-up tasks, and teams in your contact center. A case represents a
158
+ * customer issue. It records the issue, the steps and interactions taken to resolve the issue,
159
+ * 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
160
+ * <i>Amazon Connect Administrator Guide</i>.</p>
161
161
  */
162
162
  export declare class ConnectCasesClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ConnectCasesClientResolvedConfig> {
163
163
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { BatchGetFieldRequest, BatchGetFieldResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link BatchGetFieldCommand}.
8
+ */
6
9
  export interface BatchGetFieldCommandInput extends BatchGetFieldRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link BatchGetFieldCommand}.
13
+ */
8
14
  export interface BatchGetFieldCommandOutput extends BatchGetFieldResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { BatchPutFieldOptionsRequest, BatchPutFieldOptionsResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link BatchPutFieldOptionsCommand}.
8
+ */
6
9
  export interface BatchPutFieldOptionsCommandInput extends BatchPutFieldOptionsRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link BatchPutFieldOptionsCommand}.
13
+ */
8
14
  export interface BatchPutFieldOptionsCommandOutput extends BatchPutFieldOptionsResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,16 +3,37 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { CreateCaseRequest, CreateCaseResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link CreateCaseCommand}.
8
+ */
6
9
  export interface CreateCaseCommandInput extends CreateCaseRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link CreateCaseCommand}.
13
+ */
8
14
  export interface CreateCaseCommandOutput extends CreateCaseResponse, __MetadataBearer {
9
15
  }
10
16
  /**
11
17
  * <p>Creates a case in the specified Cases domain. Case system and custom fields are taken
12
18
  * as an array id/value pairs with a declared data types.</p>
13
19
  * <note>
14
- * <p>
15
- * <code>customer_id</code> is a required field when creating a case.</p>
20
+ * <p>The following fields are required when creating a case:</p>
21
+ *
22
+ * <ul>
23
+ * <li>
24
+ * <p>
25
+ * <code>customer_id</code> - You must provide the full customer profile ARN in this
26
+ * format: <code>arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles
27
+ * domain name/profiles/profile ID</code>
28
+ * </p>
29
+ * </li>
30
+ * <li>
31
+ * <p>
32
+ * <code>title</code>
33
+ * </p>
34
+ * </li>
35
+ * </ul>
36
+ *
16
37
  * </note>
17
38
  * @example
18
39
  * Use a bare-bones client and the command you need to make an API call.
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { CreateDomainRequest, CreateDomainResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link CreateDomainCommand}.
8
+ */
6
9
  export interface CreateDomainCommandInput extends CreateDomainRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link CreateDomainCommand}.
13
+ */
8
14
  export interface CreateDomainCommandOutput extends CreateDomainResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -14,7 +20,9 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
14
20
  * <important>
15
21
  * <p>This will not associate your connect instance to Cases domain. Instead, use the
16
22
  * Amazon Connect
17
- * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateIntegrationAssociation.html">CreateIntegrationAssociation</a> API.</p>
23
+ * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateIntegrationAssociation.html">CreateIntegrationAssociation</a> API. You need specific IAM
24
+ * permissions to successfully associate the Cases domain. For more information, see
25
+ * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/required-permissions-iam-cases.html#onboard-cases-iam">Onboard to Cases</a>.</p>
18
26
  * </important>
19
27
  * @example
20
28
  * Use a bare-bones client and the command you need to make an API call.
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { CreateFieldRequest, CreateFieldResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link CreateFieldCommand}.
8
+ */
6
9
  export interface CreateFieldCommandInput extends CreateFieldRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link CreateFieldCommand}.
13
+ */
8
14
  export interface CreateFieldCommandOutput extends CreateFieldResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { CreateLayoutRequest, CreateLayoutResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link CreateLayoutCommand}.
8
+ */
6
9
  export interface CreateLayoutCommandInput extends CreateLayoutRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link CreateLayoutCommand}.
13
+ */
8
14
  export interface CreateLayoutCommandOutput extends CreateLayoutResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { CreateRelatedItemRequest, CreateRelatedItemResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link CreateRelatedItemCommand}.
8
+ */
6
9
  export interface CreateRelatedItemCommandInput extends CreateRelatedItemRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link CreateRelatedItemCommand}.
13
+ */
8
14
  export interface CreateRelatedItemCommandOutput extends CreateRelatedItemResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { CreateTemplateRequest, CreateTemplateResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link CreateTemplateCommand}.
8
+ */
6
9
  export interface CreateTemplateCommandInput extends CreateTemplateRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link CreateTemplateCommand}.
13
+ */
8
14
  export interface CreateTemplateCommandOutput extends CreateTemplateResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -0,0 +1,43 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
+ import { DeleteDomainRequest, DeleteDomainResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link DeleteDomainCommand}.
8
+ */
9
+ export interface DeleteDomainCommandInput extends DeleteDomainRequest {
10
+ }
11
+ /**
12
+ * The output of {@link DeleteDomainCommand}.
13
+ */
14
+ export interface DeleteDomainCommandOutput extends DeleteDomainResponse, __MetadataBearer {
15
+ }
16
+ /**
17
+ * <p>Deletes a domain.</p>
18
+ * @example
19
+ * Use a bare-bones client and the command you need to make an API call.
20
+ * ```javascript
21
+ * import { ConnectCasesClient, DeleteDomainCommand } from "@aws-sdk/client-connectcases"; // ES Modules import
22
+ * // const { ConnectCasesClient, DeleteDomainCommand } = require("@aws-sdk/client-connectcases"); // CommonJS import
23
+ * const client = new ConnectCasesClient(config);
24
+ * const command = new DeleteDomainCommand(input);
25
+ * const response = await client.send(command);
26
+ * ```
27
+ *
28
+ * @see {@link DeleteDomainCommandInput} for command's `input` shape.
29
+ * @see {@link DeleteDomainCommandOutput} for command's `response` shape.
30
+ * @see {@link ConnectCasesClientResolvedConfig | config} for ConnectCasesClient's `config` shape.
31
+ *
32
+ */
33
+ export declare class DeleteDomainCommand extends $Command<DeleteDomainCommandInput, DeleteDomainCommandOutput, ConnectCasesClientResolvedConfig> {
34
+ readonly input: DeleteDomainCommandInput;
35
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
36
+ constructor(input: DeleteDomainCommandInput);
37
+ /**
38
+ * @internal
39
+ */
40
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCasesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDomainCommandInput, DeleteDomainCommandOutput>;
41
+ private serialize;
42
+ private deserialize;
43
+ }
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { GetCaseRequest, GetCaseResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link GetCaseCommand}.
8
+ */
6
9
  export interface GetCaseCommandInput extends GetCaseRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link GetCaseCommand}.
13
+ */
8
14
  export interface GetCaseCommandOutput extends GetCaseResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { GetCaseEventConfigurationRequest, GetCaseEventConfigurationResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link GetCaseEventConfigurationCommand}.
8
+ */
6
9
  export interface GetCaseEventConfigurationCommandInput extends GetCaseEventConfigurationRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link GetCaseEventConfigurationCommand}.
13
+ */
8
14
  export interface GetCaseEventConfigurationCommandOutput extends GetCaseEventConfigurationResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { GetDomainRequest, GetDomainResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link GetDomainCommand}.
8
+ */
6
9
  export interface GetDomainCommandInput extends GetDomainRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link GetDomainCommand}.
13
+ */
8
14
  export interface GetDomainCommandOutput extends GetDomainResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { GetLayoutRequest, GetLayoutResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link GetLayoutCommand}.
8
+ */
6
9
  export interface GetLayoutCommandInput extends GetLayoutRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link GetLayoutCommand}.
13
+ */
8
14
  export interface GetLayoutCommandOutput extends GetLayoutResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { GetTemplateRequest, GetTemplateResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link GetTemplateCommand}.
8
+ */
6
9
  export interface GetTemplateCommandInput extends GetTemplateRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link GetTemplateCommand}.
13
+ */
8
14
  export interface GetTemplateCommandOutput extends GetTemplateResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { ListCasesForContactRequest, ListCasesForContactResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link ListCasesForContactCommand}.
8
+ */
6
9
  export interface ListCasesForContactCommandInput extends ListCasesForContactRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link ListCasesForContactCommand}.
13
+ */
8
14
  export interface ListCasesForContactCommandOutput extends ListCasesForContactResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { ListDomainsRequest, ListDomainsResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link ListDomainsCommand}.
8
+ */
6
9
  export interface ListDomainsCommandInput extends ListDomainsRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link ListDomainsCommand}.
13
+ */
8
14
  export interface ListDomainsCommandOutput extends ListDomainsResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { ListFieldOptionsRequest, ListFieldOptionsResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link ListFieldOptionsCommand}.
8
+ */
6
9
  export interface ListFieldOptionsCommandInput extends ListFieldOptionsRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link ListFieldOptionsCommand}.
13
+ */
8
14
  export interface ListFieldOptionsCommandOutput extends ListFieldOptionsResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { ListFieldsRequest, ListFieldsResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link ListFieldsCommand}.
8
+ */
6
9
  export interface ListFieldsCommandInput extends ListFieldsRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link ListFieldsCommand}.
13
+ */
8
14
  export interface ListFieldsCommandOutput extends ListFieldsResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { ListLayoutsRequest, ListLayoutsResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link ListLayoutsCommand}.
8
+ */
6
9
  export interface ListLayoutsCommandInput extends ListLayoutsRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link ListLayoutsCommand}.
13
+ */
8
14
  export interface ListLayoutsCommandOutput extends ListLayoutsResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link ListTagsForResourceCommand}.
8
+ */
6
9
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link ListTagsForResourceCommand}.
13
+ */
8
14
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
9
15
  }
10
16
  /**
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { ListTemplatesRequest, ListTemplatesResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link ListTemplatesCommand}.
8
+ */
6
9
  export interface ListTemplatesCommandInput extends ListTemplatesRequest {
7
10
  }
11
+ /**
12
+ * The output of {@link ListTemplatesCommand}.
13
+ */
8
14
  export interface ListTemplatesCommandOutput extends ListTemplatesResponse, __MetadataBearer {
9
15
  }
10
16
  /**