tencentcloud-sdk-nodejs-intl-en 3.0.409 → 3.0.412

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.
@@ -16,11 +16,9 @@
16
16
  */
17
17
  const models = require("./models");
18
18
  const AbstractClient = require('../../common/abstract_client')
19
- const BatchSendEmailRequest = models.BatchSendEmailRequest;
20
19
  const GetEmailTemplateRequest = models.GetEmailTemplateRequest;
21
- const ListSendTasksResponse = models.ListSendTasksResponse;
22
20
  const CreateReceiverResponse = models.CreateReceiverResponse;
23
- const CreateEmailTemplateRequest = models.CreateEmailTemplateRequest;
21
+ const Simple = models.Simple;
24
22
  const ListEmailAddressResponse = models.ListEmailAddressResponse;
25
23
  const ListEmailAddressRequest = models.ListEmailAddressRequest;
26
24
  const ListReceiversRequest = models.ListReceiversRequest;
@@ -29,10 +27,8 @@ const ListBlackEmailAddressRequest = models.ListBlackEmailAddressRequest;
29
27
  const Attachment = models.Attachment;
30
28
  const Template = models.Template;
31
29
  const ListSendTasksRequest = models.ListSendTasksRequest;
32
- const GetSendEmailStatusResponse = models.GetSendEmailStatusResponse;
33
30
  const SendEmailRequest = models.SendEmailRequest;
34
31
  const EmailSender = models.EmailSender;
35
- const BatchSendEmailResponse = models.BatchSendEmailResponse;
36
32
  const DeleteEmailIdentityRequest = models.DeleteEmailIdentityRequest;
37
33
  const UpdateEmailIdentityRequest = models.UpdateEmailIdentityRequest;
38
34
  const GetEmailIdentityRequest = models.GetEmailIdentityRequest;
@@ -40,7 +36,6 @@ const DeleteEmailIdentityResponse = models.DeleteEmailIdentityResponse;
40
36
  const GetStatisticsReportRequest = models.GetStatisticsReportRequest;
41
37
  const DeleteBlackListRequest = models.DeleteBlackListRequest;
42
38
  const SendTaskData = models.SendTaskData;
43
- const TemplatesMetadata = models.TemplatesMetadata;
44
39
  const DeleteEmailTemplateResponse = models.DeleteEmailTemplateResponse;
45
40
  const Volume = models.Volume;
46
41
  const CreateEmailIdentityRequest = models.CreateEmailIdentityRequest;
@@ -48,16 +43,13 @@ const ReceiverData = models.ReceiverData;
48
43
  const UpdateEmailIdentityResponse = models.UpdateEmailIdentityResponse;
49
44
  const DeleteEmailTemplateRequest = models.DeleteEmailTemplateRequest;
50
45
  const DeleteBlackListResponse = models.DeleteBlackListResponse;
51
- const UpdateEmailTemplateRequest = models.UpdateEmailTemplateRequest;
52
- const SendEmailStatus = models.SendEmailStatus;
53
46
  const ListEmailTemplatesRequest = models.ListEmailTemplatesRequest;
54
47
  const CreateReceiverRequest = models.CreateReceiverRequest;
55
48
  const CreateReceiverDetailResponse = models.CreateReceiverDetailResponse;
56
49
  const ListEmailTemplatesResponse = models.ListEmailTemplatesResponse;
57
50
  const SendEmailResponse = models.SendEmailResponse;
58
51
  const ListBlackEmailAddressResponse = models.ListBlackEmailAddressResponse;
59
- const GetSendEmailStatusRequest = models.GetSendEmailStatusRequest;
60
- const Simple = models.Simple;
52
+ const TemplatesMetadata = models.TemplatesMetadata;
61
53
  const DeleteReceiverRequest = models.DeleteReceiverRequest;
62
54
  const ListEmailIdentitiesResponse = models.ListEmailIdentitiesResponse;
63
55
  const DeleteReceiverResponse = models.DeleteReceiverResponse;
