@aws-sdk/client-connect 3.379.1 → 3.382.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.
@@ -6,14 +6,17 @@ import { EvaluationForm, EvaluationFormContent, EvaluationFormItem, HierarchyGro
6
6
  */
7
7
  export interface PromptSearchCriteria {
8
8
  /**
9
+ * @public
9
10
  * <p>A list of conditions which would be applied together with an OR condition.</p>
10
11
  */
11
12
  OrConditions?: PromptSearchCriteria[];
12
13
  /**
14
+ * @public
13
15
  * <p>A list of conditions which would be applied together with an AND condition.</p>
14
16
  */
15
17
  AndConditions?: PromptSearchCriteria[];
16
18
  /**
19
+ * @public
17
20
  * <p>A leaf node condition which can be used to specify a string condition.</p>
18
21
  * <note>
19
22
  * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
@@ -33,14 +36,17 @@ export interface PromptSearchCriteria {
33
36
  */
34
37
  export interface QueueSearchCriteria {
35
38
  /**
39
+ * @public
36
40
  * <p>A list of conditions which would be applied together with an OR condition.</p>
37
41
  */
38
42
  OrConditions?: QueueSearchCriteria[];
39
43
  /**
44
+ * @public
40
45
  * <p>A list of conditions which would be applied together with an AND condition.</p>
41
46
  */
42
47
  AndConditions?: QueueSearchCriteria[];
43
48
  /**
49
+ * @public
44
50
  * <p>A leaf node condition which can be used to specify a string condition.</p>
45
51
  * <note>
46
52
  * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
@@ -49,6 +55,7 @@ export interface QueueSearchCriteria {
49
55
  */
50
56
  StringCondition?: StringCondition;
51
57
  /**
58
+ * @public
52
59
  * <p>The type of queue.</p>
53
60
  */
54
61
  QueueTypeCondition?: SearchableQueueType | string;
@@ -59,14 +66,17 @@ export interface QueueSearchCriteria {
59
66
  */
60
67
  export interface QuickConnectSearchCriteria {
61
68
  /**
69
+ * @public
62
70
  * <p>A list of conditions which would be applied together with an OR condition.</p>
63
71
  */
64
72
  OrConditions?: QuickConnectSearchCriteria[];
65
73
  /**
74
+ * @public
66
75
  * <p>A list of conditions which would be applied together with an AND condition.</p>
67
76
  */
68
77
  AndConditions?: QuickConnectSearchCriteria[];
69
78
  /**
79
+ * @public
70
80
  * <p>A leaf node condition which can be used to specify a string condition.</p>
71
81
  * <note>
72
82
  * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
@@ -86,14 +96,17 @@ export interface QuickConnectSearchCriteria {
86
96
  */
87
97
  export interface RoutingProfileSearchCriteria {
88
98
  /**
99
+ * @public
89
100
  * <p>A list of conditions which would be applied together with an OR condition.</p>
90
101
  */
91
102
  OrConditions?: RoutingProfileSearchCriteria[];
92
103
  /**
104
+ * @public
93
105
  * <p>A list of conditions which would be applied together with an AND condition.</p>
94
106
  */
95
107
  AndConditions?: RoutingProfileSearchCriteria[];
96
108
  /**
109
+ * @public
97
110
  * <p>A leaf node condition which can be used to specify a string condition.</p>
98
111
  * <note>
99
112
  * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
@@ -113,14 +126,17 @@ export interface RoutingProfileSearchCriteria {
113
126
  */
114
127
  export interface SecurityProfileSearchCriteria {
115
128
  /**
129
+ * @public
116
130
  * <p>A list of conditions which would be applied together with an OR condition.</p>
117
131
  */
118
132
  OrConditions?: SecurityProfileSearchCriteria[];
119
133
  /**
134
+ * @public
120
135
  * <p>A list of conditions which would be applied together with an AND condition.</p>
121
136
  */
122
137
  AndConditions?: SecurityProfileSearchCriteria[];
123
138
  /**
139
+ * @public
124
140
  * <p>A leaf node condition which can be used to specify a string condition. </p>
125
141
  */
126
142
  StringCondition?: StringCondition;
@@ -130,38 +146,47 @@ export interface SecurityProfileSearchCriteria {
130
146
  */
131
147
  export interface UpdateEvaluationFormRequest {
132
148
  /**
149
+ * @public
133
150
  * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
134
151
  */
135
152
  InstanceId: string | undefined;
136
153
  /**
154
+ * @public
137
155
  * <p>The unique identifier for the evaluation form.</p>
138
156
  */
139
157
  EvaluationFormId: string | undefined;
140
158
  /**
159
+ * @public
141
160
  * <p>A version of the evaluation form to update.</p>
142
161
  */
143
162
  EvaluationFormVersion: number | undefined;
144
163
  /**
164
+ * @public
145
165
  * <p>A flag indicating whether the operation must create a new version.</p>
146
166
  */
147
167
  CreateNewVersion?: boolean;
148
168
  /**
169
+ * @public
149
170
  * <p>A title of the evaluation form.</p>
150
171
  */
151
172
  Title: string | undefined;
152
173
  /**
174
+ * @public
153
175
  * <p>The description of the evaluation form.</p>
154
176
  */
155
177
  Description?: string;
156
178
  /**
179
+ * @public
157
180
  * <p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>
158
181
  */
159
182
  Items: EvaluationFormItem[] | undefined;
160
183
  /**
184
+ * @public
161
185
  * <p>A scoring strategy of the evaluation form.</p>
162
186
  */
163
187
  ScoringStrategy?: EvaluationFormScoringStrategy;
164
188
  /**
189
+ * @public
165
190
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
166
191
  * request. If not provided, the Amazon Web Services
167
192
  * SDK populates this field. For more information about idempotency, see
@@ -180,16 +205,19 @@ export interface UpdateEvaluationFormRequest {
180
205
  */
181
206
  export interface UserSearchCriteria {
182
207
  /**
208
+ * @public
183
209
  * <p>A list of conditions which would be applied together with an <code>OR</code>
184
210
  * condition.</p>
185
211
  */
186
212
  OrConditions?: UserSearchCriteria[];
187
213
  /**
214
+ * @public
188
215
  * <p>A list of conditions which would be applied together with an <code>AND</code> condition.
189
216
  * </p>
190
217
  */
191
218
  AndConditions?: UserSearchCriteria[];
192
219
  /**
220
+ * @public
193
221
  * <p>A leaf node condition which can be used to specify a string condition.</p>
194
222
  * <note>
195
223
  * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
@@ -198,6 +226,7 @@ export interface UserSearchCriteria {
198
226
  */
199
227
  StringCondition?: StringCondition;
200
228
  /**
229
+ * @public
201
230
  * <p>A leaf node condition which can be used to specify a hierarchy group condition.</p>
202
231
  */
203
232
  HierarchyGroupCondition?: HierarchyGroupCondition;
@@ -207,10 +236,12 @@ export interface UserSearchCriteria {
207
236
  */
208
237
  export interface DescribeContactEvaluationResponse {
209
238
  /**
239
+ * @public
210
240
  * <p>Information about the evaluation form completed for a specific contact.</p>
211
241
  */
212
242
  Evaluation: Evaluation | undefined;
213
243
  /**
244
+ * @public
214
245
  * <p>Information about the evaluation form.</p>
215
246
  */
216
247
  EvaluationForm: EvaluationFormContent | undefined;
@@ -220,6 +251,7 @@ export interface DescribeContactEvaluationResponse {
220
251
  */
221
252
  export interface DescribeEvaluationFormResponse {
222
253
  /**
254
+ * @public
223
255
  * <p>Information about the evaluation form.</p>
224
256
  */
225
257
  EvaluationForm: EvaluationForm | undefined;
@@ -229,23 +261,28 @@ export interface DescribeEvaluationFormResponse {
229
261
  */
230
262
  export interface SearchHoursOfOperationsRequest {
231
263
  /**
264
+ * @public
232
265
  * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
233
266
  */
234
267
  InstanceId: string | undefined;
235
268
  /**
269
+ * @public
236
270
  * <p>The token for the next set of results. Use the value returned in the previous
237
271
  * response in the next request to retrieve the next set of results.</p>
238
272
  */
239
273
  NextToken?: string;
240
274
  /**
275
+ * @public
241
276
  * <p>The maximum number of results to return per page.</p>
242
277
  */
243
278
  MaxResults?: number;
244
279
  /**
280
+ * @public
245
281
  * <p>Filters to be applied to search results.</p>
246
282
  */
247
283
  SearchFilter?: HoursOfOperationSearchFilter;
248
284
  /**
285
+ * @public
249
286
  * <p>The search criteria to be used to return hours of operations.</p>
250
287
  */
251
288
  SearchCriteria?: HoursOfOperationSearchCriteria;
@@ -255,23 +292,28 @@ export interface SearchHoursOfOperationsRequest {
255
292
  */
256
293
  export interface SearchPromptsRequest {
257
294
  /**
295
+ * @public
258
296
  * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
259
297
  */
260
298
  InstanceId: string | undefined;
261
299
  /**
300
+ * @public
262
301
  * <p>The token for the next set of results. Use the value returned in the previous
263
302
  * response in the next request to retrieve the next set of results.</p>
264
303
  */
265
304
  NextToken?: string;
266
305
  /**
306
+ * @public
267
307
  * <p>The maximum number of results to return per page.</p>
268
308
  */
269
309
  MaxResults?: number;
270
310
  /**
311
+ * @public
271
312
  * <p>Filters to be applied to search results.</p>
272
313
  */
273
314
  SearchFilter?: PromptSearchFilter;
274
315
  /**
316
+ * @public
275
317
  * <p>The search criteria to be used to return prompts.</p>
276
318
  */
277
319
  SearchCriteria?: PromptSearchCriteria;
@@ -281,23 +323,28 @@ export interface SearchPromptsRequest {
281
323
  */
282
324
  export interface SearchQueuesRequest {
283
325
  /**
326
+ * @public
284
327
  * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
285
328
  */
286
329
  InstanceId: string | undefined;
287
330
  /**
331
+ * @public
288
332
  * <p>The token for the next set of results. Use the value returned in the previous
289
333
  * response in the next request to retrieve the next set of results.</p>
290
334
  */
291
335
  NextToken?: string;
292
336
  /**
337
+ * @public
293
338
  * <p>The maximum number of results to return per page.</p>
294
339
  */
295
340
  MaxResults?: number;
296
341
  /**
342
+ * @public
297
343
  * <p>Filters to be applied to search results.</p>
298
344
  */
299
345
  SearchFilter?: QueueSearchFilter;
300
346
  /**
347
+ * @public
301
348
  * <p>The search criteria to be used to return queues.</p>
302
349
  * <note>
303
350
  * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
@@ -312,23 +359,28 @@ export interface SearchQueuesRequest {
312
359
  */
313
360
  export interface SearchQuickConnectsRequest {
314
361
  /**
362
+ * @public
315
363
  * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
316
364
  */
317
365
  InstanceId: string | undefined;
318
366
  /**
367
+ * @public
319
368
  * <p>The token for the next set of results. Use the value returned in the previous
320
369
  * response in the next request to retrieve the next set of results.</p>
321
370
  */
322
371
  NextToken?: string;
323
372
  /**
373
+ * @public
324
374
  * <p>The maximum number of results to return per page.</p>
325
375
  */
326
376
  MaxResults?: number;
327
377
  /**
378
+ * @public
328
379
  * <p>Filters to be applied to search results.</p>
329
380
  */
330
381
  SearchFilter?: QuickConnectSearchFilter;
331
382
  /**
383
+ * @public
332
384
  * <p>The search criteria to be used to return quick connects.</p>
333
385
  */
334
386
  SearchCriteria?: QuickConnectSearchCriteria;
@@ -338,23 +390,28 @@ export interface SearchQuickConnectsRequest {
338
390
  */
339
391
  export interface SearchRoutingProfilesRequest {
340
392
  /**
393
+ * @public
341
394
  * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
342
395
  */
343
396
  InstanceId: string | undefined;
344
397
  /**
398
+ * @public
345
399
  * <p>The token for the next set of results. Use the value returned in the previous
346
400
  * response in the next request to retrieve the next set of results.</p>
347
401
  */
348
402
  NextToken?: string;
349
403
  /**
404
+ * @public
350
405
  * <p>The maximum number of results to return per page.</p>
351
406
  */
352
407
  MaxResults?: number;
353
408
  /**
409
+ * @public
354
410
  * <p>Filters to be applied to search results.</p>
355
411
  */
356
412
  SearchFilter?: RoutingProfileSearchFilter;
357
413
  /**
414
+ * @public
358
415
  * <p>The search criteria to be used to return routing profiles.</p>
359
416
  * <note>
360
417
  * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
@@ -369,19 +426,23 @@ export interface SearchRoutingProfilesRequest {
369
426
  */
370
427
  export interface SearchSecurityProfilesRequest {
371
428
  /**
429
+ * @public
372
430
  * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
373
431
  */
374
432
  InstanceId: string | undefined;
375
433
  /**
434
+ * @public
376
435
  * <p>The token for the next set of results. Use the value returned in the previous
377
436
  * response in the next request to retrieve the next set of results.</p>
378
437
  */
379
438
  NextToken?: string;
380
439
  /**
440
+ * @public
381
441
  * <p>The maximum number of results to return per page.</p>
382
442
  */
383
443
  MaxResults?: number;
384
444
  /**
445
+ * @public
385
446
  * <p>The search criteria to be used to return security profiles. </p>
386
447
  * <note>
387
448
  * <p>The <code>name</code> field support "contains" queries with a minimum of 2 characters and
@@ -395,6 +456,7 @@ export interface SearchSecurityProfilesRequest {
395
456
  */
396
457
  SearchCriteria?: SecurityProfileSearchCriteria;
397
458
  /**
459
+ * @public
398
460
  * <p>Filters to be applied to search results.</p>
399
461
  */
400
462
  SearchFilter?: SecurityProfilesSearchFilter;
@@ -404,23 +466,28 @@ export interface SearchSecurityProfilesRequest {
404
466
  */
405
467
  export interface SearchUsersRequest {
406
468
  /**
469
+ * @public
407
470
  * <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
408
471
  */
409
472
  InstanceId?: string;
410
473
  /**
474
+ * @public
411
475
  * <p>The token for the next set of results. Use the value returned in the previous
412
476
  * response in the next request to retrieve the next set of results.</p>
413
477
  */
414
478
  NextToken?: string;
415
479
  /**
480
+ * @public
416
481
  * <p>The maximum number of results to return per page.</p>
417
482
  */
418
483
  MaxResults?: number;
419
484
  /**
485
+ * @public
420
486
  * <p>Filters to be applied to search results.</p>
421
487
  */
422
488
  SearchFilter?: UserSearchFilter;
423
489
  /**
490
+ * @public
424
491
  * <p>The search criteria to be used to return users.</p>
425
492
  * <note>
426
493
  * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
@@ -1722,7 +1722,11 @@ export interface PhoneNumberStatus {
1722
1722
  }
1723
1723
  export declare const PhoneNumberType: {
1724
1724
  readonly DID: "DID";
1725
+ readonly SHARED: "SHARED";
1726
+ readonly THIRD_PARTY_DID: "THIRD_PARTY_DID";
1727
+ readonly THIRD_PARTY_TF: "THIRD_PARTY_TF";
1725
1728
  readonly TOLL_FREE: "TOLL_FREE";
1729
+ readonly UIFN: "UIFN";
1726
1730
  };
1727
1731
  export type PhoneNumberType =
1728
1732
  (typeof PhoneNumberType)[keyof typeof PhoneNumberType];
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-connect",
3
3
  "description": "AWS SDK for JavaScript Connect Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.382.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",