@aws-sdk/client-connect 3.474.0 → 3.476.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 (52) hide show
  1. package/README.md +16 -0
  2. package/dist-cjs/Connect.js +4 -0
  3. package/dist-cjs/commands/PauseContactCommand.js +51 -0
  4. package/dist-cjs/commands/ResumeContactCommand.js +51 -0
  5. package/dist-cjs/commands/index.js +2 -0
  6. package/dist-cjs/models/models_0.js +7 -5
  7. package/dist-cjs/models/models_1.js +19 -6
  8. package/dist-cjs/models/models_2.js +6 -1
  9. package/dist-cjs/protocols/Aws_restJson1.js +281 -10
  10. package/dist-es/Connect.js +4 -0
  11. package/dist-es/commands/PauseContactCommand.js +47 -0
  12. package/dist-es/commands/ResumeContactCommand.js +47 -0
  13. package/dist-es/commands/index.js +2 -0
  14. package/dist-es/models/models_0.js +6 -4
  15. package/dist-es/models/models_1.js +17 -5
  16. package/dist-es/models/models_2.js +5 -0
  17. package/dist-es/protocols/Aws_restJson1.js +271 -4
  18. package/dist-types/Connect.d.ts +14 -0
  19. package/dist-types/ConnectClient.d.ts +4 -2
  20. package/dist-types/commands/CreateIntegrationAssociationCommand.d.ts +1 -1
  21. package/dist-types/commands/CreateRuleCommand.d.ts +30 -2
  22. package/dist-types/commands/DescribeContactCommand.d.ts +5 -0
  23. package/dist-types/commands/DescribePromptCommand.d.ts +2 -1
  24. package/dist-types/commands/DescribeQueueCommand.d.ts +1 -1
  25. package/dist-types/commands/DescribeRuleCommand.d.ts +30 -2
  26. package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +1 -1
  27. package/dist-types/commands/ListRulesCommand.d.ts +3 -3
  28. package/dist-types/commands/PauseContactCommand.d.ts +97 -0
  29. package/dist-types/commands/ResumeContactCommand.d.ts +94 -0
  30. package/dist-types/commands/SearchUsersCommand.d.ts +1 -2
  31. package/dist-types/commands/SearchVocabulariesCommand.d.ts +1 -1
  32. package/dist-types/commands/StartOutboundVoiceContactCommand.d.ts +9 -0
  33. package/dist-types/commands/UpdateRuleCommand.d.ts +29 -1
  34. package/dist-types/commands/index.d.ts +2 -0
  35. package/dist-types/models/models_0.d.ts +132 -149
  36. package/dist-types/models/models_1.d.ts +225 -307
  37. package/dist-types/models/models_2.d.ts +336 -2
  38. package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
  39. package/dist-types/ts3.4/Connect.d.ts +34 -0
  40. package/dist-types/ts3.4/ConnectClient.d.ts +12 -0
  41. package/dist-types/ts3.4/commands/DescribePromptCommand.d.ts +2 -4
  42. package/dist-types/ts3.4/commands/DescribeQueueCommand.d.ts +1 -1
  43. package/dist-types/ts3.4/commands/PauseContactCommand.d.ts +35 -0
  44. package/dist-types/ts3.4/commands/ResumeContactCommand.d.ts +38 -0
  45. package/dist-types/ts3.4/commands/SearchUsersCommand.d.ts +1 -2
  46. package/dist-types/ts3.4/commands/SearchVocabulariesCommand.d.ts +1 -1
  47. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  48. package/dist-types/ts3.4/models/models_0.d.ts +33 -37
  49. package/dist-types/ts3.4/models/models_1.d.ts +56 -65
  50. package/dist-types/ts3.4/models/models_2.d.ts +72 -5
  51. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
  52. package/package.json +4 -4
