@aws-sdk/client-qconnect 3.693.0 → 3.696.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 (105) hide show
  1. package/README.md +112 -0
  2. package/dist-cjs/index.js +1279 -149
  3. package/dist-es/QConnect.js +28 -0
  4. package/dist-es/commands/ActivateMessageTemplateCommand.js +22 -0
  5. package/dist-es/commands/CreateMessageTemplateAttachmentCommand.js +23 -0
  6. package/dist-es/commands/CreateMessageTemplateCommand.js +23 -0
  7. package/dist-es/commands/CreateMessageTemplateVersionCommand.js +23 -0
  8. package/dist-es/commands/DeactivateMessageTemplateCommand.js +22 -0
  9. package/dist-es/commands/DeleteMessageTemplateAttachmentCommand.js +22 -0
  10. package/dist-es/commands/DeleteMessageTemplateCommand.js +22 -0
  11. package/dist-es/commands/GetMessageTemplateCommand.js +23 -0
  12. package/dist-es/commands/GetRecommendationsCommand.js +1 -1
  13. package/dist-es/commands/ListMessageTemplateVersionsCommand.js +22 -0
  14. package/dist-es/commands/ListMessageTemplatesCommand.js +22 -0
  15. package/dist-es/commands/QueryAssistantCommand.js +2 -1
  16. package/dist-es/commands/RenderMessageTemplateCommand.js +23 -0
  17. package/dist-es/commands/SearchMessageTemplatesCommand.js +23 -0
  18. package/dist-es/commands/SearchQuickResponsesCommand.js +1 -1
  19. package/dist-es/commands/StartContentUploadCommand.js +1 -1
  20. package/dist-es/commands/StartImportJobCommand.js +1 -1
  21. package/dist-es/commands/UpdateKnowledgeBaseTemplateUriCommand.js +1 -1
  22. package/dist-es/commands/UpdateMessageTemplateCommand.js +23 -0
  23. package/dist-es/commands/UpdateMessageTemplateMetadataCommand.js +23 -0
  24. package/dist-es/commands/index.js +14 -0
  25. package/dist-es/models/index.js +1 -0
  26. package/dist-es/models/models_0.js +280 -152
  27. package/dist-es/models/models_1.js +138 -0
  28. package/dist-es/pagination/ListMessageTemplateVersionsPaginator.js +4 -0
  29. package/dist-es/pagination/ListMessageTemplatesPaginator.js +4 -0
  30. package/dist-es/pagination/SearchMessageTemplatesPaginator.js +4 -0
  31. package/dist-es/pagination/index.js +3 -0
  32. package/dist-es/protocols/Aws_restJson1.js +527 -5
  33. package/dist-types/QConnect.d.ts +98 -0
  34. package/dist-types/QConnectClient.d.ts +16 -2
  35. package/dist-types/commands/ActivateMessageTemplateCommand.d.ts +96 -0
  36. package/dist-types/commands/CreateMessageTemplateAttachmentCommand.d.ts +109 -0
  37. package/dist-types/commands/CreateMessageTemplateCommand.d.ts +347 -0
  38. package/dist-types/commands/CreateMessageTemplateVersionCommand.d.ts +247 -0
  39. package/dist-types/commands/DeactivateMessageTemplateCommand.d.ts +95 -0
  40. package/dist-types/commands/DeleteMessageTemplateAttachmentCommand.d.ts +91 -0
  41. package/dist-types/commands/DeleteMessageTemplateCommand.d.ts +92 -0
  42. package/dist-types/commands/GetMessageTemplateCommand.d.ts +231 -0
  43. package/dist-types/commands/GetRecommendationsCommand.d.ts +2 -1
  44. package/dist-types/commands/ListMessageTemplateVersionsCommand.d.ts +99 -0
  45. package/dist-types/commands/ListMessageTemplatesCommand.d.ts +104 -0
  46. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  47. package/dist-types/commands/QueryAssistantCommand.d.ts +2 -1
  48. package/dist-types/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +2 -1
  49. package/dist-types/commands/RenderMessageTemplateCommand.d.ts +206 -0
  50. package/dist-types/commands/SearchContentCommand.d.ts +1 -1
  51. package/dist-types/commands/SearchMessageTemplatesCommand.d.ts +138 -0
  52. package/dist-types/commands/SearchQuickResponsesCommand.d.ts +1 -1
  53. package/dist-types/commands/StartContentUploadCommand.d.ts +1 -1
  54. package/dist-types/commands/StartImportJobCommand.d.ts +1 -1
  55. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  56. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  57. package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +1 -1
  58. package/dist-types/commands/UpdateMessageTemplateCommand.d.ts +332 -0
  59. package/dist-types/commands/UpdateMessageTemplateMetadataCommand.d.ts +233 -0
  60. package/dist-types/commands/index.d.ts +14 -0
  61. package/dist-types/models/index.d.ts +1 -0
  62. package/dist-types/models/models_0.d.ts +1639 -983
  63. package/dist-types/models/models_1.d.ts +1256 -0
  64. package/dist-types/pagination/ListMessageTemplateVersionsPaginator.d.ts +7 -0
  65. package/dist-types/pagination/ListMessageTemplatesPaginator.d.ts +7 -0
  66. package/dist-types/pagination/SearchMessageTemplatesPaginator.d.ts +7 -0
  67. package/dist-types/pagination/index.d.ts +3 -0
  68. package/dist-types/protocols/Aws_restJson1.d.ts +126 -0
  69. package/dist-types/ts3.4/QConnect.d.ts +238 -0
  70. package/dist-types/ts3.4/QConnectClient.d.ts +84 -0
  71. package/dist-types/ts3.4/commands/ActivateMessageTemplateCommand.d.ts +51 -0
  72. package/dist-types/ts3.4/commands/CreateMessageTemplateAttachmentCommand.d.ts +51 -0
  73. package/dist-types/ts3.4/commands/CreateMessageTemplateCommand.d.ts +51 -0
  74. package/dist-types/ts3.4/commands/CreateMessageTemplateVersionCommand.d.ts +51 -0
  75. package/dist-types/ts3.4/commands/DeactivateMessageTemplateCommand.d.ts +51 -0
  76. package/dist-types/ts3.4/commands/DeleteMessageTemplateAttachmentCommand.d.ts +51 -0
  77. package/dist-types/ts3.4/commands/DeleteMessageTemplateCommand.d.ts +51 -0
  78. package/dist-types/ts3.4/commands/GetMessageTemplateCommand.d.ts +51 -0
  79. package/dist-types/ts3.4/commands/GetRecommendationsCommand.d.ts +2 -4
  80. package/dist-types/ts3.4/commands/ListMessageTemplateVersionsCommand.d.ts +51 -0
  81. package/dist-types/ts3.4/commands/ListMessageTemplatesCommand.d.ts +51 -0
  82. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
  83. package/dist-types/ts3.4/commands/QueryAssistantCommand.d.ts +2 -4
  84. package/dist-types/ts3.4/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +2 -4
  85. package/dist-types/ts3.4/commands/RenderMessageTemplateCommand.d.ts +51 -0
  86. package/dist-types/ts3.4/commands/SearchContentCommand.d.ts +1 -1
  87. package/dist-types/ts3.4/commands/SearchMessageTemplatesCommand.d.ts +51 -0
  88. package/dist-types/ts3.4/commands/SearchQuickResponsesCommand.d.ts +1 -1
  89. package/dist-types/ts3.4/commands/StartContentUploadCommand.d.ts +1 -1
  90. package/dist-types/ts3.4/commands/StartImportJobCommand.d.ts +1 -1
  91. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  92. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
  93. package/dist-types/ts3.4/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +1 -1
  94. package/dist-types/ts3.4/commands/UpdateMessageTemplateCommand.d.ts +51 -0
  95. package/dist-types/ts3.4/commands/UpdateMessageTemplateMetadataCommand.d.ts +51 -0
  96. package/dist-types/ts3.4/commands/index.d.ts +14 -0
  97. package/dist-types/ts3.4/models/index.d.ts +1 -0
  98. package/dist-types/ts3.4/models/models_0.d.ts +466 -284
  99. package/dist-types/ts3.4/models/models_1.d.ts +349 -0
  100. package/dist-types/ts3.4/pagination/ListMessageTemplateVersionsPaginator.d.ts +11 -0
  101. package/dist-types/ts3.4/pagination/ListMessageTemplatesPaginator.d.ts +11 -0
  102. package/dist-types/ts3.4/pagination/SearchMessageTemplatesPaginator.d.ts +11 -0
  103. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  104. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +168 -0
  105. package/package.json +35 -35
@@ -0,0 +1,95 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { DeactivateMessageTemplateRequest, DeactivateMessageTemplateResponse } from "../models/models_0";
4
+ import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeactivateMessageTemplateCommand}.
14
+ */
15
+ export interface DeactivateMessageTemplateCommandInput extends DeactivateMessageTemplateRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeactivateMessageTemplateCommand}.
21
+ */
22
+ export interface DeactivateMessageTemplateCommandOutput extends DeactivateMessageTemplateResponse, __MetadataBearer {
23
+ }
24
+ declare const DeactivateMessageTemplateCommand_base: {
25
+ new (input: DeactivateMessageTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<DeactivateMessageTemplateCommandInput, DeactivateMessageTemplateCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DeactivateMessageTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<DeactivateMessageTemplateCommandInput, DeactivateMessageTemplateCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Deactivates a specific version of the Amazon Q in Connect message template . After the
31
+ * version is deactivated, you can no longer use the <code>$ACTIVE_VERSION</code> qualifier to
32
+ * reference the version in active status.</p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { QConnectClient, DeactivateMessageTemplateCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
37
+ * // const { QConnectClient, DeactivateMessageTemplateCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
38
+ * const client = new QConnectClient(config);
39
+ * const input = { // DeactivateMessageTemplateRequest
40
+ * knowledgeBaseId: "STRING_VALUE", // required
41
+ * messageTemplateId: "STRING_VALUE", // required
42
+ * versionNumber: Number("long"), // required
43
+ * };
44
+ * const command = new DeactivateMessageTemplateCommand(input);
45
+ * const response = await client.send(command);
46
+ * // { // DeactivateMessageTemplateResponse
47
+ * // messageTemplateArn: "STRING_VALUE", // required
48
+ * // messageTemplateId: "STRING_VALUE", // required
49
+ * // versionNumber: Number("long"), // required
50
+ * // };
51
+ *
52
+ * ```
53
+ *
54
+ * @param DeactivateMessageTemplateCommandInput - {@link DeactivateMessageTemplateCommandInput}
55
+ * @returns {@link DeactivateMessageTemplateCommandOutput}
56
+ * @see {@link DeactivateMessageTemplateCommandInput} for command's `input` shape.
57
+ * @see {@link DeactivateMessageTemplateCommandOutput} for command's `response` shape.
58
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
59
+ *
60
+ * @throws {@link AccessDeniedException} (client fault)
61
+ * <p>You do not have sufficient access to perform this action.</p>
62
+ *
63
+ * @throws {@link ConflictException} (client fault)
64
+ * <p>The request could not be processed because of conflict in the current state of the
65
+ * resource. For example, if you're using a <code>Create</code> API (such as
66
+ * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
67
+ * same name) is being created or mutated.</p>
68
+ *
69
+ * @throws {@link ResourceNotFoundException} (client fault)
70
+ * <p>The specified resource does not exist.</p>
71
+ *
72
+ * @throws {@link ThrottlingException} (client fault)
73
+ * <p>The throttling limit has been exceeded.</p>
74
+ *
75
+ * @throws {@link ValidationException} (client fault)
76
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
77
+ *
78
+ * @throws {@link QConnectServiceException}
79
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
80
+ *
81
+ * @public
82
+ */
83
+ export declare class DeactivateMessageTemplateCommand extends DeactivateMessageTemplateCommand_base {
84
+ /** @internal type navigation helper, not in runtime. */
85
+ protected static __types: {
86
+ api: {
87
+ input: DeactivateMessageTemplateRequest;
88
+ output: DeactivateMessageTemplateResponse;
89
+ };
90
+ sdk: {
91
+ input: DeactivateMessageTemplateCommandInput;
92
+ output: DeactivateMessageTemplateCommandOutput;
93
+ };
94
+ };
95
+ }
@@ -0,0 +1,91 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { DeleteMessageTemplateAttachmentRequest, DeleteMessageTemplateAttachmentResponse } from "../models/models_0";
4
+ import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteMessageTemplateAttachmentCommand}.
14
+ */
15
+ export interface DeleteMessageTemplateAttachmentCommandInput extends DeleteMessageTemplateAttachmentRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteMessageTemplateAttachmentCommand}.
21
+ */
22
+ export interface DeleteMessageTemplateAttachmentCommandOutput extends DeleteMessageTemplateAttachmentResponse, __MetadataBearer {
23
+ }
24
+ declare const DeleteMessageTemplateAttachmentCommand_base: {
25
+ new (input: DeleteMessageTemplateAttachmentCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteMessageTemplateAttachmentCommandInput, DeleteMessageTemplateAttachmentCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DeleteMessageTemplateAttachmentCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteMessageTemplateAttachmentCommandInput, DeleteMessageTemplateAttachmentCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Deletes the attachment file from the Amazon Q in Connect message template that is
31
+ * referenced by <code>$LATEST</code> qualifier. Attachments on available message template
32
+ * versions will remain unchanged.</p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { QConnectClient, DeleteMessageTemplateAttachmentCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
37
+ * // const { QConnectClient, DeleteMessageTemplateAttachmentCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
38
+ * const client = new QConnectClient(config);
39
+ * const input = { // DeleteMessageTemplateAttachmentRequest
40
+ * knowledgeBaseId: "STRING_VALUE", // required
41
+ * messageTemplateId: "STRING_VALUE", // required
42
+ * attachmentId: "STRING_VALUE", // required
43
+ * };
44
+ * const command = new DeleteMessageTemplateAttachmentCommand(input);
45
+ * const response = await client.send(command);
46
+ * // {};
47
+ *
48
+ * ```
49
+ *
50
+ * @param DeleteMessageTemplateAttachmentCommandInput - {@link DeleteMessageTemplateAttachmentCommandInput}
51
+ * @returns {@link DeleteMessageTemplateAttachmentCommandOutput}
52
+ * @see {@link DeleteMessageTemplateAttachmentCommandInput} for command's `input` shape.
53
+ * @see {@link DeleteMessageTemplateAttachmentCommandOutput} for command's `response` shape.
54
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
55
+ *
56
+ * @throws {@link AccessDeniedException} (client fault)
57
+ * <p>You do not have sufficient access to perform this action.</p>
58
+ *
59
+ * @throws {@link ConflictException} (client fault)
60
+ * <p>The request could not be processed because of conflict in the current state of the
61
+ * resource. For example, if you're using a <code>Create</code> API (such as
62
+ * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
63
+ * same name) is being created or mutated.</p>
64
+ *
65
+ * @throws {@link ResourceNotFoundException} (client fault)
66
+ * <p>The specified resource does not exist.</p>
67
+ *
68
+ * @throws {@link ThrottlingException} (client fault)
69
+ * <p>The throttling limit has been exceeded.</p>
70
+ *
71
+ * @throws {@link ValidationException} (client fault)
72
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
73
+ *
74
+ * @throws {@link QConnectServiceException}
75
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
76
+ *
77
+ * @public
78
+ */
79
+ export declare class DeleteMessageTemplateAttachmentCommand extends DeleteMessageTemplateAttachmentCommand_base {
80
+ /** @internal type navigation helper, not in runtime. */
81
+ protected static __types: {
82
+ api: {
83
+ input: DeleteMessageTemplateAttachmentRequest;
84
+ output: {};
85
+ };
86
+ sdk: {
87
+ input: DeleteMessageTemplateAttachmentCommandInput;
88
+ output: DeleteMessageTemplateAttachmentCommandOutput;
89
+ };
90
+ };
91
+ }
@@ -0,0 +1,92 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { DeleteMessageTemplateRequest, DeleteMessageTemplateResponse } from "../models/models_0";
4
+ import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteMessageTemplateCommand}.
14
+ */
15
+ export interface DeleteMessageTemplateCommandInput extends DeleteMessageTemplateRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteMessageTemplateCommand}.
21
+ */
22
+ export interface DeleteMessageTemplateCommandOutput extends DeleteMessageTemplateResponse, __MetadataBearer {
23
+ }
24
+ declare const DeleteMessageTemplateCommand_base: {
25
+ new (input: DeleteMessageTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteMessageTemplateCommandInput, DeleteMessageTemplateCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DeleteMessageTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteMessageTemplateCommandInput, DeleteMessageTemplateCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Deletes an Amazon Q in Connect message template entirely or a specific version of the
31
+ * message template if version is supplied in the request. You can provide the message template
32
+ * identifier as <code>&lt;message-template-id&gt;:&lt;versionNumber&gt;</code> to delete a
33
+ * specific version of the message template. If it is not supplied, the message template and all
34
+ * available versions will be deleted.</p>
35
+ * @example
36
+ * Use a bare-bones client and the command you need to make an API call.
37
+ * ```javascript
38
+ * import { QConnectClient, DeleteMessageTemplateCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
39
+ * // const { QConnectClient, DeleteMessageTemplateCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
40
+ * const client = new QConnectClient(config);
41
+ * const input = { // DeleteMessageTemplateRequest
42
+ * knowledgeBaseId: "STRING_VALUE", // required
43
+ * messageTemplateId: "STRING_VALUE", // required
44
+ * };
45
+ * const command = new DeleteMessageTemplateCommand(input);
46
+ * const response = await client.send(command);
47
+ * // {};
48
+ *
49
+ * ```
50
+ *
51
+ * @param DeleteMessageTemplateCommandInput - {@link DeleteMessageTemplateCommandInput}
52
+ * @returns {@link DeleteMessageTemplateCommandOutput}
53
+ * @see {@link DeleteMessageTemplateCommandInput} for command's `input` shape.
54
+ * @see {@link DeleteMessageTemplateCommandOutput} for command's `response` shape.
55
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
56
+ *
57
+ * @throws {@link AccessDeniedException} (client fault)
58
+ * <p>You do not have sufficient access to perform this action.</p>
59
+ *
60
+ * @throws {@link ConflictException} (client fault)
61
+ * <p>The request could not be processed because of conflict in the current state of the
62
+ * resource. For example, if you're using a <code>Create</code> API (such as
63
+ * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
64
+ * same name) is being created or mutated.</p>
65
+ *
66
+ * @throws {@link ResourceNotFoundException} (client fault)
67
+ * <p>The specified resource does not exist.</p>
68
+ *
69
+ * @throws {@link ThrottlingException} (client fault)
70
+ * <p>The throttling limit has been exceeded.</p>
71
+ *
72
+ * @throws {@link ValidationException} (client fault)
73
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
74
+ *
75
+ * @throws {@link QConnectServiceException}
76
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
77
+ *
78
+ * @public
79
+ */
80
+ export declare class DeleteMessageTemplateCommand extends DeleteMessageTemplateCommand_base {
81
+ /** @internal type navigation helper, not in runtime. */
82
+ protected static __types: {
83
+ api: {
84
+ input: DeleteMessageTemplateRequest;
85
+ output: {};
86
+ };
87
+ sdk: {
88
+ input: DeleteMessageTemplateCommandInput;
89
+ output: DeleteMessageTemplateCommandOutput;
90
+ };
91
+ };
92
+ }
@@ -0,0 +1,231 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { GetMessageTemplateRequest, GetMessageTemplateResponse } from "../models/models_0";
4
+ import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetMessageTemplateCommand}.
14
+ */
15
+ export interface GetMessageTemplateCommandInput extends GetMessageTemplateRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetMessageTemplateCommand}.
21
+ */
22
+ export interface GetMessageTemplateCommandOutput extends GetMessageTemplateResponse, __MetadataBearer {
23
+ }
24
+ declare const GetMessageTemplateCommand_base: {
25
+ new (input: GetMessageTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<GetMessageTemplateCommandInput, GetMessageTemplateCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetMessageTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<GetMessageTemplateCommandInput, GetMessageTemplateCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Retrieves the Amazon Q in Connect message template. The message template identifier can
31
+ * contain an optional qualifier, for example,
32
+ * <code>&lt;message-template-id&gt;:&lt;qualifier&gt;</code>, which is either an actual
33
+ * version number or an Amazon Q Connect managed qualifier <code>$ACTIVE_VERSION</code> | <code>$LATEST</code>. If it is
34
+ * not supplied, then <code>$LATEST</code> is assumed implicitly.</p>
35
+ * @example
36
+ * Use a bare-bones client and the command you need to make an API call.
37
+ * ```javascript
38
+ * import { QConnectClient, GetMessageTemplateCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
39
+ * // const { QConnectClient, GetMessageTemplateCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
40
+ * const client = new QConnectClient(config);
41
+ * const input = { // GetMessageTemplateRequest
42
+ * messageTemplateId: "STRING_VALUE", // required
43
+ * knowledgeBaseId: "STRING_VALUE", // required
44
+ * };
45
+ * const command = new GetMessageTemplateCommand(input);
46
+ * const response = await client.send(command);
47
+ * // { // GetMessageTemplateResponse
48
+ * // messageTemplate: { // ExtendedMessageTemplateData
49
+ * // messageTemplateArn: "STRING_VALUE", // required
50
+ * // messageTemplateId: "STRING_VALUE", // required
51
+ * // knowledgeBaseArn: "STRING_VALUE", // required
52
+ * // knowledgeBaseId: "STRING_VALUE", // required
53
+ * // name: "STRING_VALUE", // required
54
+ * // channelSubtype: "STRING_VALUE", // required
55
+ * // createdTime: new Date("TIMESTAMP"), // required
56
+ * // lastModifiedTime: new Date("TIMESTAMP"), // required
57
+ * // lastModifiedBy: "STRING_VALUE", // required
58
+ * // content: { // MessageTemplateContentProvider Union: only one key present
59
+ * // email: { // EmailMessageTemplateContent
60
+ * // subject: "STRING_VALUE",
61
+ * // body: { // EmailMessageTemplateContentBody
62
+ * // plainText: { // MessageTemplateBodyContentProvider Union: only one key present
63
+ * // content: "STRING_VALUE",
64
+ * // },
65
+ * // html: {// Union: only one key present
66
+ * // content: "STRING_VALUE",
67
+ * // },
68
+ * // },
69
+ * // headers: [ // EmailHeaders
70
+ * // { // EmailHeader
71
+ * // name: "STRING_VALUE",
72
+ * // value: "STRING_VALUE",
73
+ * // },
74
+ * // ],
75
+ * // },
76
+ * // sms: { // SMSMessageTemplateContent
77
+ * // body: { // SMSMessageTemplateContentBody
78
+ * // plainText: {// Union: only one key present
79
+ * // content: "STRING_VALUE",
80
+ * // },
81
+ * // },
82
+ * // },
83
+ * // },
84
+ * // description: "STRING_VALUE",
85
+ * // language: "STRING_VALUE",
86
+ * // groupingConfiguration: { // GroupingConfiguration
87
+ * // criteria: "STRING_VALUE",
88
+ * // values: [ // GroupingValues
89
+ * // "STRING_VALUE",
90
+ * // ],
91
+ * // },
92
+ * // defaultAttributes: { // MessageTemplateAttributes
93
+ * // systemAttributes: { // SystemAttributes
94
+ * // name: "STRING_VALUE",
95
+ * // customerEndpoint: { // SystemEndpointAttributes
96
+ * // address: "STRING_VALUE",
97
+ * // },
98
+ * // systemEndpoint: {
99
+ * // address: "STRING_VALUE",
100
+ * // },
101
+ * // },
102
+ * // agentAttributes: { // AgentAttributes
103
+ * // firstName: "STRING_VALUE",
104
+ * // lastName: "STRING_VALUE",
105
+ * // },
106
+ * // customerProfileAttributes: { // CustomerProfileAttributes
107
+ * // profileId: "STRING_VALUE",
108
+ * // profileARN: "STRING_VALUE",
109
+ * // firstName: "STRING_VALUE",
110
+ * // middleName: "STRING_VALUE",
111
+ * // lastName: "STRING_VALUE",
112
+ * // accountNumber: "STRING_VALUE",
113
+ * // emailAddress: "STRING_VALUE",
114
+ * // phoneNumber: "STRING_VALUE",
115
+ * // additionalInformation: "STRING_VALUE",
116
+ * // partyType: "STRING_VALUE",
117
+ * // businessName: "STRING_VALUE",
118
+ * // birthDate: "STRING_VALUE",
119
+ * // gender: "STRING_VALUE",
120
+ * // mobilePhoneNumber: "STRING_VALUE",
121
+ * // homePhoneNumber: "STRING_VALUE",
122
+ * // businessPhoneNumber: "STRING_VALUE",
123
+ * // businessEmailAddress: "STRING_VALUE",
124
+ * // address1: "STRING_VALUE",
125
+ * // address2: "STRING_VALUE",
126
+ * // address3: "STRING_VALUE",
127
+ * // address4: "STRING_VALUE",
128
+ * // city: "STRING_VALUE",
129
+ * // county: "STRING_VALUE",
130
+ * // country: "STRING_VALUE",
131
+ * // postalCode: "STRING_VALUE",
132
+ * // province: "STRING_VALUE",
133
+ * // state: "STRING_VALUE",
134
+ * // shippingAddress1: "STRING_VALUE",
135
+ * // shippingAddress2: "STRING_VALUE",
136
+ * // shippingAddress3: "STRING_VALUE",
137
+ * // shippingAddress4: "STRING_VALUE",
138
+ * // shippingCity: "STRING_VALUE",
139
+ * // shippingCounty: "STRING_VALUE",
140
+ * // shippingCountry: "STRING_VALUE",
141
+ * // shippingPostalCode: "STRING_VALUE",
142
+ * // shippingProvince: "STRING_VALUE",
143
+ * // shippingState: "STRING_VALUE",
144
+ * // mailingAddress1: "STRING_VALUE",
145
+ * // mailingAddress2: "STRING_VALUE",
146
+ * // mailingAddress3: "STRING_VALUE",
147
+ * // mailingAddress4: "STRING_VALUE",
148
+ * // mailingCity: "STRING_VALUE",
149
+ * // mailingCounty: "STRING_VALUE",
150
+ * // mailingCountry: "STRING_VALUE",
151
+ * // mailingPostalCode: "STRING_VALUE",
152
+ * // mailingProvince: "STRING_VALUE",
153
+ * // mailingState: "STRING_VALUE",
154
+ * // billingAddress1: "STRING_VALUE",
155
+ * // billingAddress2: "STRING_VALUE",
156
+ * // billingAddress3: "STRING_VALUE",
157
+ * // billingAddress4: "STRING_VALUE",
158
+ * // billingCity: "STRING_VALUE",
159
+ * // billingCounty: "STRING_VALUE",
160
+ * // billingCountry: "STRING_VALUE",
161
+ * // billingPostalCode: "STRING_VALUE",
162
+ * // billingProvince: "STRING_VALUE",
163
+ * // billingState: "STRING_VALUE",
164
+ * // custom: { // CustomAttributes
165
+ * // "<keys>": "STRING_VALUE",
166
+ * // },
167
+ * // },
168
+ * // customAttributes: {
169
+ * // "<keys>": "STRING_VALUE",
170
+ * // },
171
+ * // },
172
+ * // attributeTypes: [ // MessageTemplateAttributeTypeList
173
+ * // "STRING_VALUE",
174
+ * // ],
175
+ * // attachments: [ // MessageTemplateAttachmentList
176
+ * // { // MessageTemplateAttachment
177
+ * // contentDisposition: "STRING_VALUE", // required
178
+ * // name: "STRING_VALUE", // required
179
+ * // uploadedTime: new Date("TIMESTAMP"), // required
180
+ * // url: "STRING_VALUE", // required
181
+ * // urlExpiry: new Date("TIMESTAMP"), // required
182
+ * // attachmentId: "STRING_VALUE", // required
183
+ * // },
184
+ * // ],
185
+ * // isActive: true || false,
186
+ * // versionNumber: Number("long"),
187
+ * // messageTemplateContentSha256: "STRING_VALUE", // required
188
+ * // tags: { // Tags
189
+ * // "<keys>": "STRING_VALUE",
190
+ * // },
191
+ * // },
192
+ * // };
193
+ *
194
+ * ```
195
+ *
196
+ * @param GetMessageTemplateCommandInput - {@link GetMessageTemplateCommandInput}
197
+ * @returns {@link GetMessageTemplateCommandOutput}
198
+ * @see {@link GetMessageTemplateCommandInput} for command's `input` shape.
199
+ * @see {@link GetMessageTemplateCommandOutput} for command's `response` shape.
200
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
201
+ *
202
+ * @throws {@link AccessDeniedException} (client fault)
203
+ * <p>You do not have sufficient access to perform this action.</p>
204
+ *
205
+ * @throws {@link ResourceNotFoundException} (client fault)
206
+ * <p>The specified resource does not exist.</p>
207
+ *
208
+ * @throws {@link ThrottlingException} (client fault)
209
+ * <p>The throttling limit has been exceeded.</p>
210
+ *
211
+ * @throws {@link ValidationException} (client fault)
212
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
213
+ *
214
+ * @throws {@link QConnectServiceException}
215
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
216
+ *
217
+ * @public
218
+ */
219
+ export declare class GetMessageTemplateCommand extends GetMessageTemplateCommand_base {
220
+ /** @internal type navigation helper, not in runtime. */
221
+ protected static __types: {
222
+ api: {
223
+ input: GetMessageTemplateRequest;
224
+ output: GetMessageTemplateResponse;
225
+ };
226
+ sdk: {
227
+ input: GetMessageTemplateCommandInput;
228
+ output: GetMessageTemplateCommandOutput;
229
+ };
230
+ };
231
+ }
@@ -1,6 +1,7 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { GetRecommendationsRequest, GetRecommendationsResponse } from "../models/models_0";
3
+ import { GetRecommendationsRequest } from "../models/models_0";
4
+ import { GetRecommendationsResponse } from "../models/models_1";
4
5
  import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
5
6
  /**
6
7
  * @public
@@ -0,0 +1,99 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ListMessageTemplateVersionsRequest, ListMessageTemplateVersionsResponse } from "../models/models_0";
4
+ import { QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QConnectClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListMessageTemplateVersionsCommand}.
14
+ */
15
+ export interface ListMessageTemplateVersionsCommandInput extends ListMessageTemplateVersionsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListMessageTemplateVersionsCommand}.
21
+ */
22
+ export interface ListMessageTemplateVersionsCommandOutput extends ListMessageTemplateVersionsResponse, __MetadataBearer {
23
+ }
24
+ declare const ListMessageTemplateVersionsCommand_base: {
25
+ new (input: ListMessageTemplateVersionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListMessageTemplateVersionsCommandInput, ListMessageTemplateVersionsCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: ListMessageTemplateVersionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListMessageTemplateVersionsCommandInput, ListMessageTemplateVersionsCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Lists all the available versions for the specified Amazon Q in Connect message
31
+ * template.</p>
32
+ * @example
33
+ * Use a bare-bones client and the command you need to make an API call.
34
+ * ```javascript
35
+ * import { QConnectClient, ListMessageTemplateVersionsCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
36
+ * // const { QConnectClient, ListMessageTemplateVersionsCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
37
+ * const client = new QConnectClient(config);
38
+ * const input = { // ListMessageTemplateVersionsRequest
39
+ * knowledgeBaseId: "STRING_VALUE", // required
40
+ * messageTemplateId: "STRING_VALUE", // required
41
+ * nextToken: "STRING_VALUE",
42
+ * maxResults: Number("int"),
43
+ * };
44
+ * const command = new ListMessageTemplateVersionsCommand(input);
45
+ * const response = await client.send(command);
46
+ * // { // ListMessageTemplateVersionsResponse
47
+ * // messageTemplateVersionSummaries: [ // MessageTemplateVersionSummaryList // required
48
+ * // { // MessageTemplateVersionSummary
49
+ * // messageTemplateArn: "STRING_VALUE", // required
50
+ * // messageTemplateId: "STRING_VALUE", // required
51
+ * // knowledgeBaseArn: "STRING_VALUE", // required
52
+ * // knowledgeBaseId: "STRING_VALUE", // required
53
+ * // name: "STRING_VALUE", // required
54
+ * // channelSubtype: "STRING_VALUE", // required
55
+ * // isActive: true || false, // required
56
+ * // versionNumber: Number("long"), // required
57
+ * // },
58
+ * // ],
59
+ * // nextToken: "STRING_VALUE",
60
+ * // };
61
+ *
62
+ * ```
63
+ *
64
+ * @param ListMessageTemplateVersionsCommandInput - {@link ListMessageTemplateVersionsCommandInput}
65
+ * @returns {@link ListMessageTemplateVersionsCommandOutput}
66
+ * @see {@link ListMessageTemplateVersionsCommandInput} for command's `input` shape.
67
+ * @see {@link ListMessageTemplateVersionsCommandOutput} for command's `response` shape.
68
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
69
+ *
70
+ * @throws {@link AccessDeniedException} (client fault)
71
+ * <p>You do not have sufficient access to perform this action.</p>
72
+ *
73
+ * @throws {@link ResourceNotFoundException} (client fault)
74
+ * <p>The specified resource does not exist.</p>
75
+ *
76
+ * @throws {@link ThrottlingException} (client fault)
77
+ * <p>The throttling limit has been exceeded.</p>
78
+ *
79
+ * @throws {@link ValidationException} (client fault)
80
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
81
+ *
82
+ * @throws {@link QConnectServiceException}
83
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
84
+ *
85
+ * @public
86
+ */
87
+ export declare class ListMessageTemplateVersionsCommand extends ListMessageTemplateVersionsCommand_base {
88
+ /** @internal type navigation helper, not in runtime. */
89
+ protected static __types: {
90
+ api: {
91
+ input: ListMessageTemplateVersionsRequest;
92
+ output: ListMessageTemplateVersionsResponse;
93
+ };
94
+ sdk: {
95
+ input: ListMessageTemplateVersionsCommandInput;
96
+ output: ListMessageTemplateVersionsCommandOutput;
97
+ };
98
+ };
99
+ }