@aws-sdk/client-connectcases 3.496.0 → 3.497.0

package/dist-types/models/models_0.d.ts

@@ -38,8 +38,12 @@ export interface EmptyFieldValue {
 /**
  * @public
  * <p>Object to store union of Field values.</p>
+ *          <note>
+ *             <p>The <code>Summary</code> system field accepts 1500 characters while all other fields
+ *         accept 500 characters.</p>
+ *          </note>
  */
-export type FieldValueUnion = FieldValueUnion.BooleanValueMember | FieldValueUnion.DoubleValueMember | FieldValueUnion.EmptyValueMember | FieldValueUnion.StringValueMember | FieldValueUnion.$UnknownMember;
+export type FieldValueUnion = FieldValueUnion.BooleanValueMember | FieldValueUnion.DoubleValueMember | FieldValueUnion.EmptyValueMember | FieldValueUnion.StringValueMember | FieldValueUnion.UserArnValueMember | FieldValueUnion.$UnknownMember;
 /**
  * @public
  */
@@ -53,6 +57,7 @@ export declare namespace FieldValueUnion {
         doubleValue?: never;
         booleanValue?: never;
         emptyValue?: never;
+        userArnValue?: never;
         $unknown?: never;
     }
     /**
@@ -65,6 +70,7 @@ export declare namespace FieldValueUnion {
         doubleValue: number;
         booleanValue?: never;
         emptyValue?: never;
+        userArnValue?: never;
         $unknown?: never;
     }
     /**
@@ -76,6 +82,7 @@ export declare namespace FieldValueUnion {
         doubleValue?: never;
         booleanValue: boolean;
         emptyValue?: never;
+        userArnValue?: never;
         $unknown?: never;
     }
     /**
@@ -87,6 +94,19 @@ export declare namespace FieldValueUnion {
         doubleValue?: never;
         booleanValue?: never;
         emptyValue: EmptyFieldValue;
+        userArnValue?: never;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     * <p>Represents the user that performed the audit.</p>
+     */
+    interface UserArnValueMember {
+        stringValue?: never;
+        doubleValue?: never;
+        booleanValue?: never;
+        emptyValue?: never;
+        userArnValue: string;
         $unknown?: never;
     }
     /**
@@ -97,6 +117,7 @@ export declare namespace FieldValueUnion {
         doubleValue?: never;
         booleanValue?: never;
         emptyValue?: never;
+        userArnValue?: never;
         $unknown: [string, any];
     }
     interface Visitor<T> {
@@ -104,6 +125,7 @@ export declare namespace FieldValueUnion {
         doubleValue: (value: number) => T;
         booleanValue: (value: boolean) => T;
         emptyValue: (value: EmptyFieldValue) => T;
+        userArnValue: (value: string) => T;
         _: (name: string, value: any) => T;
     }
     const visit: <T>(value: FieldValueUnion, visitor: Visitor<T>) => T;
@@ -124,6 +146,36 @@ export interface FieldValue {
      */
     value: FieldValueUnion | undefined;
 }
+/**
+ * @public
+ * <p>Represents the identity of the person who performed the action.</p>
+ */
+export type UserUnion = UserUnion.UserArnMember | UserUnion.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace UserUnion {
+    /**
+     * @public
+     * <p>Represents the Amazon Connect ARN of the user.</p>
+     */
+    interface UserArnMember {
+        userArn: string;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        userArn?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        userArn: (value: string) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: UserUnion, visitor: Visitor<T>) => T;
+}
 /**
  * @public
  */
@@ -152,6 +204,11 @@ export interface CreateCaseRequest {
      *             <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
      */
     clientToken?: string;
+    /**
+     * @public
+     * <p>Represents the identity of the person who performed the action.</p>
+     */
+    performedBy?: UserUnion;
 }
 /**
  * @public
@@ -297,6 +354,245 @@ export interface GetCaseResponse {
      */
     tags?: Record<string, string>;
 }
