@aws-sdk/client-connectcases 3.296.0 → 3.298.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 (108) hide show
  1. package/dist-cjs/commands/BatchGetFieldCommand.js +2 -3
  2. package/dist-cjs/commands/BatchPutFieldOptionsCommand.js +2 -3
  3. package/dist-cjs/commands/CreateCaseCommand.js +2 -3
  4. package/dist-cjs/commands/CreateDomainCommand.js +2 -3
  5. package/dist-cjs/commands/CreateFieldCommand.js +2 -3
  6. package/dist-cjs/commands/CreateLayoutCommand.js +2 -3
  7. package/dist-cjs/commands/CreateRelatedItemCommand.js +2 -3
  8. package/dist-cjs/commands/CreateTemplateCommand.js +2 -3
  9. package/dist-cjs/commands/DeleteDomainCommand.js +2 -3
  10. package/dist-cjs/commands/GetCaseCommand.js +2 -3
  11. package/dist-cjs/commands/GetCaseEventConfigurationCommand.js +2 -3
  12. package/dist-cjs/commands/GetDomainCommand.js +2 -3
  13. package/dist-cjs/commands/GetLayoutCommand.js +2 -3
  14. package/dist-cjs/commands/GetTemplateCommand.js +2 -3
  15. package/dist-cjs/commands/ListCasesForContactCommand.js +2 -3
  16. package/dist-cjs/commands/ListDomainsCommand.js +2 -3
  17. package/dist-cjs/commands/ListFieldOptionsCommand.js +2 -3
  18. package/dist-cjs/commands/ListFieldsCommand.js +2 -3
  19. package/dist-cjs/commands/ListLayoutsCommand.js +2 -3
  20. package/dist-cjs/commands/ListTagsForResourceCommand.js +2 -3
  21. package/dist-cjs/commands/ListTemplatesCommand.js +2 -3
  22. package/dist-cjs/commands/PutCaseEventConfigurationCommand.js +2 -3
  23. package/dist-cjs/commands/SearchCasesCommand.js +2 -3
  24. package/dist-cjs/commands/SearchRelatedItemsCommand.js +2 -3
  25. package/dist-cjs/commands/TagResourceCommand.js +2 -3
  26. package/dist-cjs/commands/UntagResourceCommand.js +2 -3
  27. package/dist-cjs/commands/UpdateCaseCommand.js +2 -3
  28. package/dist-cjs/commands/UpdateFieldCommand.js +2 -3
  29. package/dist-cjs/commands/UpdateLayoutCommand.js +2 -3
  30. package/dist-cjs/commands/UpdateTemplateCommand.js +2 -3
  31. package/dist-cjs/models/models_0.js +1 -449
  32. package/dist-es/commands/BatchGetFieldCommand.js +2 -3
  33. package/dist-es/commands/BatchPutFieldOptionsCommand.js +2 -3
  34. package/dist-es/commands/CreateCaseCommand.js +2 -3
  35. package/dist-es/commands/CreateDomainCommand.js +2 -3
  36. package/dist-es/commands/CreateFieldCommand.js +2 -3
  37. package/dist-es/commands/CreateLayoutCommand.js +2 -3
  38. package/dist-es/commands/CreateRelatedItemCommand.js +2 -3
  39. package/dist-es/commands/CreateTemplateCommand.js +2 -3
  40. package/dist-es/commands/DeleteDomainCommand.js +2 -3
  41. package/dist-es/commands/GetCaseCommand.js +2 -3
  42. package/dist-es/commands/GetCaseEventConfigurationCommand.js +2 -3
  43. package/dist-es/commands/GetDomainCommand.js +2 -3
  44. package/dist-es/commands/GetLayoutCommand.js +2 -3
  45. package/dist-es/commands/GetTemplateCommand.js +2 -3
  46. package/dist-es/commands/ListCasesForContactCommand.js +2 -3
  47. package/dist-es/commands/ListDomainsCommand.js +2 -3
  48. package/dist-es/commands/ListFieldOptionsCommand.js +2 -3
  49. package/dist-es/commands/ListFieldsCommand.js +2 -3
  50. package/dist-es/commands/ListLayoutsCommand.js +2 -3
  51. package/dist-es/commands/ListTagsForResourceCommand.js +2 -3
  52. package/dist-es/commands/ListTemplatesCommand.js +2 -3
  53. package/dist-es/commands/PutCaseEventConfigurationCommand.js +2 -3
  54. package/dist-es/commands/SearchCasesCommand.js +2 -3
  55. package/dist-es/commands/SearchRelatedItemsCommand.js +2 -3
  56. package/dist-es/commands/TagResourceCommand.js +2 -3
  57. package/dist-es/commands/UntagResourceCommand.js +2 -3
  58. package/dist-es/commands/UpdateCaseCommand.js +2 -3
  59. package/dist-es/commands/UpdateFieldCommand.js +2 -3
  60. package/dist-es/commands/UpdateLayoutCommand.js +2 -3
  61. package/dist-es/commands/UpdateTemplateCommand.js +2 -3
  62. package/dist-es/models/models_0.js +0 -351
  63. package/dist-types/ConnectCases.d.ts +31 -0
  64. package/dist-types/ConnectCasesClient.d.ts +24 -4
  65. package/dist-types/commands/BatchGetFieldCommand.d.ts +16 -0
  66. package/dist-types/commands/BatchPutFieldOptionsCommand.d.ts +16 -0
  67. package/dist-types/commands/CreateCaseCommand.d.ts +16 -0
  68. package/dist-types/commands/CreateDomainCommand.d.ts +16 -0
  69. package/dist-types/commands/CreateFieldCommand.d.ts +16 -0
  70. package/dist-types/commands/CreateLayoutCommand.d.ts +16 -0
  71. package/dist-types/commands/CreateRelatedItemCommand.d.ts +16 -0
  72. package/dist-types/commands/CreateTemplateCommand.d.ts +16 -0
  73. package/dist-types/commands/DeleteDomainCommand.d.ts +16 -0
  74. package/dist-types/commands/GetCaseCommand.d.ts +16 -0
  75. package/dist-types/commands/GetCaseEventConfigurationCommand.d.ts +16 -0
  76. package/dist-types/commands/GetDomainCommand.d.ts +16 -0
  77. package/dist-types/commands/GetLayoutCommand.d.ts +16 -0
  78. package/dist-types/commands/GetTemplateCommand.d.ts +16 -0
  79. package/dist-types/commands/ListCasesForContactCommand.d.ts +16 -0
  80. package/dist-types/commands/ListDomainsCommand.d.ts +16 -0
  81. package/dist-types/commands/ListFieldOptionsCommand.d.ts +16 -0
  82. package/dist-types/commands/ListFieldsCommand.d.ts +16 -0
  83. package/dist-types/commands/ListLayoutsCommand.d.ts +16 -0
  84. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  85. package/dist-types/commands/ListTemplatesCommand.d.ts +16 -0
  86. package/dist-types/commands/PutCaseEventConfigurationCommand.d.ts +16 -0
  87. package/dist-types/commands/SearchCasesCommand.d.ts +16 -0
  88. package/dist-types/commands/SearchRelatedItemsCommand.d.ts +16 -0
  89. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  90. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  91. package/dist-types/commands/UpdateCaseCommand.d.ts +16 -0
  92. package/dist-types/commands/UpdateFieldCommand.d.ts +16 -0
  93. package/dist-types/commands/UpdateLayoutCommand.d.ts +16 -0
  94. package/dist-types/commands/UpdateTemplateCommand.d.ts +16 -0
  95. package/dist-types/models/ConnectCasesServiceException.d.ts +2 -0
  96. package/dist-types/models/models_0.d.ts +263 -380
  97. package/dist-types/pagination/GetCasePaginator.d.ts +3 -0
  98. package/dist-types/pagination/Interfaces.d.ts +3 -0
  99. package/dist-types/pagination/ListCasesForContactPaginator.d.ts +3 -0
  100. package/dist-types/pagination/ListDomainsPaginator.d.ts +3 -0
  101. package/dist-types/pagination/ListFieldOptionsPaginator.d.ts +3 -0
  102. package/dist-types/pagination/ListFieldsPaginator.d.ts +3 -0
  103. package/dist-types/pagination/ListLayoutsPaginator.d.ts +3 -0
  104. package/dist-types/pagination/ListTemplatesPaginator.d.ts +3 -0
  105. package/dist-types/pagination/SearchCasesPaginator.d.ts +3 -0
  106. package/dist-types/pagination/SearchRelatedItemsPaginator.d.ts +3 -0
  107. package/dist-types/ts3.4/models/models_0.d.ts +0 -259
  108. package/package.json +4 -3
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { UpdateCaseRequest, UpdateCaseResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateCaseCommand}.
8
10
  */
9
11
  export interface UpdateCaseCommandInput extends UpdateCaseRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateCaseCommand}.
13
17
  */
14
18
  export interface UpdateCaseCommandOutput extends UpdateCaseResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the values of fields on a case. Fields to be updated are received as an array of
18
23
  * id/value pairs identical to the <code>CreateCase</code> input .</p>
19
24
  * <p>If the action is successful, the service sends back an HTTP 200 response with an empty
@@ -28,6 +33,8 @@ export interface UpdateCaseCommandOutput extends UpdateCaseResponse, __MetadataB
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param UpdateCaseCommandInput - {@link UpdateCaseCommandInput}
37
+ * @returns {@link UpdateCaseCommandOutput}
31
38
  * @see {@link UpdateCaseCommandInput} for command's `input` shape.
32
39
  * @see {@link UpdateCaseCommandOutput} for command's `response` shape.
33
40
  * @see {@link ConnectCasesClientResolvedConfig | config} for ConnectCasesClient's `config` shape.
@@ -54,11 +61,20 @@ export interface UpdateCaseCommandOutput extends UpdateCaseResponse, __MetadataB
54
61
  export declare class UpdateCaseCommand extends $Command<UpdateCaseCommandInput, UpdateCaseCommandOutput, ConnectCasesClientResolvedConfig> {
55
62
  readonly input: UpdateCaseCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: UpdateCaseCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCasesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateCaseCommandInput, UpdateCaseCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { UpdateFieldRequest, UpdateFieldResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateFieldCommand}.
8
10
  */
9
11
  export interface UpdateFieldCommandInput extends UpdateFieldRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateFieldCommand}.
