@aws-sdk/client-connectcases 3.184.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 (216) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +201 -0
  3. package/README.md +210 -0
  4. package/dist-cjs/ConnectCases.js +442 -0
  5. package/dist-cjs/ConnectCasesClient.js +37 -0
  6. package/dist-cjs/commands/BatchGetFieldCommand.js +36 -0
  7. package/dist-cjs/commands/BatchPutFieldOptionsCommand.js +36 -0
  8. package/dist-cjs/commands/CreateCaseCommand.js +36 -0
  9. package/dist-cjs/commands/CreateDomainCommand.js +36 -0
  10. package/dist-cjs/commands/CreateFieldCommand.js +36 -0
  11. package/dist-cjs/commands/CreateLayoutCommand.js +36 -0
  12. package/dist-cjs/commands/CreateRelatedItemCommand.js +36 -0
  13. package/dist-cjs/commands/CreateTemplateCommand.js +36 -0
  14. package/dist-cjs/commands/GetCaseCommand.js +36 -0
  15. package/dist-cjs/commands/GetCaseEventConfigurationCommand.js +36 -0
  16. package/dist-cjs/commands/GetDomainCommand.js +36 -0
  17. package/dist-cjs/commands/GetLayoutCommand.js +36 -0
  18. package/dist-cjs/commands/GetTemplateCommand.js +36 -0
  19. package/dist-cjs/commands/ListCasesForContactCommand.js +36 -0
  20. package/dist-cjs/commands/ListDomainsCommand.js +36 -0
  21. package/dist-cjs/commands/ListFieldOptionsCommand.js +36 -0
  22. package/dist-cjs/commands/ListFieldsCommand.js +36 -0
  23. package/dist-cjs/commands/ListLayoutsCommand.js +36 -0
  24. package/dist-cjs/commands/ListTagsForResourceCommand.js +36 -0
  25. package/dist-cjs/commands/ListTemplatesCommand.js +36 -0
  26. package/dist-cjs/commands/PutCaseEventConfigurationCommand.js +36 -0
  27. package/dist-cjs/commands/SearchCasesCommand.js +36 -0
  28. package/dist-cjs/commands/SearchRelatedItemsCommand.js +36 -0
  29. package/dist-cjs/commands/TagResourceCommand.js +36 -0
  30. package/dist-cjs/commands/UntagResourceCommand.js +36 -0
  31. package/dist-cjs/commands/UpdateCaseCommand.js +36 -0
  32. package/dist-cjs/commands/UpdateFieldCommand.js +36 -0
  33. package/dist-cjs/commands/UpdateLayoutCommand.js +36 -0
  34. package/dist-cjs/commands/UpdateTemplateCommand.js +36 -0
  35. package/dist-cjs/commands/index.js +32 -0
  36. package/dist-cjs/endpoints.js +132 -0
  37. package/dist-cjs/index.js +11 -0
  38. package/dist-cjs/models/ConnectCasesServiceException.js +11 -0
  39. package/dist-cjs/models/index.js +4 -0
  40. package/dist-cjs/models/models_0.js +661 -0
  41. package/dist-cjs/pagination/GetCasePaginator.js +35 -0
  42. package/dist-cjs/pagination/Interfaces.js +2 -0
  43. package/dist-cjs/pagination/ListCasesForContactPaginator.js +36 -0
  44. package/dist-cjs/pagination/ListDomainsPaginator.js +36 -0
  45. package/dist-cjs/pagination/ListFieldOptionsPaginator.js +36 -0
  46. package/dist-cjs/pagination/ListFieldsPaginator.js +36 -0
  47. package/dist-cjs/pagination/ListLayoutsPaginator.js +36 -0
  48. package/dist-cjs/pagination/ListTemplatesPaginator.js +36 -0
  49. package/dist-cjs/pagination/SearchCasesPaginator.js +36 -0
  50. package/dist-cjs/pagination/SearchRelatedItemsPaginator.js +36 -0
  51. package/dist-cjs/pagination/index.js +13 -0
  52. package/dist-cjs/protocols/Aws_restJson1.js +2920 -0
  53. package/dist-cjs/runtimeConfig.browser.js +45 -0
  54. package/dist-cjs/runtimeConfig.js +52 -0
  55. package/dist-cjs/runtimeConfig.native.js +16 -0
  56. package/dist-cjs/runtimeConfig.shared.js +17 -0
  57. package/dist-es/ConnectCases.js +438 -0
  58. package/dist-es/ConnectCasesClient.js +33 -0
  59. package/dist-es/commands/BatchGetFieldCommand.js +32 -0
  60. package/dist-es/commands/BatchPutFieldOptionsCommand.js +32 -0
  61. package/dist-es/commands/CreateCaseCommand.js +32 -0
  62. package/dist-es/commands/CreateDomainCommand.js +32 -0
  63. package/dist-es/commands/CreateFieldCommand.js +32 -0
  64. package/dist-es/commands/CreateLayoutCommand.js +32 -0
  65. package/dist-es/commands/CreateRelatedItemCommand.js +32 -0
  66. package/dist-es/commands/CreateTemplateCommand.js +32 -0
  67. package/dist-es/commands/GetCaseCommand.js +32 -0
  68. package/dist-es/commands/GetCaseEventConfigurationCommand.js +32 -0
  69. package/dist-es/commands/GetDomainCommand.js +32 -0
  70. package/dist-es/commands/GetLayoutCommand.js +32 -0
  71. package/dist-es/commands/GetTemplateCommand.js +32 -0
  72. package/dist-es/commands/ListCasesForContactCommand.js +32 -0
  73. package/dist-es/commands/ListDomainsCommand.js +32 -0
  74. package/dist-es/commands/ListFieldOptionsCommand.js +32 -0
  75. package/dist-es/commands/ListFieldsCommand.js +32 -0
  76. package/dist-es/commands/ListLayoutsCommand.js +32 -0
  77. package/dist-es/commands/ListTagsForResourceCommand.js +32 -0
  78. package/dist-es/commands/ListTemplatesCommand.js +32 -0
  79. package/dist-es/commands/PutCaseEventConfigurationCommand.js +32 -0
  80. package/dist-es/commands/SearchCasesCommand.js +32 -0
  81. package/dist-es/commands/SearchRelatedItemsCommand.js +32 -0
  82. package/dist-es/commands/TagResourceCommand.js +32 -0
  83. package/dist-es/commands/UntagResourceCommand.js +32 -0
  84. package/dist-es/commands/UpdateCaseCommand.js +32 -0
  85. package/dist-es/commands/UpdateFieldCommand.js +32 -0
  86. package/dist-es/commands/UpdateLayoutCommand.js +32 -0
  87. package/dist-es/commands/UpdateTemplateCommand.js +32 -0
  88. package/dist-es/commands/index.js +29 -0
  89. package/dist-es/endpoints.js +128 -0
  90. package/dist-es/index.js +6 -0
  91. package/dist-es/models/ConnectCasesServiceException.js +7 -0
  92. package/dist-es/models/index.js +1 -0
  93. package/dist-es/models/models_0.js +556 -0
  94. package/dist-es/pagination/GetCasePaginator.js +31 -0
  95. package/dist-es/pagination/Interfaces.js +1 -0
  96. package/dist-es/pagination/ListCasesForContactPaginator.js +32 -0
  97. package/dist-es/pagination/ListDomainsPaginator.js +32 -0
  98. package/dist-es/pagination/ListFieldOptionsPaginator.js +32 -0
  99. package/dist-es/pagination/ListFieldsPaginator.js +32 -0
  100. package/dist-es/pagination/ListLayoutsPaginator.js +32 -0
  101. package/dist-es/pagination/ListTemplatesPaginator.js +32 -0
  102. package/dist-es/pagination/SearchCasesPaginator.js +32 -0
  103. package/dist-es/pagination/SearchRelatedItemsPaginator.js +32 -0
  104. package/dist-es/pagination/index.js +10 -0
  105. package/dist-es/protocols/Aws_restJson1.js +2853 -0
  106. package/dist-es/runtimeConfig.browser.js +40 -0
  107. package/dist-es/runtimeConfig.js +48 -0
  108. package/dist-es/runtimeConfig.native.js +11 -0
  109. package/dist-es/runtimeConfig.shared.js +10 -0
  110. package/dist-types/ConnectCases.d.ts +276 -0
  111. package/dist-types/ConnectCasesClient.d.ts +178 -0
  112. package/dist-types/commands/BatchGetFieldCommand.d.ts +35 -0
  113. package/dist-types/commands/BatchPutFieldOptionsCommand.d.ts +36 -0
  114. package/dist-types/commands/CreateCaseCommand.d.ts +40 -0
  115. package/dist-types/commands/CreateDomainCommand.d.ts +42 -0
  116. package/dist-types/commands/CreateFieldCommand.d.ts +36 -0
  117. package/dist-types/commands/CreateLayoutCommand.d.ts +48 -0
  118. package/dist-types/commands/CreateRelatedItemCommand.d.ts +43 -0
  119. package/dist-types/commands/CreateTemplateCommand.d.ts +38 -0
  120. package/dist-types/commands/GetCaseCommand.d.ts +35 -0
  121. package/dist-types/commands/GetCaseEventConfigurationCommand.d.ts +35 -0
  122. package/dist-types/commands/GetDomainCommand.d.ts +35 -0
  123. package/dist-types/commands/GetLayoutCommand.d.ts +35 -0
  124. package/dist-types/commands/GetTemplateCommand.d.ts +35 -0
  125. package/dist-types/commands/ListCasesForContactCommand.d.ts +35 -0
  126. package/dist-types/commands/ListDomainsCommand.d.ts +36 -0
  127. package/dist-types/commands/ListFieldOptionsCommand.d.ts +35 -0
  128. package/dist-types/commands/ListFieldsCommand.d.ts +35 -0
  129. package/dist-types/commands/ListLayoutsCommand.d.ts +36 -0
  130. package/dist-types/commands/ListTagsForResourceCommand.d.ts +35 -0
  131. package/dist-types/commands/ListTemplatesCommand.d.ts +36 -0
  132. package/dist-types/commands/PutCaseEventConfigurationCommand.d.ts +35 -0
  133. package/dist-types/commands/SearchCasesCommand.d.ts +36 -0
  134. package/dist-types/commands/SearchRelatedItemsCommand.d.ts +39 -0
  135. package/dist-types/commands/TagResourceCommand.d.ts +35 -0
  136. package/dist-types/commands/UntagResourceCommand.d.ts +35 -0
  137. package/dist-types/commands/UpdateCaseCommand.d.ts +38 -0
  138. package/dist-types/commands/UpdateFieldCommand.d.ts +35 -0
  139. package/dist-types/commands/UpdateLayoutCommand.d.ts +43 -0
  140. package/dist-types/commands/UpdateTemplateCommand.d.ts +39 -0
  141. package/dist-types/commands/index.d.ts +29 -0
  142. package/dist-types/endpoints.d.ts +2 -0
  143. package/dist-types/index.d.ts +6 -0
  144. package/dist-types/models/ConnectCasesServiceException.d.ts +10 -0
  145. package/dist-types/models/index.d.ts +1 -0
  146. package/dist-types/models/models_0.d.ts +1985 -0
  147. package/dist-types/pagination/GetCasePaginator.d.ts +4 -0
  148. package/dist-types/pagination/Interfaces.d.ts +6 -0
  149. package/dist-types/pagination/ListCasesForContactPaginator.d.ts +4 -0
  150. package/dist-types/pagination/ListDomainsPaginator.d.ts +4 -0
  151. package/dist-types/pagination/ListFieldOptionsPaginator.d.ts +4 -0
  152. package/dist-types/pagination/ListFieldsPaginator.d.ts +4 -0
  153. package/dist-types/pagination/ListLayoutsPaginator.d.ts +4 -0
  154. package/dist-types/pagination/ListTemplatesPaginator.d.ts +4 -0
  155. package/dist-types/pagination/SearchCasesPaginator.d.ts +4 -0
  156. package/dist-types/pagination/SearchRelatedItemsPaginator.d.ts +4 -0
  157. package/dist-types/pagination/index.d.ts +10 -0
  158. package/dist-types/protocols/Aws_restJson1.d.ts +89 -0
  159. package/dist-types/runtimeConfig.browser.d.ts +40 -0
  160. package/dist-types/runtimeConfig.d.ts +40 -0
  161. package/dist-types/runtimeConfig.native.d.ts +39 -0
  162. package/dist-types/runtimeConfig.shared.d.ts +13 -0
  163. package/dist-types/ts3.4/ConnectCases.d.ts +497 -0
  164. package/dist-types/ts3.4/ConnectCasesClient.d.ts +279 -0
  165. package/dist-types/ts3.4/commands/BatchGetFieldCommand.d.ts +35 -0
  166. package/dist-types/ts3.4/commands/BatchPutFieldOptionsCommand.d.ts +39 -0
  167. package/dist-types/ts3.4/commands/CreateCaseCommand.d.ts +32 -0
  168. package/dist-types/ts3.4/commands/CreateDomainCommand.d.ts +32 -0
  169. package/dist-types/ts3.4/commands/CreateFieldCommand.d.ts +32 -0
  170. package/dist-types/ts3.4/commands/CreateLayoutCommand.d.ts +32 -0
  171. package/dist-types/ts3.4/commands/CreateRelatedItemCommand.d.ts +36 -0
  172. package/dist-types/ts3.4/commands/CreateTemplateCommand.d.ts +35 -0
  173. package/dist-types/ts3.4/commands/GetCaseCommand.d.ts +32 -0
  174. package/dist-types/ts3.4/commands/GetCaseEventConfigurationCommand.d.ts +39 -0
  175. package/dist-types/ts3.4/commands/GetDomainCommand.d.ts +32 -0
  176. package/dist-types/ts3.4/commands/GetLayoutCommand.d.ts +32 -0
  177. package/dist-types/ts3.4/commands/GetTemplateCommand.d.ts +32 -0
  178. package/dist-types/ts3.4/commands/ListCasesForContactCommand.d.ts +36 -0
  179. package/dist-types/ts3.4/commands/ListDomainsCommand.d.ts +32 -0
  180. package/dist-types/ts3.4/commands/ListFieldOptionsCommand.d.ts +35 -0
  181. package/dist-types/ts3.4/commands/ListFieldsCommand.d.ts +32 -0
  182. package/dist-types/ts3.4/commands/ListLayoutsCommand.d.ts +32 -0
  183. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +36 -0
  184. package/dist-types/ts3.4/commands/ListTemplatesCommand.d.ts +35 -0
  185. package/dist-types/ts3.4/commands/PutCaseEventConfigurationCommand.d.ts +39 -0
  186. package/dist-types/ts3.4/commands/SearchCasesCommand.d.ts +32 -0
  187. package/dist-types/ts3.4/commands/SearchRelatedItemsCommand.d.ts +36 -0
  188. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +30 -0
  189. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +30 -0
  190. package/dist-types/ts3.4/commands/UpdateCaseCommand.d.ts +32 -0
  191. package/dist-types/ts3.4/commands/UpdateFieldCommand.d.ts +32 -0
  192. package/dist-types/ts3.4/commands/UpdateLayoutCommand.d.ts +32 -0
  193. package/dist-types/ts3.4/commands/UpdateTemplateCommand.d.ts +35 -0
  194. package/dist-types/ts3.4/commands/index.d.ts +29 -0
  195. package/dist-types/ts3.4/endpoints.d.ts +2 -0
  196. package/dist-types/ts3.4/index.d.ts +6 -0
  197. package/dist-types/ts3.4/models/ConnectCasesServiceException.d.ts +7 -0
  198. package/dist-types/ts3.4/models/index.d.ts +1 -0
  199. package/dist-types/ts3.4/models/models_0.d.ts +988 -0
  200. package/dist-types/ts3.4/pagination/GetCasePaginator.d.ts +11 -0
  201. package/dist-types/ts3.4/pagination/Interfaces.d.ts +7 -0
  202. package/dist-types/ts3.4/pagination/ListCasesForContactPaginator.d.ts +11 -0
  203. package/dist-types/ts3.4/pagination/ListDomainsPaginator.d.ts +11 -0
  204. package/dist-types/ts3.4/pagination/ListFieldOptionsPaginator.d.ts +11 -0
  205. package/dist-types/ts3.4/pagination/ListFieldsPaginator.d.ts +11 -0
  206. package/dist-types/ts3.4/pagination/ListLayoutsPaginator.d.ts +11 -0
  207. package/dist-types/ts3.4/pagination/ListTemplatesPaginator.d.ts +11 -0
  208. package/dist-types/ts3.4/pagination/SearchCasesPaginator.d.ts +11 -0
  209. package/dist-types/ts3.4/pagination/SearchRelatedItemsPaginator.d.ts +11 -0
  210. package/dist-types/ts3.4/pagination/index.d.ts +10 -0
  211. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +353 -0
  212. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +67 -0
  213. package/dist-types/ts3.4/runtimeConfig.d.ts +67 -0
  214. package/dist-types/ts3.4/runtimeConfig.native.d.ts +68 -0
  215. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +10 -0
  216. package/package.json +102 -0