@@ -19,9 +19,12 @@ export declare class AccessDeniedException extends __BaseException {
19
19
  */
20
20
  export declare const ActionType: {
21
21
  readonly ASSIGN_CONTACT_CATEGORY: "ASSIGN_CONTACT_CATEGORY";
22
+ readonly CREATE_CASE: "CREATE_CASE";
22
23
  readonly CREATE_TASK: "CREATE_TASK";
24
+ readonly END_ASSOCIATED_TASKS: "END_ASSOCIATED_TASKS";
23
25
  readonly GENERATE_EVENTBRIDGE_EVENT: "GENERATE_EVENTBRIDGE_EVENT";
24
26
  readonly SEND_NOTIFICATION: "SEND_NOTIFICATION";
27
+ readonly UPDATE_CASE: "UPDATE_CASE";
25
28
  };
26
29
  /**
27
30
  * @public
@@ -319,6 +322,11 @@ export interface AgentInfo {
319
322
  * <p>The timestamp when the contact was connected to the agent.</p>
320
323
  */
321
324
  ConnectedToAgentTimestamp?: Date;
325
+ /**
326
+ * @public
327
+ * <p>Agent pause duration for a contact in seconds.</p>
328
+ */
329
+ AgentPauseDurationInSeconds?: number;
322
330
  }
323
331
  /**
324
332
  * @public
@@ -2441,6 +2449,7 @@ export type IntegrationType = (typeof IntegrationType)[keyof typeof IntegrationT
2441
2449
  * @enum
2442
2450
  */
2443
2451
  export declare const SourceType: {
2452
+ readonly CASES: "CASES";
2444
2453
  readonly SALESFORCE: "SALESFORCE";
2445
2454
  readonly ZENDESK: "ZENDESK";
2446
2455
  };
@@ -3144,6 +3153,76 @@ export interface CreateRoutingProfileResponse {
3144
3153
  */
3145
3154
  export interface AssignContactCategoryActionDefinition {
3146
3155
  }
3156
+ /**
3157
+ * @public
3158
+ * <p>An empty value.</p>
3159
+ */
3160
+ export interface EmptyFieldValue {
3161
+ }
3162
+ /**
3163
+ * @public
3164
+ * <p>Object to store union of Field values.</p>
3165
+ */
3166
+ export interface FieldValueUnion {
3167
+ /**
3168
+ * @public
3169
+ * <p>A Boolean number value type.</p>
3170
+ */
3171
+ BooleanValue?: boolean;
3172
+ /**
3173
+ * @public
3174
+ * <p>a Double number value type.</p>
3175
+ */
3176
+ DoubleValue?: number;
3177
+ /**
3178
+ * @public
3179
+ * <p>An empty value.</p>
3180
+ */
3181
+ EmptyValue?: EmptyFieldValue;
3182
+ /**
3183
+ * @public
3184
+ * <p>String value type.</p>
3185
+ */
3186
+ StringValue?: string;
3187
+ }
3188
+ /**
3189
+ * @public
3190
+ * <p>Object for case field values.</p>
3191
+ */
3192
+ export interface FieldValue {
3193
+ /**
3194
+ * @public
3195
+ * <p>Unique identifier of a field.</p>
3196
+ */
3197
+ Id: string | undefined;
3198
+ /**
3199
+ * @public
3200
+ * <p>Union of potential field value types.</p>
3201
+ */
3202
+ Value: FieldValueUnion | undefined;
3203
+ }
3204
+ /**
3205
+ * @public
3206
+ * <p>The <code>CreateCase</code> action definition.</p>
3207
+ */
3208
+ export interface CreateCaseActionDefinition {
3209
+ /**
3210
+ * @public
3211
+ * <p>An array of objects with <code>Field ID</code> and <code>Value</code> data.</p>
3212
+ */
3213
+ Fields: FieldValue[] | undefined;
3214
+ /**
3215
+ * @public
3216
+ * <p>A unique identifier of a template.</p>
3217
+ */
3218
+ TemplateId: string | undefined;
3219
+ }
3220
+ /**
3221
+ * @public
3222
+ * <p>End associated tasks related to a case.</p>
3223
+ */
3224
+ export interface EndAssociatedTasksActionDefinition {
3225
+ }
3147
3226
  /**
3148
3227
  * @public
3149
3228
  * <p>The EventBridge action definition.</p>
@@ -3295,6 +3374,17 @@ export interface TaskActionDefinition {
3295
3374
  */
3296
3375
  References?: Record<string, Reference>;
3297
3376
  }
3377
+ /**
3378
+ * @public
3379
+ * <p>The <code>UpdateCase</code> action definition.</p>
3380
+ */
3381
+ export interface UpdateCaseActionDefinition {
3382
+ /**
3383
+ * @public
3384
+ * <p>An array of objects with <code>Field ID</code> and Value data.</p>
3385
+ */
3386
+ Fields: FieldValue[] | undefined;
3387
+ }
3298
3388
  /**
3299
3389
  * @public
3300
3390
  * <p>Information about the action to be performed when a rule is triggered.</p>
@@ -3344,6 +3434,26 @@ export interface RuleAction {
3344
3434
  * </p>
3345
3435
  */
3346
3436
  SendNotificationAction?: SendNotificationActionDefinition;
3437
+ /**
3438
+ * @public
3439
+ * <p>Information about the create case action.</p>
3440
+ * <p>Supported only for <code>TriggerEventSource</code> values:
3441
+ * <code>OnPostCallAnalysisAvailable</code> | <code>OnPostChatAnalysisAvailable</code>.</p>
3442
+ */
3443
+ CreateCaseAction?: CreateCaseActionDefinition;
3444
+ /**
3445
+ * @public
3446
+ * <p>Information about the update case action.</p>
3447
+ * <p>Supported only for <code>TriggerEventSource</code> values: <code>OnCaseCreate</code> |
3448
+ * <code>OnCaseUpdate</code>.</p>
3449
+ */
3450
+ UpdateCaseAction?: UpdateCaseActionDefinition;
3451
+ /**
3452
+ * @public
3453
+ * <p>Information about the end associated tasks action.</p>
3454
+ * <p>Supported only for <code>TriggerEventSource</code> values: <code>OnCaseUpdate</code>.</p>
3455
+ */
3456
+ EndAssociatedTasksAction?: EndAssociatedTasksActionDefinition;
3347
3457
  }
3348
3458
  /**
3349
3459
  * @public
@@ -3362,6 +3472,8 @@ export type RulePublishStatus = (typeof RulePublishStatus)[keyof typeof RulePubl
3362
3472
  * @enum
3363
3473
  */