13
17
  */
14
18
  export interface UpdateFieldCommandOutput extends UpdateFieldResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the properties of an existing field. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateFieldCommandOutput extends UpdateFieldResponse, __Metadat
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param UpdateFieldCommandInput - {@link UpdateFieldCommandInput}
34
+ * @returns {@link UpdateFieldCommandOutput}
28
35
  * @see {@link UpdateFieldCommandInput} for command's `input` shape.
29
36
  * @see {@link UpdateFieldCommandOutput} for command's `response` shape.
30
37
  * @see {@link ConnectCasesClientResolvedConfig | config} for ConnectCasesClient's `config` shape.
@@ -56,11 +63,20 @@ export interface UpdateFieldCommandOutput extends UpdateFieldResponse, __Metadat
56
63
  export declare class UpdateFieldCommand extends $Command<UpdateFieldCommandInput, UpdateFieldCommandOutput, ConnectCasesClientResolvedConfig> {
57
64
  readonly input: UpdateFieldCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: UpdateFieldCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCasesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateFieldCommandInput, UpdateFieldCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { UpdateLayoutRequest, UpdateLayoutResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateLayoutCommand}.
8
10
  */
9
11
  export interface UpdateLayoutCommandInput extends UpdateLayoutRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateLayoutCommand}.
13
17
  */
14
18
  export interface UpdateLayoutCommandOutput extends UpdateLayoutResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the attributes of an existing layout.</p>
18
23
  * <p>If the action is successful, the service sends back an HTTP 200 response with an empty
19
24
  * HTTP body.</p>
@@ -33,6 +38,8 @@ export interface UpdateLayoutCommandOutput extends UpdateLayoutResponse, __Metad
33
38
  * const response = await client.send(command);
34
39
  * ```
35
40
  *
41
+ * @param UpdateLayoutCommandInput - {@link UpdateLayoutCommandInput}
42
+ * @returns {@link UpdateLayoutCommandOutput}
36
43
  * @see {@link UpdateLayoutCommandInput} for command's `input` shape.
37
44
  * @see {@link UpdateLayoutCommandOutput} for command's `response` shape.
38
45
  * @see {@link ConnectCasesClientResolvedConfig | config} for ConnectCasesClient's `config` shape.
@@ -68,11 +75,20 @@ export interface UpdateLayoutCommandOutput extends UpdateLayoutResponse, __Metad
68
75
  export declare class UpdateLayoutCommand extends $Command<UpdateLayoutCommandInput, UpdateLayoutCommandOutput, ConnectCasesClientResolvedConfig> {
69
76
  readonly input: UpdateLayoutCommandInput;
70
77
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
78
+ /**
79
+ * @public
80
+ */
71
81
  constructor(input: UpdateLayoutCommandInput);
72
82
  /**
73
83
  * @internal
74
84
  */
75
85
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCasesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateLayoutCommandInput, UpdateLayoutCommandOutput>;
86
+ /**
87
+ * @internal
88
+ */
76
89
  private serialize;
90
+ /**
91
+ * @internal
92
+ */
77
93
  private deserialize;
78
94
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
5
5
  import { UpdateTemplateRequest, UpdateTemplateResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateTemplateCommand}.
8
10
  */
9
11
  export interface UpdateTemplateCommandInput extends UpdateTemplateRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateTemplateCommand}.
13
17
  */
14
18
  export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the attributes of an existing template. The template attributes that can be
18
23
  * modified include <code>name</code>, <code>description</code>,
19
24
  * <code>layoutConfiguration</code>, <code>requiredFields</code>, and <code>status</code>. At
@@ -29,6 +34,8 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param UpdateTemplateCommandInput - {@link UpdateTemplateCommandInput}
38
+ * @returns {@link UpdateTemplateCommandOutput}
32
39
  * @see {@link UpdateTemplateCommandInput} for command's `input` shape.
33
40
  * @see {@link UpdateTemplateCommandOutput} for command's `response` shape.
34
41
  * @see {@link ConnectCasesClientResolvedConfig | config} for ConnectCasesClient's `config` shape.
@@ -60,11 +67,20 @@ export interface UpdateTemplateCommandOutput extends UpdateTemplateResponse, __M
60
67
  export declare class UpdateTemplateCommand extends $Command<UpdateTemplateCommandInput, UpdateTemplateCommandOutput, ConnectCasesClientResolvedConfig> {
61
68
  readonly input: UpdateTemplateCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: UpdateTemplateCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCasesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateTemplateCommandInput, UpdateTemplateCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from ConnectCases service.
4
6
  */
5
7
  export declare class ConnectCasesServiceException extends __ServiceException {