@@ -0,0 +1,1985 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
+ import { ConnectCasesServiceException as __BaseException } from "./ConnectCasesServiceException";
3
+ /**
4
+ * <p>You do not have sufficient access to perform this action.</p>
5
+ */
6
+ export declare class AccessDeniedException extends __BaseException {
7
+ readonly name: "AccessDeniedException";
8
+ readonly $fault: "client";
9
+ /**
10
+ * @internal
11
+ */
12
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
13
+ }
14
+ /**
15
+ * <p>The requested operation would cause a conflict with the current state of a service
16
+ * resource associated with the request. Resolve the conflict before retrying this request. See
17
+ * the accompanying error message for details.</p>
18
+ */
19
+ export declare class ConflictException extends __BaseException {
20
+ readonly name: "ConflictException";
21
+ readonly $fault: "client";
22
+ /**
23
+ * @internal
24
+ */
25
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
26
+ }
27
+ /**
28
+ * <p>Object to store union of Field values.</p>
29
+ */
30
+ export declare type FieldValueUnion = FieldValueUnion.BooleanValueMember | FieldValueUnion.DoubleValueMember | FieldValueUnion.StringValueMember | FieldValueUnion.$UnknownMember;
31
+ export declare namespace FieldValueUnion {
32
+ /**
33
+ * <p>String value type.</p>
34
+ */
35
+ interface StringValueMember {
36
+ stringValue: string;
37
+ doubleValue?: never;
38
+ booleanValue?: never;
39
+ $unknown?: never;
40
+ }
41
+ /**
42
+ * <p>Can be either null, or have a Double number value type. Only one value can be
43
+ * provided.</p>
44
+ */
45
+ interface DoubleValueMember {
46
+ stringValue?: never;
47
+ doubleValue: number;
48
+ booleanValue?: never;
49
+ $unknown?: never;
50
+ }
51
+ /**
52
+ * <p>Can be either null, or have a Boolean value type. Only one value can be provided.</p>
53
+ */
54
+ interface BooleanValueMember {
55
+ stringValue?: never;
56
+ doubleValue?: never;
57
+ booleanValue: boolean;
58
+ $unknown?: never;
59
+ }
60
+ interface $UnknownMember {
61
+ stringValue?: never;
62
+ doubleValue?: never;
63
+ booleanValue?: never;
64
+ $unknown: [string, any];
65
+ }
66
+ interface Visitor<T> {
67
+ stringValue: (value: string) => T;
68
+ doubleValue: (value: number) => T;
69
+ booleanValue: (value: boolean) => T;
70
+ _: (name: string, value: any) => T;
71
+ }
72
+ const visit: <T>(value: FieldValueUnion, visitor: Visitor<T>) => T;
73
+ }
74
+ /**
75
+ * <p>Object for case field values.</p>
76
+ */
77
+ export interface FieldValue {
78
+ /**
79
+ * <p>Unique identifier of a field.</p>
80
+ */
81
+ id: string | undefined;
82
+ /**
83
+ * <p>Union of potential field value types.</p>
84
+ */
85
+ value: FieldValueUnion | undefined;
86
+ }
87
+ export interface CreateCaseRequest {
88
+ /**
89
+ * <p>The unique identifier of the Cases domain. </p>
90
+ */
91
+ domainId: string | undefined;
92
+ /**
93
+ * <p>A unique identifier of a template.</p>
94
+ */
95
+ templateId: string | undefined;
96
+ /**
97
+ * <p>An array of objects with field ID (matching ListFields/DescribeField) and value union
98
+ * data.</p>
99
+ */
100
+ fields: FieldValue[] | undefined;
101
+ /**
102
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
103
+ * request.</p>
104
+ */
105
+ clientToken?: string;
106
+ }
107
+ export interface CreateCaseResponse {
108
+ /**
109
+ * <p>A unique identifier of the case.</p>
110
+ */
111
+ caseId: string | undefined;
112
+ /**
113
+ * <p>The Amazon Resource Name (ARN) of the case.</p>
114
+ */
115
+ caseArn: string | undefined;
116
+ }
117
+ /**
118
+ * <p>We couldn't process your request because of an issue with the server. Try again
119
+ * later.</p>
120
+ */
121
+ export declare class InternalServerException extends __BaseException {
122
+ readonly name: "InternalServerException";
123
+ readonly $fault: "server";
124
+ $retryable: {};
125
+ /**
126
+ * <p>Advice to clients on when the call can be safely retried.</p>
127
+ */
128
+ retryAfterSeconds?: number;
129
+ /**
130
+ * @internal
131
+ */
132
+ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
133
+ }
134
+ /**
135
+ * <p>We couldn't find the requested resource. Check that your resources exists and were created
136
+ * in the same Amazon Web Services Region as your request, and try your request again.</p>
137
+ */
138
+ export declare class ResourceNotFoundException extends __BaseException {
139
+ readonly name: "ResourceNotFoundException";
140
+ readonly $fault: "client";
141
+ /**
142
+ * <p>Unique identifier of the resource affected.</p>
143
+ */
144
+ resourceId: string | undefined;
145
+ /**
146
+ * <p>Type of the resource affected.</p>
147
+ */
148
+ resourceType: string | undefined;
149
+ /**
150
+ * @internal
151
+ */
152
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
153
+ }
154
+ /**
155
+ * <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
156
+ */
157
+ export declare class ThrottlingException extends __BaseException {
158
+ readonly name: "ThrottlingException";
159
+ readonly $fault: "client";
160
+ $retryable: {};
161
+ /**
162
+ * @internal
163
+ */
164
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
165
+ }
166
+ /**
167
+ * <p>The request isn't valid. Check the syntax and try again.</p>
168
+ */
169
+ export declare class ValidationException extends __BaseException {
170
+ readonly name: "ValidationException";
171
+ readonly $fault: "client";
172
+ /**
173
+ * @internal
174
+ */
175
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
176
+ }
177
+ /**
178
+ * <p>Object for unique identifier of a field.</p>
179
+ */
180
+ export interface FieldIdentifier {
181
+ /**
182
+ * <p>Unique identifier of a field.</p>
183
+ */
184
+ id: string | undefined;
185
+ }
186
+ export interface GetCaseRequest {
187
+ /**
188
+ * <p>A unique identifier of the case.</p>
189
+ */
190
+ caseId: string | undefined;
191
+ /**
192
+ * <p>The unique identifier of the Cases domain. </p>
193
+ */
194
+ domainId: string | undefined;
195
+ /**
196
+ * <p>A list of unique field identifiers. </p>
197
+ */
198
+ fields: FieldIdentifier[] | undefined;
199
+ /**
200
+ * <p>The token for the next set of results. Use the value returned in the previous
201
+ * response in the next request to retrieve the next set of results.</p>
202
+ */
203
+ nextToken?: string;
204
+ }
205
+ export interface GetCaseResponse {
206
+ /**
207
+ * <p>A list of detailed field information. </p>
208
+ */
209
+ fields: FieldValue[] | undefined;
210
+ /**
211
+ * <p>A unique identifier of a template.</p>
212
+ */
213
+ templateId: string | undefined;
214
+ /**
215
+ * <p>The token for the next set of results. This is null if there are no more results to return.</p>
216
+ */
217
+ nextToken?: string;
218
+ /**
219
+ * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
220
+ */
221
+ tags?: Record<string, string>;
222
+ }
223
+ export interface ListCasesForContactRequest {
224
+ /**
225
+ * <p>The unique identifier of the Cases domain. </p>
226
+ */
227
+ domainId: string | undefined;
228
+ /**
229
+ * <p>A unique identifier of a contact in Amazon Connect.</p>
230
+ */
231
+ contactArn: string | undefined;
232
+ /**
233
+ * <p>The maximum number of results to return per page.</p>
234
+ */
235
+ maxResults?: number;
236
+ /**
237
+ * <p>The token for the next set of results. Use the value returned in the previous
238
+ * response in the next request to retrieve the next set of results.</p>
239
+ */
240
+ nextToken?: string;
241
+ }
242
+ /**
243
+ * <p>Case summary information.</p>
244
+ */
245
+ export interface CaseSummary {
246
+ /**
247
+ * <p>A unique identifier of the case.</p>
248
+ */
249
+ caseId: string | undefined;
250
+ /**
251
+ * <p>A unique identifier of a template.</p>
252
+ */
253
+ templateId: string | undefined;
254
+ }
255
+ export interface ListCasesForContactResponse {
256
+ /**
257
+ * <p>A list of Case summary information.</p>
258
+ */
259
+ cases: CaseSummary[] | undefined;
260
+ /**
261
+ * <p>The token for the next set of results. This is null if there are no more results to return.</p>
262
+ */
263
+ nextToken?: string;
264
+ }
265
+ export declare enum CommentBodyTextType {
266
+ PLAINTEXT = "Text/Plain"
267
+ }
268
+ /**
269
+ * <p>Represents the content of a <code>Comment</code> to be returned to agents.</p>
270
+ */
271
+ export interface CommentContent {
272
+ /**
273
+ * <p>Text in the body of a <code>Comment</code> on a case.</p>
274
+ */
275
+ body: string | undefined;
276
+ /**
277
+ * <p>Type of the text in the box of a <code>Comment</code> on a case.</p>
278
+ */
279
+ contentType: CommentBodyTextType | string | undefined;
280
+ }
281
+ /**
282
+ * <p>An object that represents an Amazon Connect contact object. </p>
283
+ */
284
+ export interface Contact {
285
+ /**
286
+ * <p>A unique identifier of a contact in Amazon Connect.</p>
287
+ */
288
+ contactArn: string | undefined;
289
+ }
290
+ /**
291
+ * <p>Represents the content of a related item to be created.</p>
292
+ */
293
+ export declare type RelatedItemInputContent = RelatedItemInputContent.CommentMember | RelatedItemInputContent.ContactMember | RelatedItemInputContent.$UnknownMember;
294
+ export declare namespace RelatedItemInputContent {
295
+ /**
296
+ * <p>Object representing a contact in Amazon Connect as an API request field.</p>
297
+ */
298
+ interface ContactMember {
299
+ contact: Contact;
300
+ comment?: never;
301
+ $unknown?: never;
302
+ }
303
+ /**
304
+ * <p>Represents the content of a comment to be returned to agents.</p>
305
+ */
306
+ interface CommentMember {
307
+ contact?: never;
308
+ comment: CommentContent;
309
+ $unknown?: never;
310
+ }
311
+ interface $UnknownMember {
312
+ contact?: never;
313
+ comment?: never;
314
+ $unknown: [string, any];
315
+ }
316
+ interface Visitor<T> {
317
+ contact: (value: Contact) => T;
318
+ comment: (value: CommentContent) => T;
319
+ _: (name: string, value: any) => T;
320
+ }
321
+ const visit: <T>(value: RelatedItemInputContent, visitor: Visitor<T>) => T;
322
+ }
323
+ export declare enum RelatedItemType {
324
+ COMMENT = "Comment",
325
+ CONTACT = "Contact"
326
+ }
327
+ export interface CreateRelatedItemRequest {
328
+ /**
329
+ * <p>The unique identifier of the Cases domain. </p>
330
+ */
331
+ domainId: string | undefined;
332
+ /**
333
+ * <p>A unique identifier of the case.</p>
334
+ */
335
+ caseId: string | undefined;
336
+ /**
337
+ * <p>The type of a related item.</p>
338
+ */
339
+ type: RelatedItemType | string | undefined;
340
+ /**
341
+ * <p>The content of a related item to be created.</p>
342
+ */
343
+ content: RelatedItemInputContent | undefined;
344
+ }
345
+ export interface CreateRelatedItemResponse {
346
+ /**
347
+ * <p>The unique identifier of the related item.</p>
348
+ */
349
+ relatedItemId: string | undefined;
350
+ /**
351
+ * <p>The Amazon Resource Name (ARN) of the related item.</p>
352
+ */
353
+ relatedItemArn: string | undefined;
354
+ }
355
+ /**
356
+ * <p>The service quota has been exceeded. For a list of service quotas, 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
357
+ * Administrator Guide</i>.</p>
358
+ */
359
+ export declare class ServiceQuotaExceededException extends __BaseException {
360
+ readonly name: "ServiceQuotaExceededException";
361
+ readonly $fault: "client";
362
+ /**
363
+ * @internal
364
+ */
365
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
366
+ }
367
+ /**
368
+ * <p>A filter for related items of type <code>Comment</code>.</p>
369
+ */
370
+ export interface CommentFilter {
371
+ }
372
+ /**
373
+ * <p>A filter for related items of type <code>Contact</code>.</p>
374
+ */
375
+ export interface ContactFilter {
376
+ /**
377
+ * <p>A list of channels to filter on for related items of type <code>Contact</code>.</p>
378
+ */
379
+ channel?: string[];
380
+ /**
381
+ * <p>A unique identifier of a contact in Amazon Connect.</p>
382
+ */
383
+ contactArn?: string;
384
+ }
385
+ /**
386
+ * <p>The list of types of related items and their parameters to use for filtering.</p>
387
+ */
388
+ export declare type RelatedItemTypeFilter = RelatedItemTypeFilter.CommentMember | RelatedItemTypeFilter.ContactMember | RelatedItemTypeFilter.$UnknownMember;
389
+ export declare namespace RelatedItemTypeFilter {
390
+ /**
391
+ * <p>A filter for related items of type <code>Contact</code>.</p>
392
+ */
393
+ interface ContactMember {
394
+ contact: ContactFilter;
395
+ comment?: never;
396
+ $unknown?: never;
397
+ }
398
+ /**
399
+ * <p>A filter for related items of type <code>Comment</code>.</p>
400
+ */
401
+ interface CommentMember {
402
+ contact?: never;
403
+ comment: CommentFilter;
404
+ $unknown?: never;
405
+ }
406
+ interface $UnknownMember {
407
+ contact?: never;
408
+ comment?: never;
409
+ $unknown: [string, any];
410
+ }
411
+ interface Visitor<T> {
412
+ contact: (value: ContactFilter) => T;
413
+ comment: (value: CommentFilter) => T;
414
+ _: (name: string, value: any) => T;
415
+ }
416
+ const visit: <T>(value: RelatedItemTypeFilter, visitor: Visitor<T>) => T;
417
+ }
418
+ export interface SearchRelatedItemsRequest {
419
+ /**
420
+ * <p>The unique identifier of the Cases domain. </p>
421
+ */
422
+ domainId: string | undefined;
423
+ /**
424
+ * <p>A unique identifier of the case.</p>
425
+ */
426
+ caseId: string | undefined;
427
+ /**
428
+ * <p>The maximum number of results to return per page.</p>
429
+ */
430
+ maxResults?: number;
431
+ /**
432
+ * <p>The token for the next set of results. Use the value returned in the previous
433
+ * response in the next request to retrieve the next set of results.</p>
434
+ */
435
+ nextToken?: string;
436
+ /**
437
+ * <p>The list of types of related items and their parameters to use for filtering.</p>
438
+ */
439
+ filters?: RelatedItemTypeFilter[];
440
+ }
441
+ /**
442
+ * <p>An object that represents a content of an Amazon Connect contact object.</p>
443
+ */
444
+ export interface ContactContent {
445
+ /**
446
+ * <p>A unique identifier of a contact in Amazon Connect.</p>
447
+ */
448
+ contactArn: string | undefined;
449
+ /**
450
+ * <p>A list of channels to filter on for related items of type <code>Contact</code>.</p>
451
+ */
452
+ channel: string | undefined;
453
+ /**
454
+ * <p>The difference between the <code>InitiationTimestamp</code> and the
455
+ * <code>DisconnectTimestamp</code> of the contact.</p>
456
+ */
457
+ connectedToSystemTime: Date | undefined;
458
+ }
459
+ /**
460
+ * <p>Represents the content of a particular type of related item.</p>
461
+ */
462
+ export declare type RelatedItemContent = RelatedItemContent.CommentMember | RelatedItemContent.ContactMember | RelatedItemContent.$UnknownMember;
463
+ export declare namespace RelatedItemContent {
464
+ /**
465
+ * <p>Represents the content of a contact to be returned to agents.</p>
466
+ */
467
+ interface ContactMember {
468
+ contact: ContactContent;
469
+ comment?: never;
470
+ $unknown?: never;
471
+ }
472
+ /**
473
+ * <p>Represents the content of a comment to be returned to agents.</p>
474
+ */
475
+ interface CommentMember {
476
+ contact?: never;
477
+ comment: CommentContent;
478
+ $unknown?: never;
479
+ }
480
+ interface $UnknownMember {
481
+ contact?: never;
482
+ comment?: never;
483
+ $unknown: [string, any];
484
+ }
485
+ interface Visitor<T> {
486
+ contact: (value: ContactContent) => T;
487
+ comment: (value: CommentContent) => T;
488
+ _: (name: string, value: any) => T;
489
+ }
490
+ const visit: <T>(value: RelatedItemContent, visitor: Visitor<T>) => T;
491
+ }
492
+ /**
493
+ * <p>A list of items that represent RelatedItems.</p>
494
+ */
495
+ export interface SearchRelatedItemsResponseItem {
496
+ /**
497
+ * <p>Unique identifier of a related item.</p>
498
+ */
499
+ relatedItemId: string | undefined;
500
+ /**
501
+ * <p>Type of a related item.</p>
502
+ */
503
+ type: RelatedItemType | string | undefined;
504
+ /**
505
+ * <p>Time at which a related item was associated with a case.</p>
506
+ */
507
+ associationTime: Date | undefined;
508
+ /**
509
+ * <p>Represents the content of a particular type of related item.</p>
510
+ */
511
+ content: RelatedItemContent | undefined;
512
+ /**
513
+ * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
514
+ */
515
+ tags?: Record<string, string>;
516
+ }
517
+ export interface SearchRelatedItemsResponse {
518
+ /**
519
+ * <p>The token for the next set of results. This is null if there are no more results to return.</p>
520
+ */
521
+ nextToken?: string;
522
+ /**
523
+ * <p>A list of items related to a case. </p>
524
+ */
525
+ relatedItems: SearchRelatedItemsResponseItem[] | undefined;
526
+ }
527
+ /**
528
+ * <p>A filter for fields. Only one value can be provided.</p>
529
+ */
530
+ export declare type FieldFilter = FieldFilter.ContainsMember | FieldFilter.EqualToMember | FieldFilter.GreaterThanMember | FieldFilter.GreaterThanOrEqualToMember | FieldFilter.LessThanMember | FieldFilter.LessThanOrEqualToMember | FieldFilter.$UnknownMember;
531
+ export declare namespace FieldFilter {
532
+ /**
533
+ * <p>Object containing field identifier and value information.</p>
534
+ */
535
+ interface EqualToMember {
536
+ equalTo: FieldValue;
537
+ contains?: never;
538
+ greaterThan?: never;
539
+ greaterThanOrEqualTo?: never;
540
+ lessThan?: never;
541
+ lessThanOrEqualTo?: never;
542
+ $unknown?: never;
543
+ }
544
+ /**
545
+ * <p>Object containing field identifier and value information.</p>
546
+ */
547
+ interface ContainsMember {
548
+ equalTo?: never;
549
+ contains: FieldValue;
550
+ greaterThan?: never;
551
+ greaterThanOrEqualTo?: never;
552
+ lessThan?: never;
553
+ lessThanOrEqualTo?: never;
554
+ $unknown?: never;
555
+ }
556
+ /**
557
+ * <p>Object containing field identifier and value information.</p>
558
+ */
559
+ interface GreaterThanMember {
560
+ equalTo?: never;
561
+ contains?: never;
562
+ greaterThan: FieldValue;
563
+ greaterThanOrEqualTo?: never;
564
+ lessThan?: never;
565
+ lessThanOrEqualTo?: never;
566
+ $unknown?: never;
567
+ }
568
+ /**
569
+ * <p>Object containing field identifier and value information.</p>
570
+ */
571
+ interface GreaterThanOrEqualToMember {
572
+ equalTo?: never;
573
+ contains?: never;
574
+ greaterThan?: never;
575
+ greaterThanOrEqualTo: FieldValue;
576
+ lessThan?: never;
577
+ lessThanOrEqualTo?: never;
578
+ $unknown?: never;
579
+ }
580
+ /**
581
+ * <p>Object containing field identifier and value information.</p>
582
+ */
583
+ interface LessThanMember {
584
+ equalTo?: never;
585
+ contains?: never;
586
+ greaterThan?: never;
587
+ greaterThanOrEqualTo?: never;
588
+ lessThan: FieldValue;
589
+ lessThanOrEqualTo?: never;
590
+ $unknown?: never;
591
+ }
592
+ /**
593
+ * <p>Object containing field identifier and value information. </p>
594
+ */
595
+ interface LessThanOrEqualToMember {
596
+ equalTo?: never;
597
+ contains?: never;
598
+ greaterThan?: never;
599
+ greaterThanOrEqualTo?: never;
600
+ lessThan?: never;
601
+ lessThanOrEqualTo: FieldValue;
602
+ $unknown?: never;
603
+ }
604
+ interface $UnknownMember {
605
+ equalTo?: never;
606
+ contains?: never;
607
+ greaterThan?: never;
608
+ greaterThanOrEqualTo?: never;
609
+ lessThan?: never;
610
+ lessThanOrEqualTo?: never;
611
+ $unknown: [string, any];
612
+ }
613
+ interface Visitor<T> {
614
+ equalTo: (value: FieldValue) => T;
615
+ contains: (value: FieldValue) => T;
616
+ greaterThan: (value: FieldValue) => T;
617
+ greaterThanOrEqualTo: (value: FieldValue) => T;
618
+ lessThan: (value: FieldValue) => T;
619
+ lessThanOrEqualTo: (value: FieldValue) => T;
620
+ _: (name: string, value: any) => T;
621
+ }
622
+ const visit: <T>(value: FieldFilter, visitor: Visitor<T>) => T;
623
+ }
624
+ export declare enum Order {
625
+ ASCENDING = "Asc",
626
+ DESCENDING = "Desc"
627
+ }
628
+ /**
629
+ * <p>A structured set of sort terms.</p>
630
+ */
631
+ export interface Sort {
632
+ /**
633
+ * <p>Unique identifier of a field.</p>
634
+ */
635
+ fieldId: string | undefined;
636
+ /**
637
+ * <p>A structured set of sort terms</p>
638
+ */
639
+ sortOrder: Order | string | undefined;
640
+ }
641
+ /**
642
+ * <p>A list of items that represent cases.</p>
643
+ */
644
+ export interface SearchCasesResponseItem {
645
+ /**
646
+ * <p>A unique identifier of the case.</p>
647
+ */
648
+ caseId: string | undefined;
649
+ /**
650
+ * <p>A unique identifier of a template.</p>
651
+ */
652
+ templateId: string | undefined;
653
+ /**
654
+ * <p>List of case field values.</p>
655
+ */
656
+ fields: FieldValue[] | undefined;
657
+ /**
658
+ * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
659
+ */
660
+ tags?: Record<string, string>;
661
+ }
662
+ export interface SearchCasesResponse {
663
+ /**
664
+ * <p>The token for the next set of results. This is null if there are no more results to return.</p>
665
+ */
666
+ nextToken?: string;
667
+ /**
668
+ * <p>A list of case documents where each case contains the properties <code>CaseId</code> and
669
+ * <code>Fields</code> where each field is a complex union structure. </p>
670
+ */
671
+ cases: SearchCasesResponseItem[] | undefined;
672
+ }
673
+ export interface UpdateCaseRequest {
674
+ /**
675
+ * <p>The unique identifier of the Cases domain. </p>
676
+ */
677
+ domainId: string | undefined;
678
+ /**
679
+ * <p>A unique identifier of the case.</p>
680
+ */
681
+ caseId: string | undefined;
682
+ /**
683
+ * <p>An array of objects with <code>fieldId</code> (matching ListFields/DescribeField) and
684
+ * value union data, structured identical to <code>CreateCase</code>.</p>
685
+ */
686
+ fields: FieldValue[] | undefined;
687
+ }
688
+ export interface UpdateCaseResponse {
689
+ }
690
+ export interface CreateDomainRequest {
691
+ /**
692
+ * <p>The name for your Cases domain. It must be unique for your Amazon Web Services
693
+ * account.</p>
694
+ */
695
+ name: string | undefined;
696
+ }
697
+ export declare enum DomainStatus {
698
+ ACTIVE = "Active",
699
+ CREATION_FAILED = "CreationFailed",
700
+ CREATION_IN_PROGRESS = "CreationInProgress"
701
+ }
702
+ export interface CreateDomainResponse {
703
+ /**
704
+ * <p>The unique identifier of the Cases domain. </p>
705
+ */
706
+ domainId: string | undefined;
707
+ /**
708
+ * <p>The Amazon Resource Name (ARN) for the Cases domain.</p>
709
+ */
710
+ domainArn: string | undefined;
711
+ /**
712
+ * <p>The status of the domain.</p>
713
+ */
714
+ domainStatus: DomainStatus | string | undefined;
715
+ }
716
+ export interface GetCaseEventConfigurationRequest {
717
+ /**
718
+ * <p>The unique identifier of the Cases domain. </p>
719
+ */
720
+ domainId: string | undefined;
721
+ }
722
+ /**
723
+ * <p>Details of what case data is published through the case event stream.</p>
724
+ */
725
+ export interface CaseEventIncludedData {
726
+ /**
727
+ * <p>List of field identifiers.</p>
728
+ */
729
+ fields: FieldIdentifier[] | undefined;
730
+ }
731
+ /**
732
+ * <p>Details of what related item data is published through the case event stream.</p>
733
+ */
734
+ export interface RelatedItemEventIncludedData {
735
+ /**
736
+ * <p>Details of what related item data is published through the case event stream.</p>
737
+ */
738
+ includeContent: boolean | undefined;
739
+ }
740
+ /**
741
+ * <p>Details of what case and related item data is published through the case event
742
+ * stream.</p>
743
+ */
744
+ export interface EventIncludedData {
745
+ /**
746
+ * <p>Details of what case data is published through the case event stream.</p>
747
+ */
748
+ caseData?: CaseEventIncludedData;
749
+ /**
750
+ * <p>Details of what related item data is published through the case event stream.</p>
751
+ */
752
+ relatedItemData?: RelatedItemEventIncludedData;
753
+ }
754
+ /**
755
+ * <p>Configuration to enable EventBridge case event delivery and determine what data is
756
+ * delivered.</p>
757
+ */
758
+ export interface EventBridgeConfiguration {
759
+ /**
760
+ * <p>Indicates whether the to broadcast case event data to the customer.</p>
761
+ */
762
+ enabled: boolean | undefined;
763
+ /**
764
+ * <p>Details of what case and related item data is published through the case event
765
+ * stream.</p>
766
+ */
767
+ includedData?: EventIncludedData;
768
+ }
769
+ export interface GetCaseEventConfigurationResponse {
770
+ /**
771
+ * <p>Configuration to enable EventBridge case event delivery and determine what data is
772
+ * delivered.</p>
773
+ */
774
+ eventBridge: EventBridgeConfiguration | undefined;
775
+ }
776
+ export interface GetDomainRequest {
777
+ /**
778
+ * <p>The unique identifier of the Cases domain. </p>
779
+ */
780
+ domainId: string | undefined;
781
+ }
782
+ export interface GetDomainResponse {
783
+ /**
784
+ * <p>The unique identifier of the Cases domain. </p>
785
+ */
786
+ domainId: string | undefined;
787
+ /**
788
+ * <p>The Amazon Resource Name (ARN) for the Cases domain.</p>
789
+ */
790
+ domainArn: string | undefined;
791
+ /**
792
+ * <p>The name of the Cases domain.</p>
793
+ */
794
+ name: string | undefined;
795
+ /**
796
+ * <p>The timestamp when the Cases domain was created.</p>
797
+ */
798
+ createdTime: Date | undefined;
799
+ /**
800
+ * <p>The status of the Cases domain.</p>
801
+ */
802
+ domainStatus: DomainStatus | string | undefined;
803
+ /**
804
+ * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
805
+ */
806
+ tags?: Record<string, string>;
807
+ }
808
+ export interface ListDomainsRequest {
809
+ /**
810
+ * <p>The maximum number of results to return per page.</p>
811
+ */
812
+ maxResults?: number;
813
+ /**
814
+ * <p>The token for the next set of results. Use the value returned in the previous
815
+ * response in the next request to retrieve the next set of results.</p>
816
+ */
817
+ nextToken?: string;
818
+ }
819
+ /**
820
+ * <p>Object for the summarized details of the domain.</p>
821
+ */
822
+ export interface DomainSummary {
823
+ /**
824
+ * <p>The unique identifier of the domain.</p>
825
+ */
826
+ domainId: string | undefined;
827
+ /**
828
+ * <p>The Amazon Resource Name (ARN) of the domain.</p>
829
+ */
830
+ domainArn: string | undefined;
831
+ /**
832
+ * <p>The name of the domain.</p>
833
+ */
834
+ name: string | undefined;
835
+ }
836
+ export interface ListDomainsResponse {
837
+ /**
838
+ * <p>The Cases domain.</p>
839
+ */
840
+ domains: DomainSummary[] | undefined;
841
+ /**
842
+ * <p>The token for the next set of results. This is null if there are no more results to return.</p>
843
+ */
844
+ nextToken?: string;
845
+ }
846
+ export interface PutCaseEventConfigurationRequest {
847
+ /**
848
+ * <p>The unique identifier of the Cases domain. </p>
849
+ */
850
+ domainId: string | undefined;
851
+ /**
852
+ * <p>Configuration to enable EventBridge case event delivery and determine what data is
853
+ * delivered.</p>
854
+ */
855
+ eventBridge: EventBridgeConfiguration | undefined;
856
+ }
857
+ export interface PutCaseEventConfigurationResponse {
858
+ }
859
+ export interface BatchGetFieldRequest {
860
+ /**
861
+ * <p>The unique identifier of the Cases domain. </p>
862
+ */
863
+ domainId: string | undefined;
864
+ /**
865
+ * <p>A list of unique field identifiers. </p>
866
+ */
867
+ fields: FieldIdentifier[] | undefined;
868
+ }
869
+ /**
870
+ * <p>Object for errors on fields.</p>
871
+ */
872
+ export interface FieldError {
873
+ /**
874
+ * <p>The field identifier that caused the error.</p>
875
+ */
876
+ id: string | undefined;
877
+ /**
878
+ * <p>The error code from getting a field.</p>
879
+ */
880
+ errorCode: string | undefined;
881
+ /**
882
+ * <p>The error message from getting a field.</p>
883
+ */
884
+ message?: string;
885
+ }
886
+ export declare enum FieldNamespace {
887
+ CUSTOM = "Custom",
888
+ SYSTEM = "System"
889
+ }
890
+ export declare enum FieldType {
891
+ BOOLEAN = "Boolean",
892
+ DATE_TIME = "DateTime",
893
+ NUMBER = "Number",
894
+ SINGLE_SELECT = "SingleSelect",
895
+ TEXT = "Text"
896
+ }
897
+ /**
898
+ * <p>Object to store detailed field information.</p>
899
+ */
900
+ export interface GetFieldResponse {
901
+ /**
902
+ * <p>Unique identifier of the field.</p>
903
+ */
904
+ fieldId: string | undefined;
905
+ /**
906
+ * <p>Name of the field.</p>
907
+ */
908
+ name: string | undefined;
909
+ /**
910
+ * <p>The Amazon Resource Name (ARN) of the field.</p>
911
+ */
912
+ fieldArn: string | undefined;
913
+ /**
914
+ * <p>Description of the field.</p>
915
+ */
916
+ description?: string;
917
+ /**
918
+ * <p>Type of the field.</p>
919
+ */
920
+ type: FieldType | string | undefined;
921
+ /**
922
+ * <p>Namespace of the field.</p>
923
+ */
924
+ namespace: FieldNamespace | string | undefined;
925
+ /**
926
+ * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
927
+ */
928
+ tags?: Record<string, string>;
929
+ }
930
+ export interface BatchGetFieldResponse {
931
+ /**
932
+ * <p>A list of detailed field information. </p>
933
+ */
934
+ fields: GetFieldResponse[] | undefined;
935
+ /**
936
+ * <p>A list of field errors. </p>
937
+ */
938
+ errors: FieldError[] | undefined;
939
+ }
940
+ /**
941
+ * <p>Object for field Options information.</p>
942
+ */
943
+ export interface FieldOption {
944
+ /**
945
+ * <p>
946
+ * <code>FieldOptionName</code> has max length 100 and disallows trailing spaces.</p>
947
+ */
948
+ name: string | undefined;
949
+ /**
950
+ * <p>
951
+ * <code>FieldOptionValue</code> has max length 100 and must be alphanumeric with hyphens and
952
+ * underscores.</p>
953
+ */
954
+ value: string | undefined;
955
+ /**
956
+ * <p>Describes whether the <code>FieldOption</code> is active (displayed) or inactive.</p>
957
+ */
958
+ active: boolean | undefined;
959
+ }
960
+ export interface BatchPutFieldOptionsRequest {
961
+ /**
962
+ * <p>The unique identifier of the Cases domain. </p>
963
+ */
964
+ domainId: string | undefined;
965
+ /**
966
+ * <p>The unique identifier of a field.</p>
967
+ */
968
+ fieldId: string | undefined;
969
+ /**
970
+ * <p>A list of <code>FieldOption</code> objects.</p>
971
+ */
972
+ options: FieldOption[] | undefined;
973
+ }
974
+ /**
975
+ * <p>Object for field Options errors.</p>
976
+ */
977
+ export interface FieldOptionError {
978
+ /**
979
+ * <p>Error message from creating or updating field option.</p>
980
+ */
981
+ message: string | undefined;
982
+ /**
983
+ * <p>Error code from creating or updating field option.</p>
984
+ */
985
+ errorCode: string | undefined;
986
+ /**
987
+ * <p>The field option value that caused the error.</p>
988
+ */
989
+ value: string | undefined;
990
+ }
991
+ export interface BatchPutFieldOptionsResponse {
992
+ /**
993
+ * <p>A list of field errors. </p>
994
+ */
995
+ errors?: FieldOptionError[];
996
+ }
997
+ export interface CreateFieldRequest {
998
+ /**
999
+ * <p>The unique identifier of the Cases domain. </p>
1000
+ */
1001
+ domainId: string | undefined;
1002
+ /**
1003
+ * <p>The name of the field.</p>
1004
+ */
1005
+ name: string | undefined;
1006
+ /**
1007
+ * <p>Defines the data type, some system constraints, and default display of the field.</p>
1008
+ */
1009
+ type: FieldType | string | undefined;
1010
+ /**
1011
+ * <p>The description of the field.</p>
1012
+ */
1013
+ description?: string;
1014
+ }
1015
+ export interface CreateFieldResponse {
1016
+ /**
1017
+ * <p>The unique identifier of a field.</p>
1018
+ */
1019
+ fieldId: string | undefined;
1020
+ /**
1021
+ * <p>The Amazon Resource Name (ARN) of the field.</p>
1022
+ */
1023
+ fieldArn: string | undefined;
1024
+ }
1025
+ export interface ListFieldOptionsRequest {
1026
+ /**
1027
+ * <p>The unique identifier of the Cases domain. </p>
1028
+ */
1029
+ domainId: string | undefined;
1030
+ /**
1031
+ * <p>The unique identifier of a field.</p>
1032
+ */
1033
+ fieldId: string | undefined;
1034
+ /**
1035
+ * <p>The maximum number of results to return per page.</p>
1036
+ */
1037
+ maxResults?: number;
1038
+ /**
1039
+ * <p>The token for the next set of results. Use the value returned in the previous
1040
+ * response in the next request to retrieve the next set of results.</p>
1041
+ */
1042
+ nextToken?: string;
1043
+ /**
1044
+ * <p>A list of <code>FieldOption</code> values to filter on for
1045
+ * <code>ListFieldOptions</code>.</p>
1046
+ */
1047
+ values?: string[];
1048
+ }
1049
+ export interface ListFieldOptionsResponse {
1050
+ /**
1051
+ * <p>A list of <code>FieldOption</code> objects.</p>
1052
+ */
1053
+ options: FieldOption[] | undefined;
1054
+ /**
1055
+ * <p>The token for the next set of results. This is null if there are no more results to return.</p>
1056
+ */
1057
+ nextToken?: string;
1058
+ }
1059
+ export interface ListFieldsRequest {
1060
+ /**
1061
+ * <p>The unique identifier of the Cases domain. </p>
1062
+ */
1063
+ domainId: string | undefined;
1064
+ /**
1065
+ * <p>The maximum number of results to return per page.</p>
1066
+ */
1067
+ maxResults?: number;
1068
+ /**
1069
+ * <p>The token for the next set of results. Use the value returned in the previous
1070
+ * response in the next request to retrieve the next set of results.</p>
1071
+ */
1072
+ nextToken?: string;
1073
+ }
1074
+ /**
1075
+ * <p>Object for the summarized details of the field.</p>
1076
+ */
1077
+ export interface FieldSummary {
1078
+ /**
1079
+ * <p>The unique identifier of a field.</p>
1080
+ */
1081
+ fieldId: string | undefined;
1082
+ /**
1083
+ * <p>The Amazon Resource Name (ARN) of the field.</p>
1084
+ */
1085
+ fieldArn: string | undefined;
1086
+ /**
1087
+ * <p>Name of the field.</p>
1088
+ */
1089
+ name: string | undefined;
1090
+ /**
1091
+ * <p>The type of a field.</p>
1092
+ */
1093
+ type: FieldType | string | undefined;
1094
+ /**
1095
+ * <p>The namespace of a field.</p>
1096
+ */
1097
+ namespace: FieldNamespace | string | undefined;
1098
+ }
1099
+ export interface ListFieldsResponse {
1100
+ /**
1101
+ * <p>List of detailed field information.</p>
1102
+ */
1103
+ fields: FieldSummary[] | undefined;
1104
+ /**
1105
+ * <p>The token for the next set of results. This is null if there are no more results to return.</p>
1106
+ */
1107
+ nextToken?: string;
1108
+ }
1109
+ export interface UpdateFieldRequest {
1110
+ /**
1111
+ * <p>The unique identifier of the Cases domain. </p>
1112
+ */
1113
+ domainId: string | undefined;
1114
+ /**
1115
+ * <p>The unique identifier of a field.</p>
1116
+ */
1117
+ fieldId: string | undefined;
1118
+ /**
1119
+ * <p>The name of the field.</p>
1120
+ */
1121
+ name?: string;
1122
+ /**
1123
+ * <p>The description of a field.</p>
1124
+ */
1125
+ description?: string;
1126
+ }
1127
+ export interface UpdateFieldResponse {
1128
+ }
1129
+ /**
1130
+ * <p>Object for field related information.</p>
1131
+ */
1132
+ export interface FieldItem {
1133
+ /**
1134
+ * <p>Unique identifier of a field.</p>
1135
+ */
1136
+ id: string | undefined;
1137
+ }
1138
+ /**
1139
+ * <p>Object for a group of fields and associated properties.</p>
1140
+ */
1141
+ export interface FieldGroup {
1142
+ /**
1143
+ * <p>Name of the field group.</p>
1144
+ */
1145
+ name?: string;
1146
+ /**
1147
+ * <p>Represents an ordered list containing field related information.</p>
1148
+ */
1149
+ fields: FieldItem[] | undefined;
1150
+ }
1151
+ /**
1152
+ * <p>This represents a sections within a panel or tab of the page layout.</p>
1153
+ */
1154
+ export declare type Section = Section.FieldGroupMember | Section.$UnknownMember;
1155
+ export declare namespace Section {
1156
+ /**
1157
+ * <p>Consists of a group of fields and associated properties.</p>
1158
+ */
1159
+ interface FieldGroupMember {
1160
+ fieldGroup: FieldGroup;
1161
+ $unknown?: never;
1162
+ }
1163
+ interface $UnknownMember {
1164
+ fieldGroup?: never;
1165
+ $unknown: [string, any];
1166
+ }
1167
+ interface Visitor<T> {
1168
+ fieldGroup: (value: FieldGroup) => T;
1169
+ _: (name: string, value: any) => T;
1170
+ }
1171
+ const visit: <T>(value: Section, visitor: Visitor<T>) => T;
1172
+ }
1173
+ /**
1174
+ * <p>Ordered list containing different kinds of sections that can be added. A LayoutSections object can only contain one section.</p>
1175
+ */
1176
+ export interface LayoutSections {
1177
+ /**
1178
+ * <p>Ordered list containing different kinds of sections that can be added.</p>
1179
+ */
1180
+ sections?: Section[];
1181
+ }
1182
+ /**
1183
+ * <p>Content specific to <code>BasicLayout</code> type. It configures fields in the top panel
1184
+ * and More Info tab of agent application. </p>
1185
+ */
1186
+ export interface BasicLayout {
1187
+ /**
1188
+ * <p>This represents sections in a panel of the page layout.</p>
1189
+ */
1190
+ topPanel?: LayoutSections;
1191
+ /**
1192
+ * <p>This represents sections in a tab of the page layout.</p>
1193
+ */
1194
+ moreInfo?: LayoutSections;
1195
+ }
1196
+ /**
1197
+ * <p>Object to store union of different versions of layout content.</p>
1198
+ */
1199
+ export declare type LayoutContent = LayoutContent.BasicMember | LayoutContent.$UnknownMember;
1200
+ export declare namespace LayoutContent {
1201
+ /**
1202
+ * <p>Content specific to <code>BasicLayout</code> type. It configures fields in the top panel
1203
+ * and More Info tab of Cases user interface.</p>
1204
+ */
1205
+ interface BasicMember {
1206
+ basic: BasicLayout;
1207
+ $unknown?: never;
1208
+ }
1209
+ interface $UnknownMember {
1210
+ basic?: never;
1211
+ $unknown: [string, any];
1212
+ }
1213
+ interface Visitor<T> {
1214
+ basic: (value: BasicLayout) => T;
1215
+ _: (name: string, value: any) => T;
1216
+ }
1217
+ const visit: <T>(value: LayoutContent, visitor: Visitor<T>) => T;
1218
+ }
1219
+ export interface CreateLayoutRequest {
1220
+ /**
1221
+ * <p>The unique identifier of the Cases domain. </p>
1222
+ */
1223
+ domainId: string | undefined;
1224
+ /**
1225
+ * <p>The name of the layout. It must be unique for the Cases domain.</p>
1226
+ */
1227
+ name: string | undefined;
1228
+ /**
1229
+ * <p>Information about which fields will be present in the layout, and information about the
1230
+ * order of the fields.</p>
1231
+ */
1232
+ content: LayoutContent | undefined;
1233
+ }
1234
+ export interface CreateLayoutResponse {
1235
+ /**
1236
+ * <p>The unique identifier of the layout.</p>
1237
+ */
1238
+ layoutId: string | undefined;
1239
+ /**
1240
+ * <p>The Amazon Resource Name (ARN) of the newly created layout.</p>
1241
+ */
1242
+ layoutArn: string | undefined;
1243
+ }
1244
+ export interface GetLayoutRequest {
1245
+ /**
1246
+ * <p>The unique identifier of the Cases domain. </p>
1247
+ */
1248
+ domainId: string | undefined;
1249
+ /**
1250
+ * <p>The unique identifier of the layout.</p>
1251
+ */
1252
+ layoutId: string | undefined;
1253
+ }
1254
+ export interface GetLayoutResponse {
1255
+ /**
1256
+ * <p>The unique identifier of the layout.</p>
1257
+ */
1258
+ layoutId: string | undefined;
1259
+ /**
1260
+ * <p>The Amazon Resource Name (ARN) of the newly created layout.</p>
1261
+ */
1262
+ layoutArn: string | undefined;
1263
+ /**
1264
+ * <p>The name of the layout. It must be unique.</p>
1265
+ */
1266
+ name: string | undefined;
1267
+ /**
1268
+ * <p>Information about which fields will be present in the layout, the order of the fields, and
1269
+ * read-only attribute of the field. </p>
1270
+ */
1271
+ content: LayoutContent | undefined;
1272
+ /**
1273
+ * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
1274
+ */
1275
+ tags?: Record<string, string>;
1276
+ }
1277
+ export interface ListLayoutsRequest {
1278
+ /**
1279
+ * <p>The unique identifier of the Cases domain. </p>
1280
+ */
1281
+ domainId: string | undefined;
1282
+ /**
1283
+ * <p>The maximum number of results to return per page.</p>
1284
+ */
1285
+ maxResults?: number;
1286
+ /**
1287
+ * <p>The token for the next set of results. Use the value returned in the previous
1288
+ * response in the next request to retrieve the next set of results.</p>
1289
+ */
1290
+ nextToken?: string;
1291
+ }
1292
+ /**
1293
+ * <p>Object for the summarized details of the layout.</p>
1294
+ */
1295
+ export interface LayoutSummary {
1296
+ /**
1297
+ * <p>The unique identifier for of the layout.</p>
1298
+ */
1299
+ layoutId: string | undefined;
1300
+ /**
1301
+ * <p>The Amazon Resource Name (ARN) of the layout.</p>
1302
+ */
1303
+ layoutArn: string | undefined;
1304
+ /**
1305
+ * <p>The name of the layout.</p>
1306
+ */
1307
+ name: string | undefined;
1308
+ }
1309
+ export interface ListLayoutsResponse {
1310
+ /**
1311
+ * <p>The layouts for the domain.</p>
1312
+ */
1313
+ layouts: LayoutSummary[] | undefined;
1314
+ /**
1315
+ * <p>The token for the next set of results. This is null if there are no more results to return.</p>
1316
+ */
1317
+ nextToken?: string;
1318
+ }
1319
+ export interface UpdateLayoutRequest {
1320
+ /**
1321
+ * <p>The unique identifier of the Cases domain. </p>
1322
+ */
1323
+ domainId: string | undefined;
1324
+ /**
1325
+ * <p>The unique identifier of the layout.</p>
1326
+ */
1327
+ layoutId: string | undefined;
1328
+ /**
1329
+ * <p>The name of the layout. It must be unique per domain.</p>
1330
+ */
1331
+ name?: string;
1332
+ /**
1333
+ * <p>Information about which fields will be present in the layout, the order of the fields, and
1334
+ * a read-only attribute of the field. </p>
1335
+ */
1336
+ content?: LayoutContent;
1337
+ }
1338
+ export interface UpdateLayoutResponse {
1339
+ }
1340
+ export interface ListTagsForResourceRequest {
1341
+ /**
1342
+ * <p>The Amazon Resource Name (ARN)</p>
1343
+ */
1344
+ arn: string | undefined;
1345
+ }
1346
+ export interface ListTagsForResourceResponse {
1347
+ /**
1348
+ * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
1349
+ */
1350
+ tags?: Record<string, string>;
1351
+ }
1352
+ export interface TagResourceRequest {
1353
+ /**
1354
+ * <p>The Amazon Resource Name (ARN)</p>
1355
+ */
1356
+ arn: string | undefined;
1357
+ /**
1358
+ * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
1359
+ */
1360
+ tags: Record<string, string> | undefined;
1361
+ }
1362
+ /**
1363
+ * <p>Object to store configuration of layouts associated to the template.</p>
1364
+ */
1365
+ export interface LayoutConfiguration {
1366
+ /**
1367
+ * <p> Unique identifier of a layout. </p>
1368
+ */
1369
+ defaultLayout?: string;
1370
+ }
1371
+ /**
1372
+ * <p>List of fields that must have a value provided to create a case.</p>
1373
+ */
1374
+ export interface RequiredField {
1375
+ /**
1376
+ * <p>Unique identifier of a field.</p>
1377
+ */
1378
+ fieldId: string | undefined;
1379
+ }
1380
+ export interface CreateTemplateRequest {
1381
+ /**
1382
+ * <p>The unique identifier of the Cases domain. </p>
1383
+ */
1384
+ domainId: string | undefined;
1385
+ /**
1386
+ * <p>A name for the template. It must be unique per domain.</p>
1387
+ */
1388
+ name: string | undefined;
1389
+ /**
1390
+ * <p>A brief description of the template.</p>
1391
+ */
1392
+ description?: string;
1393
+ /**
1394
+ * <p>Configuration of layouts associated to the template.</p>
1395
+ */
1396
+ layoutConfiguration?: LayoutConfiguration;
1397
+ /**
1398
+ * <p>A list of fields that must contain a value for a case to be successfully created with this
1399
+ * template.</p>
1400
+ */
1401
+ requiredFields?: RequiredField[];
1402
+ }
1403
+ export interface CreateTemplateResponse {
1404
+ /**
1405
+ * <p>A unique identifier of a template.</p>
1406
+ */
1407
+ templateId: string | undefined;
1408
+ /**
1409
+ * <p>The Amazon Resource Name (ARN) of the newly created template.</p>
1410
+ */
1411
+ templateArn: string | undefined;
1412
+ }
1413
+ export interface GetTemplateRequest {
1414
+ /**
1415
+ * <p>The unique identifier of the Cases domain. </p>
1416
+ */
1417
+ domainId: string | undefined;
1418
+ /**
1419
+ * <p>A unique identifier of a template.</p>
1420
+ */
1421
+ templateId: string | undefined;
1422
+ }
1423
+ export interface GetTemplateResponse {
1424
+ /**
1425
+ * <p>A unique identifier of a template.</p>
1426
+ */
1427
+ templateId: string | undefined;
1428
+ /**
1429
+ * <p>The Amazon Resource Name (ARN) of the template.</p>
1430
+ */
1431
+ templateArn: string | undefined;
1432
+ /**
1433
+ * <p>The name of the template.</p>
1434
+ */
1435
+ name: string | undefined;
1436
+ /**
1437
+ * <p>A brief description of the template.</p>
1438
+ */
1439
+ description?: string;
1440
+ /**
1441
+ * <p>Configuration of layouts associated to the template.</p>
1442
+ */
1443
+ layoutConfiguration?: LayoutConfiguration;
1444
+ /**
1445
+ * <p>A list of fields that must contain a value for a case to be successfully created with this
1446
+ * template.</p>
1447
+ */
1448
+ requiredFields?: RequiredField[];
1449
+ /**
1450
+ * <p>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</p>
1451
+ */
1452
+ tags?: Record<string, string>;
1453
+ }
1454
+ export interface ListTemplatesRequest {
1455
+ /**
1456
+ * <p>The unique identifier of the Cases domain. </p>
1457
+ */
1458
+ domainId: string | undefined;
1459
+ /**
1460
+ * <p>The maximum number of results to return per page.</p>
1461
+ */
1462
+ maxResults?: number;
1463
+ /**
1464
+ * <p>The token for the next set of results. Use the value returned in the previous
1465
+ * response in the next request to retrieve the next set of results.</p>
1466
+ */
1467
+ nextToken?: string;
1468
+ }
1469
+ /**
1470
+ * <p>Template summary information.</p>
1471
+ */
1472
+ export interface TemplateSummary {
1473
+ /**
1474
+ * <p>The unique identifier for the template.</p>
1475
+ */
1476
+ templateId: string | undefined;
1477
+ /**
1478
+ * <p>The Amazon Resource Name (ARN) of the template.</p>
1479
+ */
1480
+ templateArn: string | undefined;
1481
+ /**
1482
+ * <p>The template name.</p>
1483
+ */
1484
+ name: string | undefined;
1485
+ }
1486
+ export interface ListTemplatesResponse {
1487
+ /**
1488
+ * <p>List of template summary objects.</p>
1489
+ */
1490
+ templates: TemplateSummary[] | undefined;
1491
+ /**
1492
+ * <p>The token for the next set of results. This is null if there are no more results to return.</p>
1493
+ */
1494
+ nextToken?: string;
1495
+ }
1496
+ export interface UpdateTemplateRequest {
1497
+ /**
1498
+ * <p>The unique identifier of the Cases domain. </p>
1499
+ */
1500
+ domainId: string | undefined;
1501
+ /**
1502
+ * <p>A unique identifier for the template.</p>
1503
+ */
1504
+ templateId: string | undefined;
1505
+ /**
1506
+ * <p>The name of the template. It must be unique per domain.</p>
1507
+ */
1508
+ name?: string;
1509
+ /**
1510
+ * <p>A brief description of the template.</p>
1511
+ */
1512
+ description?: string;
1513
+ /**
1514
+ * <p>Configuration of layouts associated to the template.</p>
1515
+ */
1516
+ layoutConfiguration?: LayoutConfiguration;
1517
+ /**
1518
+ * <p>A list of fields that must contain a value for a case to be successfully created with this
1519
+ * template.</p>
1520
+ */
1521
+ requiredFields?: RequiredField[];
1522
+ }
1523
+ export interface UpdateTemplateResponse {
1524
+ }
1525
+ export interface UntagResourceRequest {
1526
+ /**
1527
+ * <p>The Amazon Resource Name (ARN)</p>
1528
+ */
1529
+ arn: string | undefined;
1530
+ /**
1531
+ * <p>List of tag keys.</p>
1532
+ */
1533
+ tagKeys: string[] | undefined;
1534
+ }
1535
+ /**
1536
+ * <p>A filter for cases. Only one value can be provided.</p>
1537
+ */
1538
+ export declare type CaseFilter = CaseFilter.AndAllMember | CaseFilter.FieldMember | CaseFilter.NotMember | CaseFilter.$UnknownMember;
1539
+ export declare namespace CaseFilter {
1540
+ /**
1541
+ * <p>A list of fields to filter on.</p>
1542
+ */
1543
+ interface FieldMember {
1544
+ field: FieldFilter;
1545
+ not?: never;
1546
+ andAll?: never;
1547
+ $unknown?: never;
1548
+ }
1549
+ /**
1550
+ * <p>A filter for cases. Only one value can be provided.</p>
1551
+ */
1552
+ interface NotMember {
1553
+ field?: never;
1554
+ not: CaseFilter;
1555
+ andAll?: never;
1556
+ $unknown?: never;
1557
+ }
1558
+ /**
1559
+ * <p>Provides "and all" filtering.</p>
1560
+ */
1561
+ interface AndAllMember {
1562
+ field?: never;
1563
+ not?: never;
1564
+ andAll: CaseFilter[];
1565
+ $unknown?: never;
1566
+ }
1567
+ interface $UnknownMember {
1568
+ field?: never;
1569
+ not?: never;
1570
+ andAll?: never;
1571
+ $unknown: [string, any];
1572
+ }
1573
+ interface Visitor<T> {
1574
+ field: (value: FieldFilter) => T;
1575
+ not: (value: CaseFilter) => T;
1576
+ andAll: (value: CaseFilter[]) => T;
1577
+ _: (name: string, value: any) => T;
1578
+ }
1579
+ const visit: <T>(value: CaseFilter, visitor: Visitor<T>) => T;
1580
+ }
1581
+ export interface SearchCasesRequest {
1582
+ /**
1583
+ * <p>The unique identifier of the Cases domain. </p>
1584
+ */
1585
+ domainId: string | undefined;
1586
+ /**
1587
+ * <p>The maximum number of cases to return. The current maximum supported value is 25. This is
1588
+ * also the default value when no other value is provided.</p>
1589
+ */
1590
+ maxResults?: number;
1591
+ /**
1592
+ * <p>The token for the next set of results. Use the value returned in the previous
1593
+ * response in the next request to retrieve the next set of results.</p>
1594
+ */
1595
+ nextToken?: string;
1596
+ /**
1597
+ * <p>A word or phrase used to perform a quick search.</p>
1598
+ */
1599
+ searchTerm?: string;
1600
+ /**
1601
+ * <p>A list of filter objects.</p>
1602
+ */
1603
+ filter?: CaseFilter;
1604
+ /**
1605
+ * <p>A list of sorts where each sort specifies a field and their sort order to be applied to
1606
+ * the results. </p>
1607
+ */
1608
+ sorts?: Sort[];
1609
+ /**
1610
+ * <p>The list of field identifiers to be returned as part of the response.</p>
1611
+ */
1612
+ fields?: FieldIdentifier[];
1613
+ }
1614
+ /**
1615
+ * @internal
1616
+ */
1617
+ export declare const FieldValueUnionFilterSensitiveLog: (obj: FieldValueUnion) => any;
1618
+ /**
1619
+ * @internal
1620
+ */
1621
+ export declare const FieldValueFilterSensitiveLog: (obj: FieldValue) => any;
1622
+ /**
1623
+ * @internal
1624
+ */
1625
+ export declare const CreateCaseRequestFilterSensitiveLog: (obj: CreateCaseRequest) => any;
1626
+ /**
1627
+ * @internal
1628
+ */
1629
+ export declare const CreateCaseResponseFilterSensitiveLog: (obj: CreateCaseResponse) => any;
1630
+ /**
1631
+ * @internal
1632
+ */
1633
+ export declare const FieldIdentifierFilterSensitiveLog: (obj: FieldIdentifier) => any;
1634
+ /**
1635
+ * @internal
1636
+ */
1637
+ export declare const GetCaseRequestFilterSensitiveLog: (obj: GetCaseRequest) => any;
1638
+ /**
1639
+ * @internal
1640
+ */
1641
+ export declare const GetCaseResponseFilterSensitiveLog: (obj: GetCaseResponse) => any;
1642
+ /**
1643
+ * @internal
1644
+ */
1645
+ export declare const ListCasesForContactRequestFilterSensitiveLog: (obj: ListCasesForContactRequest) => any;
1646
+ /**
1647
+ * @internal
1648
+ */
1649
+ export declare const CaseSummaryFilterSensitiveLog: (obj: CaseSummary) => any;
1650
+ /**
1651
+ * @internal
1652
+ */
1653
+ export declare const ListCasesForContactResponseFilterSensitiveLog: (obj: ListCasesForContactResponse) => any;
1654
+ /**
1655
+ * @internal
1656
+ */
1657
+ export declare const CommentContentFilterSensitiveLog: (obj: CommentContent) => any;
1658
+ /**
1659
+ * @internal
1660
+ */
1661
+ export declare const ContactFilterSensitiveLog: (obj: Contact) => any;
1662
+ /**
1663
+ * @internal
1664
+ */
1665
+ export declare const RelatedItemInputContentFilterSensitiveLog: (obj: RelatedItemInputContent) => any;
1666
+ /**
1667
+ * @internal
1668
+ */
1669
+ export declare const CreateRelatedItemRequestFilterSensitiveLog: (obj: CreateRelatedItemRequest) => any;
1670
+ /**
1671
+ * @internal
1672
+ */
1673
+ export declare const CreateRelatedItemResponseFilterSensitiveLog: (obj: CreateRelatedItemResponse) => any;
1674
+ /**
1675
+ * @internal
1676
+ */
1677
+ export declare const CommentFilterFilterSensitiveLog: (obj: CommentFilter) => any;
1678
+ /**
1679
+ * @internal
1680
+ */
1681
+ export declare const ContactFilterFilterSensitiveLog: (obj: ContactFilter) => any;
1682
+ /**
1683
+ * @internal
1684
+ */
1685
+ export declare const RelatedItemTypeFilterFilterSensitiveLog: (obj: RelatedItemTypeFilter) => any;
1686
+ /**
1687
+ * @internal
1688
+ */
1689
+ export declare const SearchRelatedItemsRequestFilterSensitiveLog: (obj: SearchRelatedItemsRequest) => any;
1690
+ /**
1691
+ * @internal
1692
+ */
1693
+ export declare const ContactContentFilterSensitiveLog: (obj: ContactContent) => any;
1694
+ /**
1695
+ * @internal
1696
+ */
1697
+ export declare const RelatedItemContentFilterSensitiveLog: (obj: RelatedItemContent) => any;
1698
+ /**
1699
+ * @internal
1700
+ */
1701
+ export declare const SearchRelatedItemsResponseItemFilterSensitiveLog: (obj: SearchRelatedItemsResponseItem) => any;
1702
+ /**
1703
+ * @internal
1704
+ */
1705
+ export declare const SearchRelatedItemsResponseFilterSensitiveLog: (obj: SearchRelatedItemsResponse) => any;
1706
+ /**
1707
+ * @internal
1708
+ */
1709
+ export declare const FieldFilterFilterSensitiveLog: (obj: FieldFilter) => any;
1710
+ /**
1711
+ * @internal
1712
+ */
1713
+ export declare const SortFilterSensitiveLog: (obj: Sort) => any;
1714
+ /**
1715
+ * @internal
1716
+ */
1717
+ export declare const SearchCasesResponseItemFilterSensitiveLog: (obj: SearchCasesResponseItem) => any;
1718
+ /**
1719
+ * @internal
1720
+ */
1721
+ export declare const SearchCasesResponseFilterSensitiveLog: (obj: SearchCasesResponse) => any;
1722
+ /**
1723
+ * @internal
1724
+ */
1725
+ export declare const UpdateCaseRequestFilterSensitiveLog: (obj: UpdateCaseRequest) => any;
1726
+ /**
1727
+ * @internal
1728
+ */
1729
+ export declare const UpdateCaseResponseFilterSensitiveLog: (obj: UpdateCaseResponse) => any;
1730
+ /**
1731
+ * @internal
1732
+ */
1733
+ export declare const CreateDomainRequestFilterSensitiveLog: (obj: CreateDomainRequest) => any;
1734
+ /**
1735
+ * @internal
1736
+ */
1737
+ export declare const CreateDomainResponseFilterSensitiveLog: (obj: CreateDomainResponse) => any;
1738
+ /**
1739
+ * @internal
1740
+ */
1741
+ export declare const GetCaseEventConfigurationRequestFilterSensitiveLog: (obj: GetCaseEventConfigurationRequest) => any;
1742
+ /**
1743
+ * @internal
1744
+ */
1745
+ export declare const CaseEventIncludedDataFilterSensitiveLog: (obj: CaseEventIncludedData) => any;
1746
+ /**
1747
+ * @internal
1748
+ */
1749
+ export declare const RelatedItemEventIncludedDataFilterSensitiveLog: (obj: RelatedItemEventIncludedData) => any;
1750
+ /**
1751
+ * @internal
1752
+ */
1753
+ export declare const EventIncludedDataFilterSensitiveLog: (obj: EventIncludedData) => any;
1754
+ /**
1755
+ * @internal
1756
+ */
1757
+ export declare const EventBridgeConfigurationFilterSensitiveLog: (obj: EventBridgeConfiguration) => any;
1758
+ /**
1759
+ * @internal
1760
+ */
1761
+ export declare const GetCaseEventConfigurationResponseFilterSensitiveLog: (obj: GetCaseEventConfigurationResponse) => any;
1762
+ /**
1763
+ * @internal
1764
+ */
1765
+ export declare const GetDomainRequestFilterSensitiveLog: (obj: GetDomainRequest) => any;
1766
+ /**
1767
+ * @internal
1768
+ */
1769
+ export declare const GetDomainResponseFilterSensitiveLog: (obj: GetDomainResponse) => any;
1770
+ /**
1771
+ * @internal
1772
+ */
1773
+ export declare const ListDomainsRequestFilterSensitiveLog: (obj: ListDomainsRequest) => any;
1774
+ /**
1775
+ * @internal
1776
+ */
1777
+ export declare const DomainSummaryFilterSensitiveLog: (obj: DomainSummary) => any;
1778
+ /**
1779
+ * @internal
1780
+ */
1781
+ export declare const ListDomainsResponseFilterSensitiveLog: (obj: ListDomainsResponse) => any;
1782
+ /**
1783
+ * @internal
1784
+ */
1785
+ export declare const PutCaseEventConfigurationRequestFilterSensitiveLog: (obj: PutCaseEventConfigurationRequest) => any;
1786
+ /**
1787
+ * @internal
1788
+ */
1789
+ export declare const PutCaseEventConfigurationResponseFilterSensitiveLog: (obj: PutCaseEventConfigurationResponse) => any;
1790
+ /**
1791
+ * @internal
1792
+ */
1793
+ export declare const BatchGetFieldRequestFilterSensitiveLog: (obj: BatchGetFieldRequest) => any;
1794
+ /**
1795
+ * @internal
1796
+ */
1797
+ export declare const FieldErrorFilterSensitiveLog: (obj: FieldError) => any;
1798
+ /**
1799
+ * @internal
1800
+ */
1801
+ export declare const GetFieldResponseFilterSensitiveLog: (obj: GetFieldResponse) => any;
1802
+ /**
1803
+ * @internal
1804
+ */
1805
+ export declare const BatchGetFieldResponseFilterSensitiveLog: (obj: BatchGetFieldResponse) => any;
1806
+ /**
1807
+ * @internal
1808
+ */
1809
+ export declare const FieldOptionFilterSensitiveLog: (obj: FieldOption) => any;
1810
+ /**
1811
+ * @internal
1812
+ */
1813
+ export declare const BatchPutFieldOptionsRequestFilterSensitiveLog: (obj: BatchPutFieldOptionsRequest) => any;
1814
+ /**
1815
+ * @internal
1816
+ */
1817
+ export declare const FieldOptionErrorFilterSensitiveLog: (obj: FieldOptionError) => any;
1818
+ /**
1819
+ * @internal
1820
+ */
1821
+ export declare const BatchPutFieldOptionsResponseFilterSensitiveLog: (obj: BatchPutFieldOptionsResponse) => any;
1822
+ /**
1823
+ * @internal
1824
+ */
1825
+ export declare const CreateFieldRequestFilterSensitiveLog: (obj: CreateFieldRequest) => any;
1826
+ /**
1827
+ * @internal
1828
+ */
1829
+ export declare const CreateFieldResponseFilterSensitiveLog: (obj: CreateFieldResponse) => any;
1830
+ /**
1831
+ * @internal
1832
+ */
1833
+ export declare const ListFieldOptionsRequestFilterSensitiveLog: (obj: ListFieldOptionsRequest) => any;
1834
+ /**
1835
+ * @internal
1836
+ */
1837
+ export declare const ListFieldOptionsResponseFilterSensitiveLog: (obj: ListFieldOptionsResponse) => any;
1838
+ /**
1839
+ * @internal
1840
+ */
1841
+ export declare const ListFieldsRequestFilterSensitiveLog: (obj: ListFieldsRequest) => any;
1842
+ /**
1843
+ * @internal
1844
+ */
1845
+ export declare const FieldSummaryFilterSensitiveLog: (obj: FieldSummary) => any;
1846
+ /**
1847
+ * @internal
1848
+ */
1849
+ export declare const ListFieldsResponseFilterSensitiveLog: (obj: ListFieldsResponse) => any;
1850
+ /**
1851
+ * @internal
1852
+ */
1853
+ export declare const UpdateFieldRequestFilterSensitiveLog: (obj: UpdateFieldRequest) => any;
1854
+ /**
1855
+ * @internal
1856
+ */
1857
+ export declare const UpdateFieldResponseFilterSensitiveLog: (obj: UpdateFieldResponse) => any;
1858
+ /**
1859
+ * @internal
1860
+ */
1861
+ export declare const FieldItemFilterSensitiveLog: (obj: FieldItem) => any;
1862
+ /**
1863
+ * @internal
1864
+ */
1865
+ export declare const FieldGroupFilterSensitiveLog: (obj: FieldGroup) => any;
1866
+ /**
1867
+ * @internal
1868
+ */
1869
+ export declare const SectionFilterSensitiveLog: (obj: Section) => any;
1870
+ /**
1871
+ * @internal
1872
+ */
1873
+ export declare const LayoutSectionsFilterSensitiveLog: (obj: LayoutSections) => any;
1874
+ /**
1875
+ * @internal
1876
+ */
1877
+ export declare const BasicLayoutFilterSensitiveLog: (obj: BasicLayout) => any;
1878
+ /**
1879
+ * @internal
1880
+ */
1881
+ export declare const LayoutContentFilterSensitiveLog: (obj: LayoutContent) => any;
1882
+ /**
1883
+ * @internal
1884
+ */
1885
+ export declare const CreateLayoutRequestFilterSensitiveLog: (obj: CreateLayoutRequest) => any;
1886
+ /**
1887
+ * @internal
1888
+ */
1889
+ export declare const CreateLayoutResponseFilterSensitiveLog: (obj: CreateLayoutResponse) => any;
1890
+ /**
1891
+ * @internal
1892
+ */
1893
+ export declare const GetLayoutRequestFilterSensitiveLog: (obj: GetLayoutRequest) => any;
1894
+ /**
1895
+ * @internal
1896
+ */
1897
+ export declare const GetLayoutResponseFilterSensitiveLog: (obj: GetLayoutResponse) => any;
1898
+ /**
1899
+ * @internal
1900
+ */
1901
+ export declare const ListLayoutsRequestFilterSensitiveLog: (obj: ListLayoutsRequest) => any;
1902
+ /**
1903
+ * @internal
1904
+ */
1905
+ export declare const LayoutSummaryFilterSensitiveLog: (obj: LayoutSummary) => any;
1906
+ /**
1907
+ * @internal
1908
+ */
1909
+ export declare const ListLayoutsResponseFilterSensitiveLog: (obj: ListLayoutsResponse) => any;
1910
+ /**
1911
+ * @internal
1912
+ */
1913
+ export declare const UpdateLayoutRequestFilterSensitiveLog: (obj: UpdateLayoutRequest) => any;
1914
+ /**
1915
+ * @internal
1916
+ */
1917
+ export declare const UpdateLayoutResponseFilterSensitiveLog: (obj: UpdateLayoutResponse) => any;
1918
+ /**
1919
+ * @internal
1920
+ */
1921
+ export declare const ListTagsForResourceRequestFilterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
1922
+ /**
1923
+ * @internal
1924
+ */
1925
+ export declare const ListTagsForResourceResponseFilterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
1926
+ /**
1927
+ * @internal
1928
+ */
1929
+ export declare const TagResourceRequestFilterSensitiveLog: (obj: TagResourceRequest) => any;
1930
+ /**
1931
+ * @internal
1932
+ */
1933
+ export declare const LayoutConfigurationFilterSensitiveLog: (obj: LayoutConfiguration) => any;
1934
+ /**
1935
+ * @internal
1936
+ */
1937
+ export declare const RequiredFieldFilterSensitiveLog: (obj: RequiredField) => any;
1938
+ /**
1939
+ * @internal
1940
+ */
1941
+ export declare const CreateTemplateRequestFilterSensitiveLog: (obj: CreateTemplateRequest) => any;
1942
+ /**
1943
+ * @internal
1944
+ */
1945
+ export declare const CreateTemplateResponseFilterSensitiveLog: (obj: CreateTemplateResponse) => any;
1946
+ /**
1947
+ * @internal
1948
+ */
1949
+ export declare const GetTemplateRequestFilterSensitiveLog: (obj: GetTemplateRequest) => any;
1950
+ /**
1951
+ * @internal
1952
+ */
1953
+ export declare const GetTemplateResponseFilterSensitiveLog: (obj: GetTemplateResponse) => any;
1954
+ /**
1955
+ * @internal
1956
+ */
1957
+ export declare const ListTemplatesRequestFilterSensitiveLog: (obj: ListTemplatesRequest) => any;
1958
+ /**
1959
+ * @internal
1960
+ */
1961
+ export declare const TemplateSummaryFilterSensitiveLog: (obj: TemplateSummary) => any;
1962
+ /**
1963
+ * @internal
1964
+ */
1965
+ export declare const ListTemplatesResponseFilterSensitiveLog: (obj: ListTemplatesResponse) => any;
1966
+ /**
1967
+ * @internal
1968
+ */
1969
+ export declare const UpdateTemplateRequestFilterSensitiveLog: (obj: UpdateTemplateRequest) => any;
1970
+ /**
1971
+ * @internal
1972
+ */
1973
+ export declare const UpdateTemplateResponseFilterSensitiveLog: (obj: UpdateTemplateResponse) => any;
1974
+ /**
1975
+ * @internal
1976
+ */
1977
+ export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResourceRequest) => any;
1978
+ /**
1979
+ * @internal
1980
+ */
1981
+ export declare const CaseFilterFilterSensitiveLog: (obj: CaseFilter) => any;
1982
+ /**
1983
+ * @internal
1984
+ */
1985
+ export declare const SearchCasesRequestFilterSensitiveLog: (obj: SearchCasesRequest) => any;