3364
3474
  export declare const EventSourceName: {
3475
+ readonly OnCaseCreate: "OnCaseCreate";
3476
+ readonly OnCaseUpdate: "OnCaseUpdate";
3365
3477
  readonly OnContactEvaluationSubmit: "OnContactEvaluationSubmit";
3366
3478
  readonly OnMetricDataUpdate: "OnMetricDataUpdate";
3367
3479
  readonly OnPostCallAnalysisAvailable: "OnPostCallAnalysisAvailable";
@@ -5048,6 +5160,26 @@ export interface Contact {
5048
5160
  * <p>The timestamp when contact was last updated.</p>
5049
5161
  */
5050
5162
  LastUpdateTimestamp?: Date;
5163
+ /**
5164
+ * @public
5165
+ * <p>The timestamp when the contact was last paused.</p>
5166
+ */
5167
+ LastPausedTimestamp?: Date;
5168
+ /**
5169
+ * @public
5170
+ * <p>The timestamp when the contact was last resumed.</p>
5171
+ */
5172
+ LastResumedTimestamp?: Date;
5173
+ /**
5174
+ * @public
5175
+ * <p>Total pause count for a contact.</p>
5176
+ */
5177
+ TotalPauseCount?: number;
5178
+ /**
5179
+ * @public
5180
+ * <p>Total pause duration for a contact in seconds.</p>
5181
+ */
5182
+ TotalPauseDurationInSeconds?: number;
5051
5183
  /**
5052
5184
  * @public
5053
5185
  * <p>The timestamp, in Unix epoch time format, at which to start running the inbound flow.
@@ -6245,155 +6377,6 @@ export interface DescribePromptRequest {
6245
6377
  */
6246
6378
  PromptId: string | undefined;
6247
6379
  }
6248
- /**
6249
- * @public
6250
- * <p>Information about a prompt.</p>
6251
- */
6252
- export interface Prompt {
6253
- /**
6254
- * @public
6255
- * <p>The Amazon Resource Name (ARN) of the prompt.</p>
6256
- */
6257
- PromptARN?: string;
6258
- /**
6259
- * @public
6260
- * <p>A unique identifier for the prompt.</p>
6261
- */
6262
- PromptId?: string;
6263
- /**
6264
- * @public
6265
- * <p>The name of the prompt.</p>
6266
- */
6267
- Name?: string;
6268
- /**
6269
- * @public
6270
- * <p>The description of the prompt.</p>
6271
- */
6272
- Description?: string;
6273
- /**
6274
- * @public
6275
- * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
6276
- */
6277
- Tags?: Record<string, string>;
6278
- /**
6279
- * @public
6280
- * <p>The timestamp when this resource was last modified.</p>
6281
- */
6282
- LastModifiedTime?: Date;
6283
- /**
6284
- * @public
6285
- * <p>The Amazon Web Services Region where this resource was last modified.</p>
6286
- */
6287
- LastModifiedRegion?: string;
6288
- }
6289
- /**
6290
- * @public
6291
- */
6292
- export interface DescribePromptResponse {
6293
- /**
6294
- * @public
6295
- * <p>Information about the prompt.</p>
6296
- */
6297
- Prompt?: Prompt;
6298
- }
6299
- /**
6300
- * @public
6301
- */
6302
- export interface DescribeQueueRequest {
6303
- /**
6304
- * @public
6305
- * <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>
6306
- */
6307
- InstanceId: string | undefined;
6308
- /**
6309
- * @public
6310
- * <p>The identifier for the queue.</p>
6311
- */
6312
- QueueId: string | undefined;
6313
- }
6314
- /**
6315
- * @public
6316
- * @enum
6317
- */
6318
- export declare const QueueStatus: {
6319
- readonly DISABLED: "DISABLED";
6320
- readonly ENABLED: "ENABLED";
6321
- };
6322
- /**
6323
- * @public
6324
- */
6325
- export type QueueStatus = (typeof QueueStatus)[keyof typeof QueueStatus];
6326
- /**
6327
- * @public
6328
- * <p>Contains information about a queue.</p>
6329
- */
6330
- export interface Queue {
6331
- /**
6332
- * @public
6333
- * <p>The name of the queue.</p>
6334
- */
6335
- Name?: string;
6336
- /**
6337
- * @public
6338
- * <p>The Amazon Resource Name (ARN) for the queue.</p>
6339
- */
6340
- QueueArn?: string;
6341
- /**
6342
- * @public
6343
- * <p>The identifier for the queue.</p>
6344
- */
6345
- QueueId?: string;
6346
- /**
6347
- * @public
6348
- * <p>The description of the queue.</p>
6349
- */
6350
- Description?: string;
6351
- /**
6352
- * @public
6353
- * <p>The outbound caller ID name, number, and outbound whisper flow.</p>
6354
- */
6355
- OutboundCallerConfig?: OutboundCallerConfig;
6356
- /**
6357
- * @public
6358
- * <p>The identifier for the hours of operation.</p>
6359
- */
6360
- HoursOfOperationId?: string;
6361
- /**
6362
- * @public
6363
- * <p>The maximum number of contacts that can be in the queue before it is considered full.</p>
6364
- */
6365
- MaxContacts?: number;
6366
- /**
6367
- * @public
6368
- * <p>The status of the queue.</p>
6369
- */
6370
- Status?: QueueStatus;
6371
- /**
6372
- * @public
6373
- * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
6374
- */
6375
- Tags?: Record<string, string>;
6376
- /**
6377
- * @public
6378
- * <p>The timestamp when this resource was last modified.</p>
6379
- */
6380
- LastModifiedTime?: Date;
6381
- /**
6382
- * @public
6383
- * <p>The Amazon Web Services Region where this resource was last modified.</p>
6384
- */
6385
- LastModifiedRegion?: string;
6386
- }
6387
- /**
6388
- * @public
6389
- */
6390
- export interface DescribeQueueResponse {
6391
- /**
6392
- * @public
6393
- * <p>The name of the queue.</p>
6394
- */
6395
- Queue?: Queue;
6396
- }
6397
6380
  /**
6398
6381
  * @internal
6399
6382
  */