@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,347 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { CreateMessageTemplateRequest, CreateMessageTemplateResponse } 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 CreateMessageTemplateCommand}.
14
+ */
15
+ export interface CreateMessageTemplateCommandInput extends CreateMessageTemplateRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateMessageTemplateCommand}.
21
+ */
22
+ export interface CreateMessageTemplateCommandOutput extends CreateMessageTemplateResponse, __MetadataBearer {
23
+ }
24
+ declare const CreateMessageTemplateCommand_base: {
25
+ new (input: CreateMessageTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<CreateMessageTemplateCommandInput, CreateMessageTemplateCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: CreateMessageTemplateCommandInput): import("@smithy/smithy-client").CommandImpl<CreateMessageTemplateCommandInput, CreateMessageTemplateCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Creates an Amazon Q in Connect message template. The name of the message template has to
31
+ * be unique for each knowledge base. The channel subtype of the message template is immutable
32
+ * and cannot be modified after creation. After the message template is created, you can use the
33
+ * <code>$LATEST</code> qualifier to reference the created message template.</p>
34
+ * @example
35
+ * Use a bare-bones client and the command you need to make an API call.
36
+ * ```javascript
37
+ * import { QConnectClient, CreateMessageTemplateCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
38
+ * // const { QConnectClient, CreateMessageTemplateCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
39
+ * const client = new QConnectClient(config);
40
+ * const input = { // CreateMessageTemplateRequest
41
+ * knowledgeBaseId: "STRING_VALUE", // required
42
+ * name: "STRING_VALUE", // required
43
+ * content: { // MessageTemplateContentProvider Union: only one key present
44
+ * email: { // EmailMessageTemplateContent
45
+ * subject: "STRING_VALUE",
46
+ * body: { // EmailMessageTemplateContentBody
47
+ * plainText: { // MessageTemplateBodyContentProvider Union: only one key present
48
+ * content: "STRING_VALUE",
49
+ * },
50
+ * html: {// Union: only one key present
51
+ * content: "STRING_VALUE",
52
+ * },
53
+ * },
54
+ * headers: [ // EmailHeaders
55
+ * { // EmailHeader
56
+ * name: "STRING_VALUE",
57
+ * value: "STRING_VALUE",
58
+ * },
59
+ * ],
60
+ * },
61
+ * sms: { // SMSMessageTemplateContent
62
+ * body: { // SMSMessageTemplateContentBody
63
+ * plainText: {// Union: only one key present
64
+ * content: "STRING_VALUE",
65
+ * },
66
+ * },
67
+ * },
68
+ * },
69
+ * description: "STRING_VALUE",
70
+ * channelSubtype: "STRING_VALUE", // required
71
+ * language: "STRING_VALUE",
72
+ * defaultAttributes: { // MessageTemplateAttributes
73
+ * systemAttributes: { // SystemAttributes
74
+ * name: "STRING_VALUE",
75
+ * customerEndpoint: { // SystemEndpointAttributes
76
+ * address: "STRING_VALUE",
77
+ * },
78
+ * systemEndpoint: {
79
+ * address: "STRING_VALUE",
80
+ * },
81
+ * },
82
+ * agentAttributes: { // AgentAttributes
83
+ * firstName: "STRING_VALUE",
84
+ * lastName: "STRING_VALUE",
85
+ * },
86
+ * customerProfileAttributes: { // CustomerProfileAttributes
87
+ * profileId: "STRING_VALUE",
88
+ * profileARN: "STRING_VALUE",
89
+ * firstName: "STRING_VALUE",
90
+ * middleName: "STRING_VALUE",
91
+ * lastName: "STRING_VALUE",
92
+ * accountNumber: "STRING_VALUE",
93
+ * emailAddress: "STRING_VALUE",
94
+ * phoneNumber: "STRING_VALUE",
95
+ * additionalInformation: "STRING_VALUE",
96
+ * partyType: "STRING_VALUE",
97
+ * businessName: "STRING_VALUE",
98
+ * birthDate: "STRING_VALUE",
99
+ * gender: "STRING_VALUE",
100
+ * mobilePhoneNumber: "STRING_VALUE",
101
+ * homePhoneNumber: "STRING_VALUE",
102
+ * businessPhoneNumber: "STRING_VALUE",
103
+ * businessEmailAddress: "STRING_VALUE",
104
+ * address1: "STRING_VALUE",
105
+ * address2: "STRING_VALUE",
106
+ * address3: "STRING_VALUE",
107
+ * address4: "STRING_VALUE",
108
+ * city: "STRING_VALUE",
109
+ * county: "STRING_VALUE",
110
+ * country: "STRING_VALUE",
111
+ * postalCode: "STRING_VALUE",
112
+ * province: "STRING_VALUE",
113
+ * state: "STRING_VALUE",
114
+ * shippingAddress1: "STRING_VALUE",
115
+ * shippingAddress2: "STRING_VALUE",
116
+ * shippingAddress3: "STRING_VALUE",
117
+ * shippingAddress4: "STRING_VALUE",
118
+ * shippingCity: "STRING_VALUE",
119
+ * shippingCounty: "STRING_VALUE",
120
+ * shippingCountry: "STRING_VALUE",
121
+ * shippingPostalCode: "STRING_VALUE",
122
+ * shippingProvince: "STRING_VALUE",
123
+ * shippingState: "STRING_VALUE",
124
+ * mailingAddress1: "STRING_VALUE",
125
+ * mailingAddress2: "STRING_VALUE",
126
+ * mailingAddress3: "STRING_VALUE",
127
+ * mailingAddress4: "STRING_VALUE",
128
+ * mailingCity: "STRING_VALUE",
129
+ * mailingCounty: "STRING_VALUE",
130
+ * mailingCountry: "STRING_VALUE",
131
+ * mailingPostalCode: "STRING_VALUE",
132
+ * mailingProvince: "STRING_VALUE",
133
+ * mailingState: "STRING_VALUE",
134
+ * billingAddress1: "STRING_VALUE",
135
+ * billingAddress2: "STRING_VALUE",
136
+ * billingAddress3: "STRING_VALUE",
137
+ * billingAddress4: "STRING_VALUE",
138
+ * billingCity: "STRING_VALUE",
139
+ * billingCounty: "STRING_VALUE",
140
+ * billingCountry: "STRING_VALUE",
141
+ * billingPostalCode: "STRING_VALUE",
142
+ * billingProvince: "STRING_VALUE",
143
+ * billingState: "STRING_VALUE",
144
+ * custom: { // CustomAttributes
145
+ * "<keys>": "STRING_VALUE",
146
+ * },
147
+ * },
148
+ * customAttributes: {
149
+ * "<keys>": "STRING_VALUE",
150
+ * },
151
+ * },
152
+ * groupingConfiguration: { // GroupingConfiguration
153
+ * criteria: "STRING_VALUE",
154
+ * values: [ // GroupingValues
155
+ * "STRING_VALUE",
156
+ * ],
157
+ * },
158
+ * clientToken: "STRING_VALUE",
159
+ * tags: { // Tags
160
+ * "<keys>": "STRING_VALUE",
161
+ * },
162
+ * };
163
+ * const command = new CreateMessageTemplateCommand(input);
164
+ * const response = await client.send(command);
165
+ * // { // CreateMessageTemplateResponse
166
+ * // messageTemplate: { // MessageTemplateData
167
+ * // messageTemplateArn: "STRING_VALUE", // required
168
+ * // messageTemplateId: "STRING_VALUE", // required
169
+ * // knowledgeBaseArn: "STRING_VALUE", // required
170
+ * // knowledgeBaseId: "STRING_VALUE", // required
171
+ * // name: "STRING_VALUE", // required
172
+ * // channelSubtype: "STRING_VALUE", // required
173
+ * // createdTime: new Date("TIMESTAMP"), // required
174
+ * // lastModifiedTime: new Date("TIMESTAMP"), // required
175
+ * // lastModifiedBy: "STRING_VALUE", // required
176
+ * // content: { // MessageTemplateContentProvider Union: only one key present
177
+ * // email: { // EmailMessageTemplateContent
178
+ * // subject: "STRING_VALUE",
179
+ * // body: { // EmailMessageTemplateContentBody
180
+ * // plainText: { // MessageTemplateBodyContentProvider Union: only one key present
181
+ * // content: "STRING_VALUE",
182
+ * // },
183
+ * // html: {// Union: only one key present
184
+ * // content: "STRING_VALUE",
185
+ * // },
186
+ * // },
187
+ * // headers: [ // EmailHeaders
188
+ * // { // EmailHeader
189
+ * // name: "STRING_VALUE",
190
+ * // value: "STRING_VALUE",
191
+ * // },
192
+ * // ],
193
+ * // },
194
+ * // sms: { // SMSMessageTemplateContent
195
+ * // body: { // SMSMessageTemplateContentBody
196
+ * // plainText: {// Union: only one key present
197
+ * // content: "STRING_VALUE",
198
+ * // },
199
+ * // },
200
+ * // },
201
+ * // },
202
+ * // description: "STRING_VALUE",
203
+ * // language: "STRING_VALUE",
204
+ * // groupingConfiguration: { // GroupingConfiguration
205
+ * // criteria: "STRING_VALUE",
206
+ * // values: [ // GroupingValues
207
+ * // "STRING_VALUE",
208
+ * // ],
209
+ * // },
210
+ * // defaultAttributes: { // MessageTemplateAttributes
211
+ * // systemAttributes: { // SystemAttributes
212
+ * // name: "STRING_VALUE",
213
+ * // customerEndpoint: { // SystemEndpointAttributes
214
+ * // address: "STRING_VALUE",
215
+ * // },
216
+ * // systemEndpoint: {
217
+ * // address: "STRING_VALUE",
218
+ * // },
219
+ * // },
220
+ * // agentAttributes: { // AgentAttributes
221
+ * // firstName: "STRING_VALUE",
222
+ * // lastName: "STRING_VALUE",
223
+ * // },
224
+ * // customerProfileAttributes: { // CustomerProfileAttributes
225
+ * // profileId: "STRING_VALUE",
226
+ * // profileARN: "STRING_VALUE",
227
+ * // firstName: "STRING_VALUE",
228
+ * // middleName: "STRING_VALUE",
229
+ * // lastName: "STRING_VALUE",
230
+ * // accountNumber: "STRING_VALUE",
231
+ * // emailAddress: "STRING_VALUE",
232
+ * // phoneNumber: "STRING_VALUE",
233
+ * // additionalInformation: "STRING_VALUE",
234
+ * // partyType: "STRING_VALUE",
235
+ * // businessName: "STRING_VALUE",
236
+ * // birthDate: "STRING_VALUE",
237
+ * // gender: "STRING_VALUE",
238
+ * // mobilePhoneNumber: "STRING_VALUE",
239
+ * // homePhoneNumber: "STRING_VALUE",
240
+ * // businessPhoneNumber: "STRING_VALUE",
241
+ * // businessEmailAddress: "STRING_VALUE",
242
+ * // address1: "STRING_VALUE",
243
+ * // address2: "STRING_VALUE",
244
+ * // address3: "STRING_VALUE",
245
+ * // address4: "STRING_VALUE",
246
+ * // city: "STRING_VALUE",
247
+ * // county: "STRING_VALUE",
248
+ * // country: "STRING_VALUE",
249
+ * // postalCode: "STRING_VALUE",
250
+ * // province: "STRING_VALUE",
251
+ * // state: "STRING_VALUE",
252
+ * // shippingAddress1: "STRING_VALUE",
253
+ * // shippingAddress2: "STRING_VALUE",
254
+ * // shippingAddress3: "STRING_VALUE",
255
+ * // shippingAddress4: "STRING_VALUE",
256
+ * // shippingCity: "STRING_VALUE",
257
+ * // shippingCounty: "STRING_VALUE",
258
+ * // shippingCountry: "STRING_VALUE",
259
+ * // shippingPostalCode: "STRING_VALUE",
260
+ * // shippingProvince: "STRING_VALUE",
261
+ * // shippingState: "STRING_VALUE",
262
+ * // mailingAddress1: "STRING_VALUE",
263
+ * // mailingAddress2: "STRING_VALUE",
264
+ * // mailingAddress3: "STRING_VALUE",
265
+ * // mailingAddress4: "STRING_VALUE",
266
+ * // mailingCity: "STRING_VALUE",
267
+ * // mailingCounty: "STRING_VALUE",
268
+ * // mailingCountry: "STRING_VALUE",
269
+ * // mailingPostalCode: "STRING_VALUE",
270
+ * // mailingProvince: "STRING_VALUE",
271
+ * // mailingState: "STRING_VALUE",
272
+ * // billingAddress1: "STRING_VALUE",
273
+ * // billingAddress2: "STRING_VALUE",
274
+ * // billingAddress3: "STRING_VALUE",
275
+ * // billingAddress4: "STRING_VALUE",
276
+ * // billingCity: "STRING_VALUE",
277
+ * // billingCounty: "STRING_VALUE",
278
+ * // billingCountry: "STRING_VALUE",
279
+ * // billingPostalCode: "STRING_VALUE",
280
+ * // billingProvince: "STRING_VALUE",
281
+ * // billingState: "STRING_VALUE",
282
+ * // custom: { // CustomAttributes
283
+ * // "<keys>": "STRING_VALUE",
284
+ * // },
285
+ * // },
286
+ * // customAttributes: {
287
+ * // "<keys>": "STRING_VALUE",
288
+ * // },
289
+ * // },
290
+ * // attributeTypes: [ // MessageTemplateAttributeTypeList
291
+ * // "STRING_VALUE",
292
+ * // ],
293
+ * // messageTemplateContentSha256: "STRING_VALUE", // required
294
+ * // tags: { // Tags
295
+ * // "<keys>": "STRING_VALUE",
296
+ * // },
297
+ * // },
298
+ * // };
299
+ *
300
+ * ```
301
+ *
302
+ * @param CreateMessageTemplateCommandInput - {@link CreateMessageTemplateCommandInput}
303
+ * @returns {@link CreateMessageTemplateCommandOutput}
304
+ * @see {@link CreateMessageTemplateCommandInput} for command's `input` shape.
305
+ * @see {@link CreateMessageTemplateCommandOutput} for command's `response` shape.
306
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
307
+ *
308
+ * @throws {@link AccessDeniedException} (client fault)
309
+ * <p>You do not have sufficient access to perform this action.</p>
310
+ *
311
+ * @throws {@link ConflictException} (client fault)
312
+ * <p>The request could not be processed because of conflict in the current state of the
313
+ * resource. For example, if you're using a <code>Create</code> API (such as
314
+ * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
315
+ * same name) is being created or mutated.</p>
316
+ *
317
+ * @throws {@link ResourceNotFoundException} (client fault)
318
+ * <p>The specified resource does not exist.</p>
319
+ *
320
+ * @throws {@link ServiceQuotaExceededException} (client fault)
321
+ * <p>You've exceeded your service quota. To perform the requested action, remove some of the
322
+ * relevant resources, or use service quotas to request a service quota increase.</p>
323
+ *
324
+ * @throws {@link ThrottlingException} (client fault)
325
+ * <p>The throttling limit has been exceeded.</p>
326
+ *
327
+ * @throws {@link ValidationException} (client fault)
328
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
329
+ *
330
+ * @throws {@link QConnectServiceException}
331
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
332
+ *
333
+ * @public
334
+ */
335
+ export declare class CreateMessageTemplateCommand extends CreateMessageTemplateCommand_base {
336
+ /** @internal type navigation helper, not in runtime. */
337
+ protected static __types: {
338
+ api: {
339
+ input: CreateMessageTemplateRequest;
340
+ output: CreateMessageTemplateResponse;
341
+ };
342
+ sdk: {
343
+ input: CreateMessageTemplateCommandInput;
344
+ output: CreateMessageTemplateCommandOutput;
345
+ };
346
+ };
347
+ }
@@ -0,0 +1,247 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { CreateMessageTemplateVersionRequest, CreateMessageTemplateVersionResponse } 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 CreateMessageTemplateVersionCommand}.
14
+ */
15
+ export interface CreateMessageTemplateVersionCommandInput extends CreateMessageTemplateVersionRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreateMessageTemplateVersionCommand}.
21
+ */
22
+ export interface CreateMessageTemplateVersionCommandOutput extends CreateMessageTemplateVersionResponse, __MetadataBearer {
23
+ }
24
+ declare const CreateMessageTemplateVersionCommand_base: {
25
+ new (input: CreateMessageTemplateVersionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateMessageTemplateVersionCommandInput, CreateMessageTemplateVersionCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: CreateMessageTemplateVersionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateMessageTemplateVersionCommandInput, CreateMessageTemplateVersionCommandOutput, QConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Creates a new Amazon Q in Connect message template version from the current content and
31
+ * configuration of a message template. Versions are immutable and monotonically increasing. Once
32
+ * a version is created, you can reference a specific version of the message template by passing
33
+ * in <code>&lt;message-template-id&gt;:&lt;versionNumber&gt;</code> as the message template
34
+ * identifier. An error is displayed if the supplied <code>messageTemplateContentSha256</code> is
35
+ * different from the <code>messageTemplateContentSha256</code> of the message template with
36
+ * <code>$LATEST</code> qualifier. If multiple <code>CreateMessageTemplateVersion</code>
37
+ * requests are made while the message template remains the same, only the first invocation
38
+ * creates a new version and the succeeding requests will return the same response as the first
39
+ * invocation.</p>
40
+ * @example
41
+ * Use a bare-bones client and the command you need to make an API call.
42
+ * ```javascript
43
+ * import { QConnectClient, CreateMessageTemplateVersionCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
44
+ * // const { QConnectClient, CreateMessageTemplateVersionCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
45
+ * const client = new QConnectClient(config);
46
+ * const input = { // CreateMessageTemplateVersionRequest
47
+ * knowledgeBaseId: "STRING_VALUE", // required
48
+ * messageTemplateId: "STRING_VALUE", // required
49
+ * messageTemplateContentSha256: "STRING_VALUE",
50
+ * };
51
+ * const command = new CreateMessageTemplateVersionCommand(input);
52
+ * const response = await client.send(command);
53
+ * // { // CreateMessageTemplateVersionResponse
54
+ * // messageTemplate: { // ExtendedMessageTemplateData
55
+ * // messageTemplateArn: "STRING_VALUE", // required
56
+ * // messageTemplateId: "STRING_VALUE", // required
57
+ * // knowledgeBaseArn: "STRING_VALUE", // required
58
+ * // knowledgeBaseId: "STRING_VALUE", // required
59
+ * // name: "STRING_VALUE", // required
60
+ * // channelSubtype: "STRING_VALUE", // required
61
+ * // createdTime: new Date("TIMESTAMP"), // required
62
+ * // lastModifiedTime: new Date("TIMESTAMP"), // required
63
+ * // lastModifiedBy: "STRING_VALUE", // required
64
+ * // content: { // MessageTemplateContentProvider Union: only one key present
65
+ * // email: { // EmailMessageTemplateContent
66
+ * // subject: "STRING_VALUE",
67
+ * // body: { // EmailMessageTemplateContentBody
68
+ * // plainText: { // MessageTemplateBodyContentProvider Union: only one key present
69
+ * // content: "STRING_VALUE",
70
+ * // },
71
+ * // html: {// Union: only one key present
72
+ * // content: "STRING_VALUE",
73
+ * // },
74
+ * // },
75
+ * // headers: [ // EmailHeaders
76
+ * // { // EmailHeader
77
+ * // name: "STRING_VALUE",
78
+ * // value: "STRING_VALUE",
79
+ * // },
80
+ * // ],
81
+ * // },
82
+ * // sms: { // SMSMessageTemplateContent
83
+ * // body: { // SMSMessageTemplateContentBody
84
+ * // plainText: {// Union: only one key present
85
+ * // content: "STRING_VALUE",
86
+ * // },
87
+ * // },
88
+ * // },
89
+ * // },
90
+ * // description: "STRING_VALUE",
91
+ * // language: "STRING_VALUE",
92
+ * // groupingConfiguration: { // GroupingConfiguration
93
+ * // criteria: "STRING_VALUE",
94
+ * // values: [ // GroupingValues
95
+ * // "STRING_VALUE",
96
+ * // ],
97
+ * // },
98
+ * // defaultAttributes: { // MessageTemplateAttributes
99
+ * // systemAttributes: { // SystemAttributes
100
+ * // name: "STRING_VALUE",
101
+ * // customerEndpoint: { // SystemEndpointAttributes
102
+ * // address: "STRING_VALUE",
103
+ * // },
104
+ * // systemEndpoint: {
105
+ * // address: "STRING_VALUE",
106
+ * // },
107
+ * // },
108
+ * // agentAttributes: { // AgentAttributes
109
+ * // firstName: "STRING_VALUE",
110
+ * // lastName: "STRING_VALUE",
111
+ * // },
112
+ * // customerProfileAttributes: { // CustomerProfileAttributes
113
+ * // profileId: "STRING_VALUE",
114
+ * // profileARN: "STRING_VALUE",
115
+ * // firstName: "STRING_VALUE",
116
+ * // middleName: "STRING_VALUE",
117
+ * // lastName: "STRING_VALUE",
118
+ * // accountNumber: "STRING_VALUE",
119
+ * // emailAddress: "STRING_VALUE",
120
+ * // phoneNumber: "STRING_VALUE",
121
+ * // additionalInformation: "STRING_VALUE",
122
+ * // partyType: "STRING_VALUE",
123
+ * // businessName: "STRING_VALUE",
124
+ * // birthDate: "STRING_VALUE",
125
+ * // gender: "STRING_VALUE",
126
+ * // mobilePhoneNumber: "STRING_VALUE",
127
+ * // homePhoneNumber: "STRING_VALUE",
128
+ * // businessPhoneNumber: "STRING_VALUE",
129
+ * // businessEmailAddress: "STRING_VALUE",
130
+ * // address1: "STRING_VALUE",
131
+ * // address2: "STRING_VALUE",
132
+ * // address3: "STRING_VALUE",
133
+ * // address4: "STRING_VALUE",
134
+ * // city: "STRING_VALUE",
135
+ * // county: "STRING_VALUE",
136
+ * // country: "STRING_VALUE",
137
+ * // postalCode: "STRING_VALUE",
138
+ * // province: "STRING_VALUE",
139
+ * // state: "STRING_VALUE",
140
+ * // shippingAddress1: "STRING_VALUE",
141
+ * // shippingAddress2: "STRING_VALUE",
142
+ * // shippingAddress3: "STRING_VALUE",
143
+ * // shippingAddress4: "STRING_VALUE",
144
+ * // shippingCity: "STRING_VALUE",
145
+ * // shippingCounty: "STRING_VALUE",
146
+ * // shippingCountry: "STRING_VALUE",
147
+ * // shippingPostalCode: "STRING_VALUE",
148
+ * // shippingProvince: "STRING_VALUE",
149
+ * // shippingState: "STRING_VALUE",
150
+ * // mailingAddress1: "STRING_VALUE",
151
+ * // mailingAddress2: "STRING_VALUE",
152
+ * // mailingAddress3: "STRING_VALUE",
153
+ * // mailingAddress4: "STRING_VALUE",
154
+ * // mailingCity: "STRING_VALUE",
155
+ * // mailingCounty: "STRING_VALUE",
156
+ * // mailingCountry: "STRING_VALUE",
157
+ * // mailingPostalCode: "STRING_VALUE",
158
+ * // mailingProvince: "STRING_VALUE",
159
+ * // mailingState: "STRING_VALUE",
160
+ * // billingAddress1: "STRING_VALUE",
161
+ * // billingAddress2: "STRING_VALUE",
162
+ * // billingAddress3: "STRING_VALUE",
163
+ * // billingAddress4: "STRING_VALUE",
164
+ * // billingCity: "STRING_VALUE",
165
+ * // billingCounty: "STRING_VALUE",
166
+ * // billingCountry: "STRING_VALUE",
167
+ * // billingPostalCode: "STRING_VALUE",
168
+ * // billingProvince: "STRING_VALUE",
169
+ * // billingState: "STRING_VALUE",
170
+ * // custom: { // CustomAttributes
171
+ * // "<keys>": "STRING_VALUE",
172
+ * // },
173
+ * // },
174
+ * // customAttributes: {
175
+ * // "<keys>": "STRING_VALUE",
176
+ * // },
177
+ * // },
178
+ * // attributeTypes: [ // MessageTemplateAttributeTypeList
179
+ * // "STRING_VALUE",
180
+ * // ],
181
+ * // attachments: [ // MessageTemplateAttachmentList
182
+ * // { // MessageTemplateAttachment
183
+ * // contentDisposition: "STRING_VALUE", // required
184
+ * // name: "STRING_VALUE", // required
185
+ * // uploadedTime: new Date("TIMESTAMP"), // required
186
+ * // url: "STRING_VALUE", // required
187
+ * // urlExpiry: new Date("TIMESTAMP"), // required
188
+ * // attachmentId: "STRING_VALUE", // required
189
+ * // },
190
+ * // ],
191
+ * // isActive: true || false,
192
+ * // versionNumber: Number("long"),
193
+ * // messageTemplateContentSha256: "STRING_VALUE", // required
194
+ * // tags: { // Tags
195
+ * // "<keys>": "STRING_VALUE",
196
+ * // },
197
+ * // },
198
+ * // };
199
+ *
200
+ * ```
201
+ *
202
+ * @param CreateMessageTemplateVersionCommandInput - {@link CreateMessageTemplateVersionCommandInput}
203
+ * @returns {@link CreateMessageTemplateVersionCommandOutput}
204
+ * @see {@link CreateMessageTemplateVersionCommandInput} for command's `input` shape.
205
+ * @see {@link CreateMessageTemplateVersionCommandOutput} for command's `response` shape.
206
+ * @see {@link QConnectClientResolvedConfig | config} for QConnectClient's `config` shape.
207
+ *
208
+ * @throws {@link AccessDeniedException} (client fault)
209
+ * <p>You do not have sufficient access to perform this action.</p>
210
+ *
211
+ * @throws {@link ConflictException} (client fault)
212
+ * <p>The request could not be processed because of conflict in the current state of the
213
+ * resource. For example, if you're using a <code>Create</code> API (such as
214
+ * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
215
+ * same name) is being created or mutated.</p>
216
+ *
217
+ * @throws {@link ResourceNotFoundException} (client fault)
218
+ * <p>The specified resource does not exist.</p>
219
+ *
220
+ * @throws {@link ServiceQuotaExceededException} (client fault)
221
+ * <p>You've exceeded your service quota. To perform the requested action, remove some of the
222
+ * relevant resources, or use service quotas to request a service quota increase.</p>
223
+ *
224
+ * @throws {@link ThrottlingException} (client fault)
225
+ * <p>The throttling limit has been exceeded.</p>
226
+ *
227
+ * @throws {@link ValidationException} (client fault)
228
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
229
+ *
230
+ * @throws {@link QConnectServiceException}
231
+ * <p>Base exception class for all service exceptions from QConnect service.</p>
232
+ *
233
+ * @public
234
+ */
235
+ export declare class CreateMessageTemplateVersionCommand extends CreateMessageTemplateVersionCommand_base {
236
+ /** @internal type navigation helper, not in runtime. */
237
+ protected static __types: {
238
+ api: {
239
+ input: CreateMessageTemplateVersionRequest;
240
+ output: CreateMessageTemplateVersionResponse;
241
+ };
242
+ sdk: {
243
+ input: CreateMessageTemplateVersionCommandInput;
244
+ output: CreateMessageTemplateVersionCommandOutput;
245
+ };
246
+ };
247
+ }