+/**
+ * @public
+ */
+export interface GetCaseAuditEventsRequest {
+    /**
+     * @public
+     * <p>A unique identifier of the case.</p>
+     */
+    caseId: string | undefined;
+    /**
+     * @public
+     * <p>The unique identifier of the Cases domain.</p>
+     */
+    domainId: string | undefined;
+    /**
+     * @public
+     * <p>The maximum number of audit events to return. The current maximum supported value is 25.
+     *       This is also the default when no other value is provided.</p>
+     */
+    maxResults?: number;
+    /**
+     * @public
+     * <p>The token for the next set of results. Use the value returned in the previous response in
+     *       the next request to retrieve the next set of results.</p>
+     */
+    nextToken?: string;
+}
+/**
+ * @public
+ * <p>Object to store union of Field values.</p>
+ *          <important>
+ *             <p>This data type is a UNION, so only one of the following members can be specified when
+ *         used or returned.</p>
+ *          </important>
+ */
+export type AuditEventFieldValueUnion = AuditEventFieldValueUnion.BooleanValueMember | AuditEventFieldValueUnion.DoubleValueMember | AuditEventFieldValueUnion.EmptyValueMember | AuditEventFieldValueUnion.StringValueMember | AuditEventFieldValueUnion.UserArnValueMember | AuditEventFieldValueUnion.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace AuditEventFieldValueUnion {
+    /**
+     * @public
+     * <p>Can be either null, or have a String value type. Only one value can be provided.</p>
+     */
+    interface StringValueMember {
+        stringValue: string;
+        doubleValue?: never;
+        booleanValue?: never;
+        emptyValue?: never;
+        userArnValue?: never;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     * <p>Can be either null, or have a Double value type. Only one value can be provided.</p>
+     */
+    interface DoubleValueMember {
+        stringValue?: never;
+        doubleValue: number;
+        booleanValue?: never;
+        emptyValue?: never;
+        userArnValue?: never;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     * <p>Can be either null, or have a Boolean value type. Only one value can be provided.</p>
+     */
+    interface BooleanValueMember {
+        stringValue?: never;
+        doubleValue?: never;
+        booleanValue: boolean;
+        emptyValue?: never;
+        userArnValue?: never;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     * <p>An empty value. You cannot set <code>EmptyFieldValue</code> on a field that is required on
+     *       a case template.</p>
+     *          <p>This structure will never have any data members. It signifies an empty value on a case
+     *       field.</p>
+     */
+    interface EmptyValueMember {
+        stringValue?: never;
+        doubleValue?: never;
+        booleanValue?: never;
+        emptyValue: EmptyFieldValue;
+        userArnValue?: never;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     * <p>Can be either null, or have a String value type formatted as an ARN. Only one value can be
+     *       provided.</p>
+     */
+    interface UserArnValueMember {
+        stringValue?: never;
+        doubleValue?: never;
+        booleanValue?: never;
+        emptyValue?: never;
+        userArnValue: string;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    interface $UnknownMember {
+        stringValue?: never;
+        doubleValue?: never;
+        booleanValue?: never;
+        emptyValue?: never;
+        userArnValue?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        stringValue: (value: string) => T;
+        doubleValue: (value: number) => T;
+        booleanValue: (value: boolean) => T;
+        emptyValue: (value: EmptyFieldValue) => T;
+        userArnValue: (value: string) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: AuditEventFieldValueUnion, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * <p>Fields for audit event.</p>
+ */
+export interface AuditEventField {
+    /**
+     * @public
+     * <p>Unique identifier of field in an Audit History entry.</p>
+     */
+    eventFieldId: string | undefined;
+    /**
+     * @public
+     * <p>Union of potential field value types.</p>
+     */
+    oldValue?: AuditEventFieldValueUnion;
+    /**
+     * @public
+     * <p>Union of potential field value types.</p>
+     */
+    newValue: AuditEventFieldValueUnion | undefined;
+}
+/**
+ * @public
+ * <p>Information of the user which performed the audit.</p>
+ */
+export interface AuditEventPerformedBy {
+    /**
+     * @public
+     * <p>Represents the identity of the person who performed the action.</p>
+     */
+    user?: UserUnion;
+    /**
+     * @public
+     * <p>Unique identifier of an IAM role.</p>
+     */
+    iamPrincipalArn: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const RelatedItemType: {
+    readonly COMMENT: "Comment";
+    readonly CONTACT: "Contact";
+};
+/**
+ * @public
+ */
+export type RelatedItemType = (typeof RelatedItemType)[keyof typeof RelatedItemType];
+/**
+ * @public
+ * @enum
+ */
+export declare const AuditEventType: {
+    readonly CASE_CREATED: "Case.Created";
+    readonly CASE_UPDATED: "Case.Updated";
+    readonly RELATED_ITEM_CREATED: "RelatedItem.Created";
+};
+/**
+ * @public
+ */
+export type AuditEventType = (typeof AuditEventType)[keyof typeof AuditEventType];
+/**
+ * @public
+ * <p>Represents the content of a particular audit event.</p>
+ */
+export interface AuditEvent {
+    /**
+     * @public
+     * <p>Unique identifier of a case audit history event.</p>
+     */
+    eventId: string | undefined;
+    /**
+     * @public
+     * <p>The Type of an audit history event.</p>
+     */
+    type: AuditEventType | undefined;
+    /**
+     * @public
+     * <p>The Type of the related item.</p>
+     */
+    relatedItemType?: RelatedItemType;
+    /**
+     * @public
+     * <p>Time at which an Audit History event took place.</p>
+     */
+    performedTime: Date | undefined;
+    /**
+     * @public
+     * <p>A list of Case Audit History event fields.</p>
+     */
+    fields: AuditEventField[] | undefined;
+    /**
+     * @public
+     * <p>Information of the user which performed the audit.</p>
+     */
+    performedBy?: AuditEventPerformedBy;
+}
+/**
+ * @public
+ */
+export interface GetCaseAuditEventsResponse {
+    /**
+     * @public
+     * <p>The token for the next set of results. This is null if there are no more results to
+     *       return.</p>
+     */
+    nextToken?: string;
+    /**
+     * @public
+     * <p>A list of case audits where each represents a particular edit of the case.</p>
+     */
+    auditEvents: AuditEvent[] | undefined;
+}
 /**
  * @public
  */
@@ -434,48 +730,6 @@ export declare namespace RelatedItemInputContent {
     }
     const visit: <T>(value: RelatedItemInputContent, visitor: Visitor<T>) => T;
 }
-/**
- * @public
- * <p>Represents the identity of the person who performed the action.</p>
- */
-export type UserUnion = UserUnion.UserArnMember | UserUnion.$UnknownMember;
-/**
- * @public
- */
-export declare namespace UserUnion {
-    /**
-     * @public
-     * <p>Represents the Amazon Connect ARN of the user.</p>
-     */
-    interface UserArnMember {
-        userArn: string;
-        $unknown?: never;
-    }
-    /**
-     * @public
-     */
-    interface $UnknownMember {
-        userArn?: never;
-        $unknown: [string, any];
-    }
-    interface Visitor<T> {
-        userArn: (value: string) => T;
-        _: (name: string, value: any) => T;
-    }
-    const visit: <T>(value: UserUnion, visitor: Visitor<T>) => T;
-}
-/**
- * @public
- * @enum
- */
-export declare const RelatedItemType: {
-    readonly COMMENT: "Comment";
-    readonly CONTACT: "Contact";
-};
-/**
- * @public
- */
-export type RelatedItemType = (typeof RelatedItemType)[keyof typeof RelatedItemType];
 /**
  * @public
  */
@@ -944,6 +1198,11 @@ export interface UpdateCaseRequest {
      *       value union data, structured identical to <code>CreateCase</code>.</p>
      */
     fields: FieldValue[] | undefined;
+    /**
+     * @public
+     * <p>Represents the identity of the person who performed the action.</p>
+     */
+    performedBy?: UserUnion;
 }
 /**
  * @public
@@ -1264,6 +1523,7 @@ export declare const FieldType: {
     readonly SINGLE_SELECT: "SingleSelect";
     readonly TEXT: "Text";
     readonly URL: "Url";
+    readonly USER: "User";
 };
 /**
  * @public
@@ -1861,7 +2121,8 @@ export interface UpdateLayoutRequest {
     name?: string;
     /**
      * @public
-     * <p>Information about which fields will be present in the layout, the order of the fields.</p>
+     * <p>Information about which fields will be present in the layout, the order of the
+     *       fields.</p>
      */
     content?: LayoutContent;
 }

package/dist-types/pagination/GetCaseAuditEventsPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@smithy/types";
+import { GetCaseAuditEventsCommandInput, GetCaseAuditEventsCommandOutput } from "../commands/GetCaseAuditEventsCommand";
+import { ConnectCasesPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateGetCaseAuditEvents: (config: ConnectCasesPaginationConfiguration, input: GetCaseAuditEventsCommandInput, ...rest: any[]) => Paginator<GetCaseAuditEventsCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./GetCaseAuditEventsPaginator";
 export * from "./GetCasePaginator";
 export * from "./Interfaces";
 export * from "./ListCasesForContactPaginator";

package/dist-types/protocols/Aws_restJson1.d.ts

@@ -9,6 +9,7 @@ import { CreateLayoutCommandInput, CreateLayoutCommandOutput } from "../commands
 import { CreateRelatedItemCommandInput, CreateRelatedItemCommandOutput } from "../commands/CreateRelatedItemCommand";
 import { CreateTemplateCommandInput, CreateTemplateCommandOutput } from "../commands/CreateTemplateCommand";
 import { DeleteDomainCommandInput, DeleteDomainCommandOutput } from "../commands/DeleteDomainCommand";
+import { GetCaseAuditEventsCommandInput, GetCaseAuditEventsCommandOutput } from "../commands/GetCaseAuditEventsCommand";
 import { GetCaseCommandInput, GetCaseCommandOutput } from "../commands/GetCaseCommand";
 import { GetCaseEventConfigurationCommandInput, GetCaseEventConfigurationCommandOutput } from "../commands/GetCaseEventConfigurationCommand";
 import { GetDomainCommandInput, GetDomainCommandOutput } from "../commands/GetDomainCommand";
@@ -70,6 +71,10 @@ export declare const se_DeleteDomainCommand: (input: DeleteDomainCommandInput, c
  * serializeAws_restJson1GetCaseCommand
  */
 export declare const se_GetCaseCommand: (input: GetCaseCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1GetCaseAuditEventsCommand
+ */
+export declare const se_GetCaseAuditEventsCommand: (input: GetCaseAuditEventsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1GetCaseEventConfigurationCommand
  */
@@ -190,6 +195,10 @@ export declare const de_DeleteDomainCommand: (output: __HttpResponse, context: _
  * deserializeAws_restJson1GetCaseCommand
  */
 export declare const de_GetCaseCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetCaseCommandOutput>;
+/**
+ * deserializeAws_restJson1GetCaseAuditEventsCommand
+ */
+export declare const de_GetCaseAuditEventsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetCaseAuditEventsCommandOutput>;
 /**
  * deserializeAws_restJson1GetCaseEventConfigurationCommand
  */

package/dist-types/ts3.4/ConnectCases.d.ts

@@ -35,6 +35,10 @@ import {
   DeleteDomainCommandInput,
   DeleteDomainCommandOutput,
 } from "./commands/DeleteDomainCommand";
+import {
+  GetCaseAuditEventsCommandInput,
+  GetCaseAuditEventsCommandOutput,
+} from "./commands/GetCaseAuditEventsCommand";
 import {
   GetCaseCommandInput,
   GetCaseCommandOutput,
@@ -251,6 +255,19 @@ export interface ConnectCases {
     options: __HttpHandlerOptions,
     cb: (err: any, data?: GetCaseCommandOutput) => void
   ): void;
+  getCaseAuditEvents(
+    args: GetCaseAuditEventsCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<GetCaseAuditEventsCommandOutput>;
+  getCaseAuditEvents(
+    args: GetCaseAuditEventsCommandInput,
+    cb: (err: any, data?: GetCaseAuditEventsCommandOutput) => void
+  ): void;
+  getCaseAuditEvents(
+    args: GetCaseAuditEventsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: GetCaseAuditEventsCommandOutput) => void
+  ): void;
   getCaseEventConfiguration(
     args: GetCaseEventConfigurationCommandInput,
     options?: __HttpHandlerOptions

package/dist-types/ts3.4/ConnectCasesClient.d.ts

@@ -81,6 +81,10 @@ import {
   DeleteDomainCommandInput,
   DeleteDomainCommandOutput,
 } from "./commands/DeleteDomainCommand";
+import {
+  GetCaseAuditEventsCommandInput,
+  GetCaseAuditEventsCommandOutput,
+} from "./commands/GetCaseAuditEventsCommand";
 import {
   GetCaseCommandInput,
   GetCaseCommandOutput,
@@ -182,6 +186,7 @@ export type ServiceInputTypes =
   | CreateRelatedItemCommandInput
   | CreateTemplateCommandInput
   | DeleteDomainCommandInput
+  | GetCaseAuditEventsCommandInput
   | GetCaseCommandInput
   | GetCaseEventConfigurationCommandInput
   | GetDomainCommandInput
@@ -213,6 +218,7 @@ export type ServiceOutputTypes =
   | CreateRelatedItemCommandOutput
   | CreateTemplateCommandOutput
   | DeleteDomainCommandOutput
+  | GetCaseAuditEventsCommandOutput
   | GetCaseCommandOutput
   | GetCaseEventConfigurationCommandOutput
   | GetDomainCommandOutput

package/dist-types/ts3.4/commands/GetCaseAuditEventsCommand.d.ts

@@ -0,0 +1,30 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import {
+  ConnectCasesClientResolvedConfig,
+  ServiceInputTypes,
+  ServiceOutputTypes,
+} from "../ConnectCasesClient";
+import {
+  GetCaseAuditEventsRequest,
+  GetCaseAuditEventsResponse,
+} from "../models/models_0";
+export { __MetadataBearer, $Command };
+export interface GetCaseAuditEventsCommandInput
+  extends GetCaseAuditEventsRequest {}
+export interface GetCaseAuditEventsCommandOutput
+  extends GetCaseAuditEventsResponse,
+    __MetadataBearer {}
+declare const GetCaseAuditEventsCommand_base: {
+  new (
+    input: GetCaseAuditEventsCommandInput
+  ): import("@smithy/smithy-client").CommandImpl<
+    GetCaseAuditEventsCommandInput,
+    GetCaseAuditEventsCommandOutput,
+    ConnectCasesClientResolvedConfig,
+    ServiceInputTypes,
+    ServiceOutputTypes
+  >;
+  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+export declare class GetCaseAuditEventsCommand extends GetCaseAuditEventsCommand_base {}

package/dist-types/ts3.4/commands/index.d.ts

@@ -7,6 +7,7 @@ export * from "./CreateLayoutCommand";
 export * from "./CreateRelatedItemCommand";
 export * from "./CreateTemplateCommand";
 export * from "./DeleteDomainCommand";
+export * from "./GetCaseAuditEventsCommand";
 export * from "./GetCaseCommand";
 export * from "./GetCaseEventConfigurationCommand";
 export * from "./GetDomainCommand";