@aws-sdk/client-connectcases 3.296.0 → 3.297.0

package/dist-types/ConnectCases.d.ts

@@ -31,6 +31,7 @@ import { UpdateLayoutCommandInput, UpdateLayoutCommandOutput } from "./commands/
 import { UpdateTemplateCommandInput, UpdateTemplateCommandOutput } from "./commands/UpdateTemplateCommand";
 import { ConnectCasesClient } from "./ConnectCasesClient";
 /**
+ * @public
  * <p>With Amazon Connect Cases, your agents can track and manage customer issues that require
  *       multiple interactions, follow-up tasks, and teams in your contact center. A case represents a
  *       customer issue. It records the issue, the steps and interactions taken to resolve the issue,
@@ -39,12 +40,14 @@ import { ConnectCasesClient } from "./ConnectCasesClient";
  */
 export declare class ConnectCases extends ConnectCasesClient {
     /**
+     * @public
      * <p>Returns the description for the list of fields in the request parameters. </p>
      */
     batchGetField(args: BatchGetFieldCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetFieldCommandOutput>;
     batchGetField(args: BatchGetFieldCommandInput, cb: (err: any, data?: BatchGetFieldCommandOutput) => void): void;
     batchGetField(args: BatchGetFieldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetFieldCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates and updates a set of field options for a single select field in a Cases
      *       domain.</p>
      */
@@ -52,6 +55,7 @@ export declare class ConnectCases extends ConnectCasesClient {
     batchPutFieldOptions(args: BatchPutFieldOptionsCommandInput, cb: (err: any, data?: BatchPutFieldOptionsCommandOutput) => void): void;
     batchPutFieldOptions(args: BatchPutFieldOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchPutFieldOptionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a case in the specified Cases domain. Case system and custom fields are taken
      *       as an array id/value pairs with a declared data types.</p>
      *          <note>
@@ -78,6 +82,7 @@ export declare class ConnectCases extends ConnectCasesClient {
     createCase(args: CreateCaseCommandInput, cb: (err: any, data?: CreateCaseCommandOutput) => void): void;
     createCase(args: CreateCaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCaseCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a domain, which is a container for all case data, such as cases, fields, templates
      *       and layouts. Each Amazon Connect instance can be associated with only one Cases
      *       domain.</p>
@@ -93,6 +98,7 @@ export declare class ConnectCases extends ConnectCasesClient {
     createDomain(args: CreateDomainCommandInput, cb: (err: any, data?: CreateDomainCommandOutput) => void): void;
     createDomain(args: CreateDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDomainCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a field in the Cases domain. This field is used to define the case object
      *       model (that is, defines what data can be captured on cases) in a Cases domain. </p>
      */
@@ -100,6 +106,7 @@ export declare class ConnectCases extends ConnectCasesClient {
     createField(args: CreateFieldCommandInput, cb: (err: any, data?: CreateFieldCommandOutput) => void): void;
     createField(args: CreateFieldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFieldCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a layout in the Cases domain. Layouts define the following configuration in
      *       the top section and More Info tab of the Cases user interface:</p>
      *          <ul>
@@ -119,6 +126,7 @@ export declare class ConnectCases extends ConnectCasesClient {
     createLayout(args: CreateLayoutCommandInput, cb: (err: any, data?: CreateLayoutCommandOutput) => void): void;
     createLayout(args: CreateLayoutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLayoutCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a related item (comments, tasks, and contacts) and associates it with a
      *       case.</p>
      *          <note>
@@ -133,6 +141,7 @@ export declare class ConnectCases extends ConnectCasesClient {
     createRelatedItem(args: CreateRelatedItemCommandInput, cb: (err: any, data?: CreateRelatedItemCommandOutput) => void): void;
     createRelatedItem(args: CreateRelatedItemCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRelatedItemCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a template in the Cases domain. This template is used to define the case object
      *       model (that is, to define what data can be captured on cases) in a Cases domain. A template
      *       must have a unique name within a domain, and it must reference existing field IDs and layout
@@ -144,48 +153,56 @@ export declare class ConnectCases extends ConnectCasesClient {
     createTemplate(args: CreateTemplateCommandInput, cb: (err: any, data?: CreateTemplateCommandOutput) => void): void;
     createTemplate(args: CreateTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTemplateCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a domain.</p>
      */
     deleteDomain(args: DeleteDomainCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDomainCommandOutput>;
     deleteDomain(args: DeleteDomainCommandInput, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void;
     deleteDomain(args: DeleteDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDomainCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns information about a specific case if it exists. </p>
      */
     getCase(args: GetCaseCommandInput, options?: __HttpHandlerOptions): Promise<GetCaseCommandOutput>;
     getCase(args: GetCaseCommandInput, cb: (err: any, data?: GetCaseCommandOutput) => void): void;
     getCase(args: GetCaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCaseCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns the case event publishing configuration.</p>
      */
     getCaseEventConfiguration(args: GetCaseEventConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetCaseEventConfigurationCommandOutput>;
     getCaseEventConfiguration(args: GetCaseEventConfigurationCommandInput, cb: (err: any, data?: GetCaseEventConfigurationCommandOutput) => void): void;
     getCaseEventConfiguration(args: GetCaseEventConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCaseEventConfigurationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns information about a specific domain if it exists. </p>
      */
     getDomain(args: GetDomainCommandInput, options?: __HttpHandlerOptions): Promise<GetDomainCommandOutput>;
     getDomain(args: GetDomainCommandInput, cb: (err: any, data?: GetDomainCommandOutput) => void): void;
     getDomain(args: GetDomainCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDomainCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns the details for the requested layout.</p>
      */
     getLayout(args: GetLayoutCommandInput, options?: __HttpHandlerOptions): Promise<GetLayoutCommandOutput>;
     getLayout(args: GetLayoutCommandInput, cb: (err: any, data?: GetLayoutCommandOutput) => void): void;
     getLayout(args: GetLayoutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLayoutCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns the details for the requested template. </p>
      */
     getTemplate(args: GetTemplateCommandInput, options?: __HttpHandlerOptions): Promise<GetTemplateCommandOutput>;
     getTemplate(args: GetTemplateCommandInput, cb: (err: any, data?: GetTemplateCommandOutput) => void): void;
     getTemplate(args: GetTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTemplateCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists cases for a given contact.</p>
      */
     listCasesForContact(args: ListCasesForContactCommandInput, options?: __HttpHandlerOptions): Promise<ListCasesForContactCommandOutput>;
     listCasesForContact(args: ListCasesForContactCommandInput, cb: (err: any, data?: ListCasesForContactCommandOutput) => void): void;
     listCasesForContact(args: ListCasesForContactCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCasesForContactCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists all cases domains in the Amazon Web Services account. Each list item is a condensed
      *       summary object of the domain.</p>
      */
@@ -193,18 +210,21 @@ export declare class ConnectCases extends ConnectCasesClient {
     listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void;
     listDomains(args: ListDomainsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDomainsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists all of the field options for a field identifier in the domain. </p>
      */
     listFieldOptions(args: ListFieldOptionsCommandInput, options?: __HttpHandlerOptions): Promise<ListFieldOptionsCommandOutput>;
     listFieldOptions(args: ListFieldOptionsCommandInput, cb: (err: any, data?: ListFieldOptionsCommandOutput) => void): void;
     listFieldOptions(args: ListFieldOptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFieldOptionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists all fields in a Cases domain.</p>
      */
     listFields(args: ListFieldsCommandInput, options?: __HttpHandlerOptions): Promise<ListFieldsCommandOutput>;
     listFields(args: ListFieldsCommandInput, cb: (err: any, data?: ListFieldsCommandOutput) => void): void;
     listFields(args: ListFieldsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFieldsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists all layouts in the given cases domain. Each list item is a condensed summary object
      *       of the layout.</p>
      */
@@ -212,12 +232,14 @@ export declare class ConnectCases extends ConnectCasesClient {
     listLayouts(args: ListLayoutsCommandInput, cb: (err: any, data?: ListLayoutsCommandOutput) => void): void;
     listLayouts(args: ListLayoutsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLayoutsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists tags for a resource.</p>
      */
     listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
     listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists all of the templates in a Cases domain. Each list item is a condensed summary
      *       object of the template. </p>
      */
@@ -225,12 +247,14 @@ export declare class ConnectCases extends ConnectCasesClient {
     listTemplates(args: ListTemplatesCommandInput, cb: (err: any, data?: ListTemplatesCommandOutput) => void): void;
     listTemplates(args: ListTemplatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTemplatesCommandOutput) => void): void;
     /**
+     * @public
      * <p>API for adding case event publishing configuration</p>
      */
     putCaseEventConfiguration(args: PutCaseEventConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutCaseEventConfigurationCommandOutput>;
     putCaseEventConfiguration(args: PutCaseEventConfigurationCommandInput, cb: (err: any, data?: PutCaseEventConfigurationCommandOutput) => void): void;
     putCaseEventConfiguration(args: PutCaseEventConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutCaseEventConfigurationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Searches for cases within their associated Cases domain. Search results are returned
      *       as a paginated list of abridged case documents.</p>
      *          <note>
@@ -243,6 +267,7 @@ export declare class ConnectCases extends ConnectCasesClient {
     searchCases(args: SearchCasesCommandInput, cb: (err: any, data?: SearchCasesCommandOutput) => void): void;
     searchCases(args: SearchCasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchCasesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Searches for related items that are associated with a case.</p>
      *          <note>
      *             <p>If no filters are provided, this returns all related items associated with a
@@ -253,18 +278,21 @@ export declare class ConnectCases extends ConnectCasesClient {
     searchRelatedItems(args: SearchRelatedItemsCommandInput, cb: (err: any, data?: SearchRelatedItemsCommandOutput) => void): void;
     searchRelatedItems(args: SearchRelatedItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchRelatedItemsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Adds tags to a resource.</p>
      */
     tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Untags a resource.</p>
      */
     untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
     untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the values of fields on a case. Fields to be updated are received as an array of
      *       id/value pairs identical to the <code>CreateCase</code> input .</p>
      *          <p>If the action is successful, the service sends back an HTTP 200 response with an empty
@@ -274,12 +302,14 @@ export declare class ConnectCases extends ConnectCasesClient {
     updateCase(args: UpdateCaseCommandInput, cb: (err: any, data?: UpdateCaseCommandOutput) => void): void;
     updateCase(args: UpdateCaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCaseCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the properties of an existing field. </p>
      */
     updateField(args: UpdateFieldCommandInput, options?: __HttpHandlerOptions): Promise<UpdateFieldCommandOutput>;
     updateField(args: UpdateFieldCommandInput, cb: (err: any, data?: UpdateFieldCommandOutput) => void): void;
     updateField(args: UpdateFieldCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFieldCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the attributes of an existing layout.</p>
      *          <p>If the action is successful, the service sends back an HTTP 200 response with an empty
      *       HTTP body.</p>
@@ -294,6 +324,7 @@ export declare class ConnectCases extends ConnectCasesClient {
     updateLayout(args: UpdateLayoutCommandInput, cb: (err: any, data?: UpdateLayoutCommandOutput) => void): void;
     updateLayout(args: UpdateLayoutCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateLayoutCommandOutput) => void): void;
     /**
+     * @public
      * <p>Updates the attributes of an existing template. The template attributes that can be
      *       modified include <code>name</code>, <code>description</code>,
      *       <code>layoutConfiguration</code>, <code>requiredFields</code>, and <code>status</code>. At

package/dist-types/ConnectCasesClient.d.ts

@@ -38,15 +38,24 @@ import { UpdateFieldCommandInput, UpdateFieldCommandOutput } from "./commands/Up
 import { UpdateLayoutCommandInput, UpdateLayoutCommandOutput } from "./commands/UpdateLayoutCommand";
 import { UpdateTemplateCommandInput, UpdateTemplateCommandOutput } from "./commands/UpdateTemplateCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = BatchGetFieldCommandInput | BatchPutFieldOptionsCommandInput | CreateCaseCommandInput | CreateDomainCommandInput | CreateFieldCommandInput | CreateLayoutCommandInput | CreateRelatedItemCommandInput | CreateTemplateCommandInput | DeleteDomainCommandInput | GetCaseCommandInput | GetCaseEventConfigurationCommandInput | GetDomainCommandInput | GetLayoutCommandInput | GetTemplateCommandInput | ListCasesForContactCommandInput | ListDomainsCommandInput | ListFieldOptionsCommandInput | ListFieldsCommandInput | ListLayoutsCommandInput | ListTagsForResourceCommandInput | ListTemplatesCommandInput | PutCaseEventConfigurationCommandInput | SearchCasesCommandInput | SearchRelatedItemsCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateCaseCommandInput | UpdateFieldCommandInput | UpdateLayoutCommandInput | UpdateTemplateCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = BatchGetFieldCommandOutput | BatchPutFieldOptionsCommandOutput | CreateCaseCommandOutput | CreateDomainCommandOutput | CreateFieldCommandOutput | CreateLayoutCommandOutput | CreateRelatedItemCommandOutput | CreateTemplateCommandOutput | DeleteDomainCommandOutput | GetCaseCommandOutput | GetCaseEventConfigurationCommandOutput | GetDomainCommandOutput | GetLayoutCommandOutput | GetTemplateCommandOutput | ListCasesForContactCommandOutput | ListDomainsCommandOutput | ListFieldOptionsCommandOutput | ListFieldsCommandOutput | ListLayoutsCommandOutput | ListTagsForResourceCommandOutput | ListTemplatesCommandOutput | PutCaseEventConfigurationCommandOutput | SearchCasesCommandOutput | SearchRelatedItemsCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateCaseCommandOutput | UpdateFieldCommandOutput | UpdateLayoutCommandOutput | UpdateTemplateCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -136,23 +145,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type ConnectCasesClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of ConnectCasesClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of ConnectCasesClient class constructor that set the region, credentials and other options.
  */
 export interface ConnectCasesClientConfig extends ConnectCasesClientConfigType {
 }
+/**
+ * @public
+ */
 type ConnectCasesClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of ConnectCasesClient class. This is resolved and normalized from the {@link ConnectCasesClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of ConnectCasesClient class. This is resolved and normalized from the {@link ConnectCasesClientConfig | constructor configuration interface}.
  */
 export interface ConnectCasesClientResolvedConfig extends ConnectCasesClientResolvedConfigType {
 }
 /**
+ * @public
  * <p>With Amazon Connect Cases, your agents can track and manage customer issues that require
  *       multiple interactions, follow-up tasks, and teams in your contact center. A case represents a
  *       customer issue. It records the issue, the steps and interactions taken to resolve the issue,

package/dist-types/commands/BatchGetFieldCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
 import { BatchGetFieldRequest, BatchGetFieldResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BatchGetFieldCommand}.
  */
 export interface BatchGetFieldCommandInput extends BatchGetFieldRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchGetFieldCommand}.
  */
 export interface BatchGetFieldCommandOutput extends BatchGetFieldResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns the description for the list of fields in the request parameters. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface BatchGetFieldCommandOutput extends BatchGetFieldResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchGetFieldCommandInput - {@link BatchGetFieldCommandInput}
+ * @returns {@link BatchGetFieldCommandOutput}
  * @see {@link BatchGetFieldCommandInput} for command's `input` shape.
  * @see {@link BatchGetFieldCommandOutput} for command's `response` shape.
  * @see {@link ConnectCasesClientResolvedConfig | config} for ConnectCasesClient's `config` shape.
@@ -51,11 +58,20 @@ export interface BatchGetFieldCommandOutput extends BatchGetFieldResponse, __Met
 export declare class BatchGetFieldCommand extends $Command<BatchGetFieldCommandInput, BatchGetFieldCommandOutput, ConnectCasesClientResolvedConfig> {
     readonly input: BatchGetFieldCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchGetFieldCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCasesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchGetFieldCommandInput, BatchGetFieldCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/BatchPutFieldOptionsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
 import { BatchPutFieldOptionsRequest, BatchPutFieldOptionsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BatchPutFieldOptionsCommand}.
  */
 export interface BatchPutFieldOptionsCommandInput extends BatchPutFieldOptionsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchPutFieldOptionsCommand}.
  */
 export interface BatchPutFieldOptionsCommandOutput extends BatchPutFieldOptionsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates and updates a set of field options for a single select field in a Cases
  *       domain.</p>
  * @example
@@ -26,6 +31,8 @@ export interface BatchPutFieldOptionsCommandOutput extends BatchPutFieldOptionsR
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchPutFieldOptionsCommandInput - {@link BatchPutFieldOptionsCommandInput}
+ * @returns {@link BatchPutFieldOptionsCommandOutput}
  * @see {@link BatchPutFieldOptionsCommandInput} for command's `input` shape.
  * @see {@link BatchPutFieldOptionsCommandOutput} for command's `response` shape.
  * @see {@link ConnectCasesClientResolvedConfig | config} for ConnectCasesClient's `config` shape.
@@ -56,11 +63,20 @@ export interface BatchPutFieldOptionsCommandOutput extends BatchPutFieldOptionsR
 export declare class BatchPutFieldOptionsCommand extends $Command<BatchPutFieldOptionsCommandInput, BatchPutFieldOptionsCommandOutput, ConnectCasesClientResolvedConfig> {
     readonly input: BatchPutFieldOptionsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchPutFieldOptionsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCasesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchPutFieldOptionsCommandInput, BatchPutFieldOptionsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateCaseCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
 import { CreateCaseRequest, CreateCaseResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateCaseCommand}.
  */
 export interface CreateCaseCommandInput extends CreateCaseRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateCaseCommand}.
  */
 export interface CreateCaseCommandOutput extends CreateCaseResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a case in the specified Cases domain. Case system and custom fields are taken
  *       as an array id/value pairs with a declared data types.</p>
  *          <note>
@@ -45,6 +50,8 @@ export interface CreateCaseCommandOutput extends CreateCaseResponse, __MetadataB
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateCaseCommandInput - {@link CreateCaseCommandInput}
+ * @returns {@link CreateCaseCommandOutput}
  * @see {@link CreateCaseCommandInput} for command's `input` shape.
  * @see {@link CreateCaseCommandOutput} for command's `response` shape.
  * @see {@link ConnectCasesClientResolvedConfig | config} for ConnectCasesClient's `config` shape.
@@ -76,11 +83,20 @@ export interface CreateCaseCommandOutput extends CreateCaseResponse, __MetadataB
 export declare class CreateCaseCommand extends $Command<CreateCaseCommandInput, CreateCaseCommandOutput, ConnectCasesClientResolvedConfig> {
     readonly input: CreateCaseCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateCaseCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCasesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateCaseCommandInput, CreateCaseCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateDomainCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
 import { CreateDomainRequest, CreateDomainResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateDomainCommand}.
  */
 export interface CreateDomainCommandInput extends CreateDomainRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateDomainCommand}.
  */
 export interface CreateDomainCommandOutput extends CreateDomainResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a domain, which is a container for all case data, such as cases, fields, templates
  *       and layouts. Each Amazon Connect instance can be associated with only one Cases
  *       domain.</p>
@@ -34,6 +39,8 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateDomainCommandInput - {@link CreateDomainCommandInput}
+ * @returns {@link CreateDomainCommandOutput}
  * @see {@link CreateDomainCommandInput} for command's `input` shape.
  * @see {@link CreateDomainCommandOutput} for command's `response` shape.
  * @see {@link ConnectCasesClientResolvedConfig | config} for ConnectCasesClient's `config` shape.
@@ -65,11 +72,20 @@ export interface CreateDomainCommandOutput extends CreateDomainResponse, __Metad
 export declare class CreateDomainCommand extends $Command<CreateDomainCommandInput, CreateDomainCommandOutput, ConnectCasesClientResolvedConfig> {
     readonly input: CreateDomainCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateDomainCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCasesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDomainCommandInput, CreateDomainCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateFieldCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
 import { CreateFieldRequest, CreateFieldResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateFieldCommand}.
  */
 export interface CreateFieldCommandInput extends CreateFieldRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateFieldCommand}.
  */
 export interface CreateFieldCommandOutput extends CreateFieldResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a field in the Cases domain. This field is used to define the case object
  *       model (that is, defines what data can be captured on cases) in a Cases domain. </p>
  * @example
@@ -26,6 +31,8 @@ export interface CreateFieldCommandOutput extends CreateFieldResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateFieldCommandInput - {@link CreateFieldCommandInput}
+ * @returns {@link CreateFieldCommandOutput}
  * @see {@link CreateFieldCommandInput} for command's `input` shape.
  * @see {@link CreateFieldCommandOutput} for command's `response` shape.
  * @see {@link ConnectCasesClientResolvedConfig | config} for ConnectCasesClient's `config` shape.
@@ -61,11 +68,20 @@ export interface CreateFieldCommandOutput extends CreateFieldResponse, __Metadat
 export declare class CreateFieldCommand extends $Command<CreateFieldCommandInput, CreateFieldCommandOutput, ConnectCasesClientResolvedConfig> {
     readonly input: CreateFieldCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateFieldCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCasesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateFieldCommandInput, CreateFieldCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateLayoutCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
 import { CreateLayoutRequest, CreateLayoutResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateLayoutCommand}.
  */
 export interface CreateLayoutCommandInput extends CreateLayoutRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateLayoutCommand}.
  */
 export interface CreateLayoutCommandOutput extends CreateLayoutResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a layout in the Cases domain. Layouts define the following configuration in
  *       the top section and More Info tab of the Cases user interface:</p>
  *          <ul>
@@ -38,6 +43,8 @@ export interface CreateLayoutCommandOutput extends CreateLayoutResponse, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateLayoutCommandInput - {@link CreateLayoutCommandInput}
+ * @returns {@link CreateLayoutCommandOutput}
  * @see {@link CreateLayoutCommandInput} for command's `input` shape.
  * @see {@link CreateLayoutCommandOutput} for command's `response` shape.
  * @see {@link ConnectCasesClientResolvedConfig | config} for ConnectCasesClient's `config` shape.
@@ -73,11 +80,20 @@ export interface CreateLayoutCommandOutput extends CreateLayoutResponse, __Metad
 export declare class CreateLayoutCommand extends $Command<CreateLayoutCommandInput, CreateLayoutCommandOutput, ConnectCasesClientResolvedConfig> {
     readonly input: CreateLayoutCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateLayoutCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCasesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateLayoutCommandInput, CreateLayoutCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/CreateRelatedItemCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ConnectCasesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectCasesClient";
 import { CreateRelatedItemRequest, CreateRelatedItemResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateRelatedItemCommand}.
  */
 export interface CreateRelatedItemCommandInput extends CreateRelatedItemRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateRelatedItemCommand}.
  */
 export interface CreateRelatedItemCommandOutput extends CreateRelatedItemResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a related item (comments, tasks, and contacts) and associates it with a
  *       case.</p>
  *          <note>
@@ -33,6 +38,8 @@ export interface CreateRelatedItemCommandOutput extends CreateRelatedItemRespons
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateRelatedItemCommandInput - {@link CreateRelatedItemCommandInput}
+ * @returns {@link CreateRelatedItemCommandOutput}
  * @see {@link CreateRelatedItemCommandInput} for command's `input` shape.
  * @see {@link CreateRelatedItemCommandOutput} for command's `response` shape.
  * @see {@link ConnectCasesClientResolvedConfig | config} for ConnectCasesClient's `config` shape.
@@ -63,11 +70,20 @@ export interface CreateRelatedItemCommandOutput extends CreateRelatedItemRespons
 export declare class CreateRelatedItemCommand extends $Command<CreateRelatedItemCommandInput, CreateRelatedItemCommandOutput, ConnectCasesClientResolvedConfig> {
     readonly input: CreateRelatedItemCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateRelatedItemCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ConnectCasesClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateRelatedItemCommandInput, CreateRelatedItemCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }