@emilgroup/notification-sdk 0.8.1-beta.38 → 0.8.1-beta.4
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.
- package/.openapi-generator/FILES +0 -8
- package/README.md +2 -2
- package/api/email-messages-api.ts +24 -259
- package/api/email-tracking-api.ts +24 -32
- package/api/email-verifications-api.ts +8 -16
- package/api/layouts-api.ts +36 -56
- package/api/notification-templates-api.ts +36 -56
- package/api/notifications-api.ts +4 -115
- package/api.ts +0 -2
- package/dist/api/email-messages-api.d.ts +24 -158
- package/dist/api/email-messages-api.js +22 -225
- package/dist/api/email-tracking-api.d.ts +24 -32
- package/dist/api/email-tracking-api.js +22 -30
- package/dist/api/email-verifications-api.d.ts +8 -16
- package/dist/api/email-verifications-api.js +8 -16
- package/dist/api/layouts-api.d.ts +36 -56
- package/dist/api/layouts-api.js +32 -52
- package/dist/api/notification-templates-api.d.ts +36 -56
- package/dist/api/notification-templates-api.js +32 -52
- package/dist/api/notifications-api.d.ts +4 -65
- package/dist/api/notifications-api.js +4 -101
- package/dist/api.d.ts +0 -1
- package/dist/api.js +0 -1
- package/dist/models/email-message-class.d.ts +2 -49
- package/dist/models/email-message-class.js +2 -16
- package/dist/models/index.d.ts +0 -7
- package/dist/models/index.js +0 -7
- package/dist/models/send-notification-request-dto.d.ts +0 -9
- package/dist/models/send-notification-request-dto.js +1 -2
- package/models/email-message-class.ts +3 -53
- package/models/index.ts +0 -7
- package/models/send-notification-request-dto.ts +1 -8
- package/package.json +1 -1
- package/api/msgraph-webhooks-api.ts +0 -278
- package/dist/api/msgraph-webhooks-api.d.ts +0 -168
- package/dist/api/msgraph-webhooks-api.js +0 -305
- package/dist/models/assign-email-message-entity-body-dto.d.ts +0 -43
- package/dist/models/assign-email-message-entity-body-dto.js +0 -22
- package/dist/models/assign-email-message-entity-response-class.d.ts +0 -25
- package/dist/models/assign-email-message-entity-response-class.js +0 -15
- package/dist/models/grpc-send-email-request-dto.d.ts +0 -137
- package/dist/models/grpc-send-email-request-dto.js +0 -22
- package/dist/models/inline-attachment-dto.d.ts +0 -36
- package/dist/models/inline-attachment-dto.js +0 -15
- package/dist/models/send-email-request-dto.d.ts +0 -131
- package/dist/models/send-email-request-dto.js +0 -22
- package/dist/models/send-email-response-class.d.ts +0 -24
- package/dist/models/send-email-response-class.js +0 -15
- package/dist/models/unassign-email-message-entity-response-class.d.ts +0 -25
- package/dist/models/unassign-email-message-entity-response-class.js +0 -15
- package/models/assign-email-message-entity-body-dto.ts +0 -52
- package/models/assign-email-message-entity-response-class.ts +0 -31
- package/models/grpc-send-email-request-dto.ts +0 -144
- package/models/inline-attachment-dto.ts +0 -42
- package/models/send-email-request-dto.ts +0 -138
- package/models/send-email-response-class.ts +0 -30
- package/models/unassign-email-message-entity-response-class.ts +0 -31
|
@@ -93,61 +93,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
*
|
|
97
|
-
* @summary Assign an email message to an entity
|
|
98
|
-
* @param {string} code
|
|
99
|
-
* @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
|
|
100
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
101
|
-
* @param {*} [options] Override http request option.
|
|
102
|
-
* @throws {RequiredError}
|
|
103
|
-
*/
|
|
104
|
-
assignEntity: function (code, assignEmailMessageEntityBodyDto, authorization, options) {
|
|
105
|
-
if (options === void 0) { options = {}; }
|
|
106
|
-
return __awaiter(_this, void 0, void 0, function () {
|
|
107
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
108
|
-
return __generator(this, function (_a) {
|
|
109
|
-
switch (_a.label) {
|
|
110
|
-
case 0:
|
|
111
|
-
// verify required parameter 'code' is not null or undefined
|
|
112
|
-
(0, common_1.assertParamExists)('assignEntity', 'code', code);
|
|
113
|
-
// verify required parameter 'assignEmailMessageEntityBodyDto' is not null or undefined
|
|
114
|
-
(0, common_1.assertParamExists)('assignEntity', 'assignEmailMessageEntityBodyDto', assignEmailMessageEntityBodyDto);
|
|
115
|
-
localVarPath = "/notificationservice/v1/email-messages/{code}/entity"
|
|
116
|
-
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
117
|
-
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
118
|
-
if (configuration) {
|
|
119
|
-
baseOptions = configuration.baseOptions;
|
|
120
|
-
baseAccessToken = configuration.accessToken;
|
|
121
|
-
}
|
|
122
|
-
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
|
|
123
|
-
localVarHeaderParameter = {};
|
|
124
|
-
localVarQueryParameter = {};
|
|
125
|
-
// authentication bearer required
|
|
126
|
-
// http bearer authentication required
|
|
127
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
128
|
-
case 1:
|
|
129
|
-
// authentication bearer required
|
|
130
|
-
// http bearer authentication required
|
|
131
|
-
_a.sent();
|
|
132
|
-
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
133
|
-
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
134
|
-
}
|
|
135
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
136
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
137
|
-
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
138
|
-
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
139
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(assignEmailMessageEntityBodyDto, localVarRequestOptions, configuration);
|
|
140
|
-
return [2 /*return*/, {
|
|
141
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
142
|
-
options: localVarRequestOptions,
|
|
143
|
-
}];
|
|
144
|
-
}
|
|
145
|
-
});
|
|
146
|
-
});
|
|
147
|
-
},
|
|
148
|
-
/**
|
|
149
|
-
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
150
|
-
* @summary Download the email message attachment
|
|
96
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
151
97
|
* @param {string} code
|
|
152
98
|
* @param {number} attachmentId
|
|
153
99
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -198,8 +144,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
198
144
|
});
|
|
199
145
|
},
|
|
200
146
|
/**
|
|
201
|
-
*
|
|
202
|
-
* @summary Retrieve the email message
|
|
147
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
203
148
|
* @param {string} code
|
|
204
149
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
205
150
|
* @param {*} [options] Override http request option.
|
|
@@ -246,8 +191,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
246
191
|
});
|
|
247
192
|
},
|
|
248
193
|
/**
|
|
249
|
-
*
|
|
250
|
-
* @summary List the email message attachments
|
|
194
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
251
195
|
* @param {string} code
|
|
252
196
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
253
197
|
* @param {*} [options] Override http request option.
|
|
@@ -294,16 +238,16 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
294
238
|
});
|
|
295
239
|
},
|
|
296
240
|
/**
|
|
297
|
-
*
|
|
241
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
298
242
|
* @summary List email messages
|
|
299
243
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
300
244
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
301
245
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
302
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
246
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
303
247
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
304
248
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
305
249
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
306
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
250
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
307
251
|
* @param {*} [options] Override http request option.
|
|
308
252
|
* @throws {RequiredError}
|
|
309
253
|
*/
|
|
@@ -365,54 +309,6 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
365
309
|
});
|
|
366
310
|
});
|
|
367
311
|
},
|
|
368
|
-
/**
|
|
369
|
-
* Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
370
|
-
* @summary Unassign an email message from its entity
|
|
371
|
-
* @param {string} code
|
|
372
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
373
|
-
* @param {*} [options] Override http request option.
|
|
374
|
-
* @throws {RequiredError}
|
|
375
|
-
*/
|
|
376
|
-
unassignEntity: function (code, authorization, options) {
|
|
377
|
-
if (options === void 0) { options = {}; }
|
|
378
|
-
return __awaiter(_this, void 0, void 0, function () {
|
|
379
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
380
|
-
return __generator(this, function (_a) {
|
|
381
|
-
switch (_a.label) {
|
|
382
|
-
case 0:
|
|
383
|
-
// verify required parameter 'code' is not null or undefined
|
|
384
|
-
(0, common_1.assertParamExists)('unassignEntity', 'code', code);
|
|
385
|
-
localVarPath = "/notificationservice/v1/email-messages/{code}/entity"
|
|
386
|
-
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
387
|
-
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
388
|
-
if (configuration) {
|
|
389
|
-
baseOptions = configuration.baseOptions;
|
|
390
|
-
baseAccessToken = configuration.accessToken;
|
|
391
|
-
}
|
|
392
|
-
localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), options);
|
|
393
|
-
localVarHeaderParameter = {};
|
|
394
|
-
localVarQueryParameter = {};
|
|
395
|
-
// authentication bearer required
|
|
396
|
-
// http bearer authentication required
|
|
397
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
398
|
-
case 1:
|
|
399
|
-
// authentication bearer required
|
|
400
|
-
// http bearer authentication required
|
|
401
|
-
_a.sent();
|
|
402
|
-
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
403
|
-
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
404
|
-
}
|
|
405
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
406
|
-
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
407
|
-
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
408
|
-
return [2 /*return*/, {
|
|
409
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
410
|
-
options: localVarRequestOptions,
|
|
411
|
-
}];
|
|
412
|
-
}
|
|
413
|
-
});
|
|
414
|
-
});
|
|
415
|
-
},
|
|
416
312
|
};
|
|
417
313
|
};
|
|
418
314
|
exports.EmailMessagesApiAxiosParamCreator = EmailMessagesApiAxiosParamCreator;
|
|
@@ -424,30 +320,7 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
424
320
|
var localVarAxiosParamCreator = (0, exports.EmailMessagesApiAxiosParamCreator)(configuration);
|
|
425
321
|
return {
|
|
426
322
|
/**
|
|
427
|
-
*
|
|
428
|
-
* @summary Assign an email message to an entity
|
|
429
|
-
* @param {string} code
|
|
430
|
-
* @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
|
|
431
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
432
|
-
* @param {*} [options] Override http request option.
|
|
433
|
-
* @throws {RequiredError}
|
|
434
|
-
*/
|
|
435
|
-
assignEntity: function (code, assignEmailMessageEntityBodyDto, authorization, options) {
|
|
436
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
437
|
-
var localVarAxiosArgs;
|
|
438
|
-
return __generator(this, function (_a) {
|
|
439
|
-
switch (_a.label) {
|
|
440
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.assignEntity(code, assignEmailMessageEntityBodyDto, authorization, options)];
|
|
441
|
-
case 1:
|
|
442
|
-
localVarAxiosArgs = _a.sent();
|
|
443
|
-
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
444
|
-
}
|
|
445
|
-
});
|
|
446
|
-
});
|
|
447
|
-
},
|
|
448
|
-
/**
|
|
449
|
-
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
450
|
-
* @summary Download the email message attachment
|
|
323
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
451
324
|
* @param {string} code
|
|
452
325
|
* @param {number} attachmentId
|
|
453
326
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -468,8 +341,7 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
468
341
|
});
|
|
469
342
|
},
|
|
470
343
|
/**
|
|
471
|
-
*
|
|
472
|
-
* @summary Retrieve the email message
|
|
344
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
473
345
|
* @param {string} code
|
|
474
346
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
475
347
|
* @param {*} [options] Override http request option.
|
|
@@ -489,8 +361,7 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
489
361
|
});
|
|
490
362
|
},
|
|
491
363
|
/**
|
|
492
|
-
*
|
|
493
|
-
* @summary List the email message attachments
|
|
364
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
494
365
|
* @param {string} code
|
|
495
366
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
496
367
|
* @param {*} [options] Override http request option.
|
|
@@ -510,16 +381,16 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
510
381
|
});
|
|
511
382
|
},
|
|
512
383
|
/**
|
|
513
|
-
*
|
|
384
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
514
385
|
* @summary List email messages
|
|
515
386
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
516
387
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
517
388
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
518
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
389
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
519
390
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
520
391
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
521
392
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
522
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
393
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
523
394
|
* @param {*} [options] Override http request option.
|
|
524
395
|
* @throws {RequiredError}
|
|
525
396
|
*/
|
|
@@ -536,27 +407,6 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
536
407
|
});
|
|
537
408
|
});
|
|
538
409
|
},
|
|
539
|
-
/**
|
|
540
|
-
* Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
541
|
-
* @summary Unassign an email message from its entity
|
|
542
|
-
* @param {string} code
|
|
543
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
544
|
-
* @param {*} [options] Override http request option.
|
|
545
|
-
* @throws {RequiredError}
|
|
546
|
-
*/
|
|
547
|
-
unassignEntity: function (code, authorization, options) {
|
|
548
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
549
|
-
var localVarAxiosArgs;
|
|
550
|
-
return __generator(this, function (_a) {
|
|
551
|
-
switch (_a.label) {
|
|
552
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.unassignEntity(code, authorization, options)];
|
|
553
|
-
case 1:
|
|
554
|
-
localVarAxiosArgs = _a.sent();
|
|
555
|
-
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
556
|
-
}
|
|
557
|
-
});
|
|
558
|
-
});
|
|
559
|
-
},
|
|
560
410
|
};
|
|
561
411
|
};
|
|
562
412
|
exports.EmailMessagesApiFp = EmailMessagesApiFp;
|
|
@@ -568,20 +418,7 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
568
418
|
var localVarFp = (0, exports.EmailMessagesApiFp)(configuration);
|
|
569
419
|
return {
|
|
570
420
|
/**
|
|
571
|
-
*
|
|
572
|
-
* @summary Assign an email message to an entity
|
|
573
|
-
* @param {string} code
|
|
574
|
-
* @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
|
|
575
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
576
|
-
* @param {*} [options] Override http request option.
|
|
577
|
-
* @throws {RequiredError}
|
|
578
|
-
*/
|
|
579
|
-
assignEntity: function (code, assignEmailMessageEntityBodyDto, authorization, options) {
|
|
580
|
-
return localVarFp.assignEntity(code, assignEmailMessageEntityBodyDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
581
|
-
},
|
|
582
|
-
/**
|
|
583
|
-
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
584
|
-
* @summary Download the email message attachment
|
|
421
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
585
422
|
* @param {string} code
|
|
586
423
|
* @param {number} attachmentId
|
|
587
424
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -592,8 +429,7 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
592
429
|
return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
593
430
|
},
|
|
594
431
|
/**
|
|
595
|
-
*
|
|
596
|
-
* @summary Retrieve the email message
|
|
432
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
597
433
|
* @param {string} code
|
|
598
434
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
599
435
|
* @param {*} [options] Override http request option.
|
|
@@ -603,8 +439,7 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
603
439
|
return localVarFp.getMessage(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
604
440
|
},
|
|
605
441
|
/**
|
|
606
|
-
*
|
|
607
|
-
* @summary List the email message attachments
|
|
442
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
608
443
|
* @param {string} code
|
|
609
444
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
610
445
|
* @param {*} [options] Override http request option.
|
|
@@ -614,33 +449,22 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
614
449
|
return localVarFp.listAttachments(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
615
450
|
},
|
|
616
451
|
/**
|
|
617
|
-
*
|
|
452
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
618
453
|
* @summary List email messages
|
|
619
454
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
620
455
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
621
456
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
622
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
457
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
623
458
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
624
459
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
625
460
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
626
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
461
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
627
462
|
* @param {*} [options] Override http request option.
|
|
628
463
|
* @throws {RequiredError}
|
|
629
464
|
*/
|
|
630
465
|
listEmailMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
631
466
|
return localVarFp.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
632
467
|
},
|
|
633
|
-
/**
|
|
634
|
-
* Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
635
|
-
* @summary Unassign an email message from its entity
|
|
636
|
-
* @param {string} code
|
|
637
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
638
|
-
* @param {*} [options] Override http request option.
|
|
639
|
-
* @throws {RequiredError}
|
|
640
|
-
*/
|
|
641
|
-
unassignEntity: function (code, authorization, options) {
|
|
642
|
-
return localVarFp.unassignEntity(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
643
|
-
},
|
|
644
468
|
};
|
|
645
469
|
};
|
|
646
470
|
exports.EmailMessagesApiFactory = EmailMessagesApiFactory;
|
|
@@ -656,20 +480,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
656
480
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
657
481
|
}
|
|
658
482
|
/**
|
|
659
|
-
*
|
|
660
|
-
* @summary Assign an email message to an entity
|
|
661
|
-
* @param {EmailMessagesApiAssignEntityRequest} requestParameters Request parameters.
|
|
662
|
-
* @param {*} [options] Override http request option.
|
|
663
|
-
* @throws {RequiredError}
|
|
664
|
-
* @memberof EmailMessagesApi
|
|
665
|
-
*/
|
|
666
|
-
EmailMessagesApi.prototype.assignEntity = function (requestParameters, options) {
|
|
667
|
-
var _this = this;
|
|
668
|
-
return (0, exports.EmailMessagesApiFp)(this.configuration).assignEntity(requestParameters.code, requestParameters.assignEmailMessageEntityBodyDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
669
|
-
};
|
|
670
|
-
/**
|
|
671
|
-
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
672
|
-
* @summary Download the email message attachment
|
|
483
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
673
484
|
* @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
|
|
674
485
|
* @param {*} [options] Override http request option.
|
|
675
486
|
* @throws {RequiredError}
|
|
@@ -680,8 +491,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
680
491
|
return (0, exports.EmailMessagesApiFp)(this.configuration).downloadAttachment(requestParameters.code, requestParameters.attachmentId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
681
492
|
};
|
|
682
493
|
/**
|
|
683
|
-
*
|
|
684
|
-
* @summary Retrieve the email message
|
|
494
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
685
495
|
* @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
|
|
686
496
|
* @param {*} [options] Override http request option.
|
|
687
497
|
* @throws {RequiredError}
|
|
@@ -692,8 +502,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
692
502
|
return (0, exports.EmailMessagesApiFp)(this.configuration).getMessage(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
693
503
|
};
|
|
694
504
|
/**
|
|
695
|
-
*
|
|
696
|
-
* @summary List the email message attachments
|
|
505
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
697
506
|
* @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
|
|
698
507
|
* @param {*} [options] Override http request option.
|
|
699
508
|
* @throws {RequiredError}
|
|
@@ -704,7 +513,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
704
513
|
return (0, exports.EmailMessagesApiFp)(this.configuration).listAttachments(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
705
514
|
};
|
|
706
515
|
/**
|
|
707
|
-
*
|
|
516
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
708
517
|
* @summary List email messages
|
|
709
518
|
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
710
519
|
* @param {*} [options] Override http request option.
|
|
@@ -716,18 +525,6 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
716
525
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
717
526
|
return (0, exports.EmailMessagesApiFp)(this.configuration).listEmailMessages(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
718
527
|
};
|
|
719
|
-
/**
|
|
720
|
-
* Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
721
|
-
* @summary Unassign an email message from its entity
|
|
722
|
-
* @param {EmailMessagesApiUnassignEntityRequest} requestParameters Request parameters.
|
|
723
|
-
* @param {*} [options] Override http request option.
|
|
724
|
-
* @throws {RequiredError}
|
|
725
|
-
* @memberof EmailMessagesApi
|
|
726
|
-
*/
|
|
727
|
-
EmailMessagesApi.prototype.unassignEntity = function (requestParameters, options) {
|
|
728
|
-
var _this = this;
|
|
729
|
-
return (0, exports.EmailMessagesApiFp)(this.configuration).unassignEntity(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
730
|
-
};
|
|
731
528
|
return EmailMessagesApi;
|
|
732
529
|
}(base_1.BaseAPI));
|
|
733
530
|
exports.EmailMessagesApi = EmailMessagesApi;
|
|
@@ -21,8 +21,7 @@ import { ListEmailThreadsResponseClass } from '../models';
|
|
|
21
21
|
*/
|
|
22
22
|
export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
25
|
-
* @summary Close the email thread
|
|
24
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
26
25
|
* @param {string} code
|
|
27
26
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
28
27
|
* @param {*} [options] Override http request option.
|
|
@@ -30,8 +29,7 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
30
29
|
*/
|
|
31
30
|
closeThread: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
31
|
/**
|
|
33
|
-
*
|
|
34
|
-
* @summary Retrieve the email thread
|
|
32
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
35
33
|
* @param {string} code
|
|
36
34
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
37
35
|
* @param {*} [options] Override http request option.
|
|
@@ -39,12 +37,12 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
39
37
|
*/
|
|
40
38
|
getThread: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41
39
|
/**
|
|
42
|
-
*
|
|
40
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
43
41
|
* @summary List email messages
|
|
44
42
|
* @param {string} code
|
|
45
43
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
46
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
47
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
44
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
45
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
48
46
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
49
47
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
50
48
|
* @param {*} [options] Override http request option.
|
|
@@ -52,7 +50,7 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
52
50
|
*/
|
|
53
51
|
listMessages: (code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
52
|
/**
|
|
55
|
-
*
|
|
53
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
56
54
|
* @summary List email threads
|
|
57
55
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
56
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -73,8 +71,7 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
73
71
|
*/
|
|
74
72
|
export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
|
|
75
73
|
/**
|
|
76
|
-
*
|
|
77
|
-
* @summary Close the email thread
|
|
74
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
78
75
|
* @param {string} code
|
|
79
76
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
80
77
|
* @param {*} [options] Override http request option.
|
|
@@ -82,8 +79,7 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
|
|
|
82
79
|
*/
|
|
83
80
|
closeThread(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailThreadResponseClass>>;
|
|
84
81
|
/**
|
|
85
|
-
*
|
|
86
|
-
* @summary Retrieve the email thread
|
|
82
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
87
83
|
* @param {string} code
|
|
88
84
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
89
85
|
* @param {*} [options] Override http request option.
|
|
@@ -91,12 +87,12 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
|
|
|
91
87
|
*/
|
|
92
88
|
getThread(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailThreadResponseClass>>;
|
|
93
89
|
/**
|
|
94
|
-
*
|
|
90
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
95
91
|
* @summary List email messages
|
|
96
92
|
* @param {string} code
|
|
97
93
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
98
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
99
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
94
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
95
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
100
96
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
101
97
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
102
98
|
* @param {*} [options] Override http request option.
|
|
@@ -104,7 +100,7 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
|
|
|
104
100
|
*/
|
|
105
101
|
listMessages(code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>>;
|
|
106
102
|
/**
|
|
107
|
-
*
|
|
103
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
108
104
|
* @summary List email threads
|
|
109
105
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
110
106
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -125,8 +121,7 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
|
|
|
125
121
|
*/
|
|
126
122
|
export declare const EmailTrackingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
127
123
|
/**
|
|
128
|
-
*
|
|
129
|
-
* @summary Close the email thread
|
|
124
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
130
125
|
* @param {string} code
|
|
131
126
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
132
127
|
* @param {*} [options] Override http request option.
|
|
@@ -134,8 +129,7 @@ export declare const EmailTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
134
129
|
*/
|
|
135
130
|
closeThread(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailThreadResponseClass>;
|
|
136
131
|
/**
|
|
137
|
-
*
|
|
138
|
-
* @summary Retrieve the email thread
|
|
132
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
139
133
|
* @param {string} code
|
|
140
134
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
141
135
|
* @param {*} [options] Override http request option.
|
|
@@ -143,12 +137,12 @@ export declare const EmailTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
143
137
|
*/
|
|
144
138
|
getThread(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailThreadResponseClass>;
|
|
145
139
|
/**
|
|
146
|
-
*
|
|
140
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
147
141
|
* @summary List email messages
|
|
148
142
|
* @param {string} code
|
|
149
143
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
150
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
151
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
144
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
145
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
152
146
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
153
147
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
154
148
|
* @param {*} [options] Override http request option.
|
|
@@ -156,7 +150,7 @@ export declare const EmailTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
156
150
|
*/
|
|
157
151
|
listMessages(code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass>;
|
|
158
152
|
/**
|
|
159
|
-
*
|
|
153
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
160
154
|
* @summary List email threads
|
|
161
155
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
162
156
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -228,13 +222,13 @@ export interface EmailTrackingApiListMessagesRequest {
|
|
|
228
222
|
*/
|
|
229
223
|
readonly authorization?: string;
|
|
230
224
|
/**
|
|
231
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
225
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
232
226
|
* @type {string}
|
|
233
227
|
* @memberof EmailTrackingApiListMessages
|
|
234
228
|
*/
|
|
235
229
|
readonly filter?: string;
|
|
236
230
|
/**
|
|
237
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
231
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
238
232
|
* @type {string}
|
|
239
233
|
* @memberof EmailTrackingApiListMessages
|
|
240
234
|
*/
|
|
@@ -315,8 +309,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
315
309
|
*/
|
|
316
310
|
export declare class EmailTrackingApi extends BaseAPI {
|
|
317
311
|
/**
|
|
318
|
-
*
|
|
319
|
-
* @summary Close the email thread
|
|
312
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
320
313
|
* @param {EmailTrackingApiCloseThreadRequest} requestParameters Request parameters.
|
|
321
314
|
* @param {*} [options] Override http request option.
|
|
322
315
|
* @throws {RequiredError}
|
|
@@ -324,8 +317,7 @@ export declare class EmailTrackingApi extends BaseAPI {
|
|
|
324
317
|
*/
|
|
325
318
|
closeThread(requestParameters: EmailTrackingApiCloseThreadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailThreadResponseClass, any, {}>>;
|
|
326
319
|
/**
|
|
327
|
-
*
|
|
328
|
-
* @summary Retrieve the email thread
|
|
320
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
329
321
|
* @param {EmailTrackingApiGetThreadRequest} requestParameters Request parameters.
|
|
330
322
|
* @param {*} [options] Override http request option.
|
|
331
323
|
* @throws {RequiredError}
|
|
@@ -333,7 +325,7 @@ export declare class EmailTrackingApi extends BaseAPI {
|
|
|
333
325
|
*/
|
|
334
326
|
getThread(requestParameters: EmailTrackingApiGetThreadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailThreadResponseClass, any, {}>>;
|
|
335
327
|
/**
|
|
336
|
-
*
|
|
328
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
337
329
|
* @summary List email messages
|
|
338
330
|
* @param {EmailTrackingApiListMessagesRequest} requestParameters Request parameters.
|
|
339
331
|
* @param {*} [options] Override http request option.
|
|
@@ -342,7 +334,7 @@ export declare class EmailTrackingApi extends BaseAPI {
|
|
|
342
334
|
*/
|
|
343
335
|
listMessages(requestParameters: EmailTrackingApiListMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailMessagesResponseClass, any, {}>>;
|
|
344
336
|
/**
|
|
345
|
-
*
|
|
337
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
346
338
|
* @summary List email threads
|
|
347
339
|
* @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
|
|
348
340
|
* @param {*} [options] Override http request option.
|