@@ -71,10 +63,9 @@ const DeleteEmailAddressResponse = models.DeleteEmailAddressResponse;
71
63
  const CreateEmailIdentityResponse = models.CreateEmailIdentityResponse;
72
64
  const CreateEmailAddressRequest = models.CreateEmailAddressRequest;
73
65
  const CreateReceiverDetailRequest = models.CreateReceiverDetailRequest;
74
- const CreateEmailTemplateResponse = models.CreateEmailTemplateResponse;
66
+ const ListSendTasksResponse = models.ListSendTasksResponse;
75
67
  const ListReceiversResponse = models.ListReceiversResponse;
76
68
  const CreateEmailAddressResponse = models.CreateEmailAddressResponse;
77
- const UpdateEmailTemplateResponse = models.UpdateEmailTemplateResponse;
78
69
  const TimedEmailParam = models.TimedEmailParam;
79
70
  const DNSAttributes = models.DNSAttributes;
80
71
  const GetEmailTemplateResponse = models.GetEmailTemplateResponse;
@@ -92,69 +83,80 @@ class SesClient extends AbstractClient {
92
83
  }
93
84
 
94
85
  /**
95
- * This API is used to get the list of sender domains, including verified and unverified domains.
96
- * @param {ListEmailIdentitiesRequest} req
97
- * @param {function(string, ListEmailIdentitiesResponse):void} cb
86
+ * This API is used to get the list of sender addresses.
87
+ * @param {ListEmailAddressRequest} req
88
+ * @param {function(string, ListEmailAddressResponse):void} cb
98
89
  * @public
99
90
  */
100
- ListEmailIdentities(req, cb) {
101
- let resp = new ListEmailIdentitiesResponse();
102
- this.request("ListEmailIdentities", req, resp, cb);
91
+ ListEmailAddress(req, cb) {
92
+ let resp = new ListEmailAddressResponse();
93
+ this.request("ListEmailAddress", req, resp, cb);
103
94
  }
104
95
 
105
96
  /**
106
- * After the sender domain is verified, you need a sender address to send emails. For example, if your sender domain is mail.qcloud.com, your sender address can be service@mail.qcloud.com. If you want to display your name (such as "Tencent Cloud") in the inbox list of the recipients, the sender address should be in the format of `Tencent Cloud <email address>`. Please note that there must be a space between your name and the first angle bracket.
107
- * @param {CreateEmailAddressRequest} req
108
- * @param {function(string, CreateEmailAddressResponse):void} cb
97
+ * This API is used to create a sender domain. Before you can send an email using Tencent Cloud SES, you must create a sender domain as your identity. It can be the domain of your website or mobile app. You must verify the domain to prove that you own it and authorize Tencent Cloud SES to use it to send emails.
98
+ * @param {CreateEmailIdentityRequest} req
99
+ * @param {function(string, CreateEmailIdentityResponse):void} cb
109
100
  * @public
110
101
  */
111
- CreateEmailAddress(req, cb) {
112
- let resp = new CreateEmailAddressResponse();
113
- this.request("CreateEmailAddress", req, resp, cb);
102
+ CreateEmailIdentity(req, cb) {
103
+ let resp = new CreateEmailIdentityResponse();
104
+ this.request("CreateEmailIdentity", req, resp, cb);
114
105
  }
115
106
 
116
107
  /**
117
- * This API is used to get email sending status. Only data within 30 days can be queried.
118
- * @param {GetSendEmailStatusRequest} req
119
- * @param {function(string, GetSendEmailStatusResponse):void} cb
108
+ * This API is used to query recipient groups. It supports pagination, fuzzy query, and query by status.
109
+ * @param {ListReceiversRequest} req
110
+ * @param {function(string, ListReceiversResponse):void} cb
120
111
  * @public
121
112
  */
122
- GetSendEmailStatus(req, cb) {
123
- let resp = new GetSendEmailStatusResponse();
124
- this.request("GetSendEmailStatus", req, resp, cb);
113
+ ListReceivers(req, cb) {
114
+ let resp = new ListReceiversResponse();
115
+ this.request("ListReceivers", req, resp, cb);
125
116
  }
126
117
 
127
118
  /**
128
- * This API is used to create a recipient group, which is the list of target email addresses for batch sending emails. After creating a group, you need to upload recipient email addresses. Then, you can create a sending task and select the group to batch send emails.
129
- * @param {CreateReceiverRequest} req
130
- * @param {function(string, CreateReceiverResponse):void} cb
119
+ * This API is used to delete a recipient group and all recipient email addresses in the group based on the recipient group ID.
120
+ * @param {DeleteReceiverRequest} req
121
+ * @param {function(string, DeleteReceiverResponse):void} cb
131
122
  * @public
132
123
  */
133
- CreateReceiver(req, cb) {
134
- let resp = new CreateReceiverResponse();
135
- this.request("CreateReceiver", req, resp, cb);
124
+ DeleteReceiver(req, cb) {
125
+ let resp = new DeleteReceiverResponse();
126
+ this.request("DeleteReceiver", req, resp, cb);
136
127
  }
137
128
 
138
129
  /**
139
- * This API is used to get the configuration details of a sender domain.
140
- * @param {GetEmailIdentityRequest} req
141
- * @param {function(string, GetEmailIdentityResponse):void} cb
130
+ * This API is used to unblocklist email addresses. If you confirm that a blocklisted recipient address is valid and active, you can remove it from Tencent Cloud’s address blocklist database.
131
+ * @param {DeleteBlackListRequest} req
132
+ * @param {function(string, DeleteBlackListResponse):void} cb
142
133
  * @public
143
134
  */
144
- GetEmailIdentity(req, cb) {
145
- let resp = new GetEmailIdentityResponse();
146
- this.request("GetEmailIdentity", req, resp, cb);
135
+ DeleteBlackList(req, cb) {
136
+ let resp = new DeleteBlackListResponse();
137
+ this.request("DeleteBlackList", req, resp, cb);
147
138
  }
148
139
 
149
140
  /**
150
- * This API is used to get the details of a template.
151
- * @param {GetEmailTemplateRequest} req
152
- * @param {function(string, GetEmailTemplateResponse):void} cb
141
+ * After the sender domain is verified, you need a sender address to send emails. For example, if your sender domain is mail.qcloud.com, your sender address can be service@mail.qcloud.com. If you want to display your name (such as "Tencent Cloud") in the inbox list of the recipients, the sender address should be in the format of `Tencent Cloud <email address>`. Please note that there must be a space between your name and the first angle bracket.
142
+ * @param {CreateEmailAddressRequest} req
143
+ * @param {function(string, CreateEmailAddressResponse):void} cb
153
144
  * @public
154
145
  */
155
- GetEmailTemplate(req, cb) {
156
- let resp = new GetEmailTemplateResponse();
157
- this.request("GetEmailTemplate", req, resp, cb);
146
+ CreateEmailAddress(req, cb) {
147
+ let resp = new CreateEmailAddressResponse();
148
+ this.request("CreateEmailAddress", req, resp, cb);
149
+ }
150
+
151
+ /**
152
+ * This API is used to send a TEXT or HTML email triggered for authentication or transaction. By default, you can send emails using a template only. To send custom content, please contact your sales rep to enable this feature.
153
+ * @param {SendEmailRequest} req
154
+ * @param {function(string, SendEmailResponse):void} cb
155
+ * @public
156
+ */
157
+ SendEmail(req, cb) {
158
+ let resp = new SendEmailResponse();
159
+ this.request("SendEmail", req, resp, cb);
158
160
  }
159
161
 
160
162
  /**
@@ -169,81 +171,58 @@ class SesClient extends AbstractClient {
169
171
  }
170
172
 
171
173
  /**
172
- * This API is used to update an email template. An updated template must be approved again before it can be used.
173
- * @param {UpdateEmailTemplateRequest} req
174
- * @param {function(string, UpdateEmailTemplateResponse):void} cb
175
- * @public
176
- */
177
- UpdateEmailTemplate(req, cb) {
178
- let resp = new UpdateEmailTemplateResponse();
179
- this.request("UpdateEmailTemplate", req, resp, cb);
180
- }
181
-
182
- /**
183
- * This API is used to verify whether your DNS configuration is correct.
184
- * @param {UpdateEmailIdentityRequest} req
185
- * @param {function(string, UpdateEmailIdentityResponse):void} cb
186
- * @public
187
- */
188
- UpdateEmailIdentity(req, cb) {
189
- let resp = new UpdateEmailIdentityResponse();
190
- this.request("UpdateEmailIdentity", req, resp, cb);
191
- }
192
-
193
- /**
194
- * This API is used to delete a sender domain. After deleted, the sender domain can no longer be used to send emails.
195
- * @param {DeleteEmailIdentityRequest} req
196
- * @param {function(string, DeleteEmailIdentityResponse):void} cb
174
+ * This API is used to query batch email sending tasks (including immediate, scheduled, and recurring tasks) by page. You can query task data including the number of emails requested to be sent, the number of sent emails, the number of cached emails, and task status.
175
+ * @param {ListSendTasksRequest} req
176
+ * @param {function(string, ListSendTasksResponse):void} cb
197
177
  * @public
198
178
  */
199
- DeleteEmailIdentity(req, cb) {
200
- let resp = new DeleteEmailIdentityResponse();
201
- this.request("DeleteEmailIdentity", req, resp, cb);
179
+ ListSendTasks(req, cb) {
180
+ let resp = new ListSendTasksResponse();
181
+ this.request("ListSendTasks", req, resp, cb);
202
182
  }
203
183
 
204
184
  /**
205
- * This API is used to get the list of sender addresses.
206
- * @param {ListEmailAddressRequest} req
207
- * @param {function(string, ListEmailAddressResponse):void} cb
185
+ * This API is used to get the list of sender domains, including verified and unverified domains.
186
+ * @param {ListEmailIdentitiesRequest} req
187
+ * @param {function(string, ListEmailIdentitiesResponse):void} cb
208
188
  * @public
209
189
  */
210
- ListEmailAddress(req, cb) {
211
- let resp = new ListEmailAddressResponse();
212
- this.request("ListEmailAddress", req, resp, cb);
190
+ ListEmailIdentities(req, cb) {
191
+ let resp = new ListEmailIdentitiesResponse();
192
+ this.request("ListEmailIdentities", req, resp, cb);
213
193
  }
214
194
 
215
195
  /**
216
- * This API is used to delete a recipient group and all recipient email addresses in the group based on the recipient group ID.
217
- * @param {DeleteReceiverRequest} req
218
- * @param {function(string, DeleteReceiverResponse):void} cb
196
+ * The API is used to get blocklisted addresses. In the case of a hard bounce, Tencent Cloud will blocklist the recipient address and do not allow any user to send emails to this address. If you confirm that this is a misjudgment, you can remove it from the blocklist.
197
+ * @param {ListBlackEmailAddressRequest} req
198
+ * @param {function(string, ListBlackEmailAddressResponse):void} cb
219
199
  * @public
220
200
  */
221
- DeleteReceiver(req, cb) {
222
- let resp = new DeleteReceiverResponse();
223
- this.request("DeleteReceiver", req, resp, cb);
201
+ ListBlackEmailAddress(req, cb) {
202
+ let resp = new ListBlackEmailAddressResponse();
203
+ this.request("ListBlackEmailAddress", req, resp, cb);
224
204
  }
225
205
 
226
206
  /**
227
- * This API is used to create a TEXT or HTML email template. To create an HTML template, ensure that it does not include external CSS files. You can use {{variable name}} to specify a variable in the template.
228
- Note: Only an approved template can be used to send emails.
229
- * @param {CreateEmailTemplateRequest} req
230
- * @param {function(string, CreateEmailTemplateResponse):void} cb
207
+ * This API is used to add recipient email addresses (up to 100,000 at a time) to a recipient group. This will be processed asynchronously. You can upload recipient email addresses only once. If the data volume is large, it may take some time to upload. You can check the recipient group to learn the upload status and upload quantity.
208
+ * @param {CreateReceiverDetailRequest} req
209
+ * @param {function(string, CreateReceiverDetailResponse):void} cb
231
210
  * @public
232
211
  */
233
- CreateEmailTemplate(req, cb) {
234
- let resp = new CreateEmailTemplateResponse();
235
- this.request("CreateEmailTemplate", req, resp, cb);
212
+ CreateReceiverDetail(req, cb) {
213
+ let resp = new CreateReceiverDetailResponse();
214
+ this.request("CreateReceiverDetail", req, resp, cb);
236
215
  }
237
216
 
238
217
  /**
239
- * This API is used to send a TEXT or HTML email to multiple recipients at a time for marketing or notification purposes. By default, you can send emails using a template only. To send custom content, please contact your sales rep to enable this feature. You need to create a recipient group with email addresses first and then send emails by group ID. SES supports scheduled and recurring email sending tasks. You need to pass in `TimedParam` for a scheduled task and `CycleParam` for a recurring one.
240
- * @param {BatchSendEmailRequest} req
241
- * @param {function(string, BatchSendEmailResponse):void} cb
218
+ * This API is used to create a recipient group, which is the list of target email addresses for batch sending emails. After creating a group, you need to upload recipient email addresses. Then, you can create a sending task and select the group to batch send emails.
219
+ * @param {CreateReceiverRequest} req
220
+ * @param {function(string, CreateReceiverResponse):void} cb
242
221
  * @public
243
222
  */
244
- BatchSendEmail(req, cb) {
245
- let resp = new BatchSendEmailResponse();
246
- this.request("BatchSendEmail", req, resp, cb);
223
+ CreateReceiver(req, cb) {
224
+ let resp = new CreateReceiverResponse();
225
+ this.request("CreateReceiver", req, resp, cb);
247
226
  }
248
227
 
249
228
  /**
@@ -257,6 +236,17 @@ Note: Only an approved template can be used to send emails.
257
236
  this.request("DeleteEmailTemplate", req, resp, cb);
258
237
  }
259
238
 
239
+ /**
240
+ * This API is used to get the configuration details of a sender domain.
241
+ * @param {GetEmailIdentityRequest} req
242
+ * @param {function(string, GetEmailIdentityResponse):void} cb
243
+ * @public
244
+ */
245
+ GetEmailIdentity(req, cb) {
246
+ let resp = new GetEmailIdentityResponse();
247
+ this.request("GetEmailIdentity", req, resp, cb);
248
+ }
249
+
260
250
  /**
261
251
  * This API is used to get the list of email templates.
262
252
  * @param {ListEmailTemplatesRequest} req
@@ -269,80 +259,36 @@ Note: Only an approved template can be used to send emails.
269
259
  }
270
260
 
271
261
  /**
272
- * This API is used to query batch email sending tasks (including immediate, scheduled, and recurring tasks) by page. You can query task data including the number of emails requested to be sent, the number of sent emails, the number of cached emails, and task status.
273
- * @param {ListSendTasksRequest} req
274
- * @param {function(string, ListSendTasksResponse):void} cb
275
- * @public
276
- */
277
- ListSendTasks(req, cb) {
278
- let resp = new ListSendTasksResponse();
279
- this.request("ListSendTasks", req, resp, cb);
280
- }
281
-
282
- /**
283
- * This API is used to create a sender domain. Before you can send an email using Tencent Cloud SES, you must create a sender domain as your identity. It can be the domain of your website or mobile app. You must verify the domain to prove that you own it and authorize Tencent Cloud SES to use it to send emails.
284
- * @param {CreateEmailIdentityRequest} req
285
- * @param {function(string, CreateEmailIdentityResponse):void} cb
286
- * @public
287
- */
288
- CreateEmailIdentity(req, cb) {
289
- let resp = new CreateEmailIdentityResponse();
290
- this.request("CreateEmailIdentity", req, resp, cb);
291
- }
292
-
293
- /**
294
- * This API is used to unblocklist email addresses. If you confirm that a blocklisted recipient address is valid and active, you can remove it from Tencent Cloud’s address blocklist database.
295
- * @param {DeleteBlackListRequest} req
296
- * @param {function(string, DeleteBlackListResponse):void} cb
297
- * @public
298
- */
299
- DeleteBlackList(req, cb) {
300
- let resp = new DeleteBlackListResponse();
301
- this.request("DeleteBlackList", req, resp, cb);
302
- }
303
-
304
- /**
305
- * This API is used to send a TEXT or HTML email triggered for authentication or transaction. By default, you can send emails using a template only. To send custom content, please contact your sales rep to enable this feature.
306
- * @param {SendEmailRequest} req
307
- * @param {function(string, SendEmailResponse):void} cb
308
- * @public
309
- */
310
- SendEmail(req, cb) {
311
- let resp = new SendEmailResponse();
312
- this.request("SendEmail", req, resp, cb);
313
- }
314
-
315
- /**
316
- * The API is used to get blocklisted addresses. In the case of a hard bounce, Tencent Cloud will blocklist the recipient address and do not allow any user to send emails to this address. If you confirm that this is a misjudgment, you can remove it from the blocklist.
317
- * @param {ListBlackEmailAddressRequest} req
318
- * @param {function(string, ListBlackEmailAddressResponse):void} cb
262
+ * This API is used to verify whether your DNS configuration is correct.
263
+ * @param {UpdateEmailIdentityRequest} req
264
+ * @param {function(string, UpdateEmailIdentityResponse):void} cb
319
265
  * @public
320
266
  */
321
- ListBlackEmailAddress(req, cb) {
322
- let resp = new ListBlackEmailAddressResponse();
323
- this.request("ListBlackEmailAddress", req, resp, cb);
267
+ UpdateEmailIdentity(req, cb) {
268
+ let resp = new UpdateEmailIdentityResponse();
269
+ this.request("UpdateEmailIdentity", req, resp, cb);
324
270
  }
325
271
 
326
272
  /**
327
- * This API is used to add recipient email addresses (up to 100,000 at a time) to a recipient group. This will be processed asynchronously. You can upload recipient email addresses only once. If the data volume is large, it may take some time to upload. You can check the recipient group to learn the upload status and upload quantity.
328
- * @param {CreateReceiverDetailRequest} req
329
- * @param {function(string, CreateReceiverDetailResponse):void} cb
273
+ * This API is used to get the details of a template.
274
+ * @param {GetEmailTemplateRequest} req
275
+ * @param {function(string, GetEmailTemplateResponse):void} cb
330
276
  * @public
331
277
  */
332
- CreateReceiverDetail(req, cb) {
333
- let resp = new CreateReceiverDetailResponse();
334
- this.request("CreateReceiverDetail", req, resp, cb);
278
+ GetEmailTemplate(req, cb) {
279
+ let resp = new GetEmailTemplateResponse();
280
+ this.request("GetEmailTemplate", req, resp, cb);
335
281
  }
336
282
 
337
283
  /**
338
- * This API is used to query recipient groups. It supports pagination, fuzzy query, and query by status.
339
- * @param {ListReceiversRequest} req
340
- * @param {function(string, ListReceiversResponse):void} cb
284
+ * This API is used to delete a sender domain. After deleted, the sender domain can no longer be used to send emails.
285
+ * @param {DeleteEmailIdentityRequest} req
286
+ * @param {function(string, DeleteEmailIdentityResponse):void} cb
341
287
  * @public
342
288
  */
343
- ListReceivers(req, cb) {
344
- let resp = new ListReceiversResponse();
345
- this.request("ListReceivers", req, resp, cb);
289
+ DeleteEmailIdentity(req, cb) {
290
+ let resp = new DeleteEmailIdentityResponse();
291
+ this.request("DeleteEmailIdentity", req, resp, cb);
346
292
  }
347
293
 
348
294
  /**