@emilgroup/notification-sdk 0.8.1-beta.7 → 0.8.1-beta.71
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 +25 -0
- package/README.md +2 -2
- package/api/email-mailboxes-api.ts +153 -0
- package/api/email-messages-api.ts +197 -40
- package/api/email-subscriptions-api.ts +799 -0
- package/api/email-tracking-api.ts +313 -52
- package/api/email-verifications-api.ts +32 -14
- package/api/health-api.ts +1 -1
- package/api/layouts-api.ts +96 -51
- package/api/msgraph-webhooks-api.ts +278 -0
- package/api/notification-templates-api.ts +96 -51
- package/api/notifications-api.ts +128 -7
- package/api.ts +6 -0
- package/base.ts +239 -43
- package/common.ts +3 -2
- package/configuration.ts +20 -0
- package/dist/api/email-mailboxes-api.d.ts +87 -0
- package/dist/api/email-mailboxes-api.js +225 -0
- package/dist/api/email-messages-api.d.ts +110 -32
- package/dist/api/email-messages-api.js +199 -56
- package/dist/api/email-subscriptions-api.d.ts +432 -0
- package/dist/api/email-subscriptions-api.js +761 -0
- package/dist/api/email-tracking-api.d.ts +174 -44
- package/dist/api/email-tracking-api.js +299 -64
- package/dist/api/email-verifications-api.d.ts +18 -10
- package/dist/api/email-verifications-api.js +46 -24
- package/dist/api/health-api.d.ts +1 -1
- package/dist/api/health-api.js +1 -1
- package/dist/api/layouts-api.d.ts +61 -41
- package/dist/api/layouts-api.js +119 -70
- package/dist/api/msgraph-webhooks-api.d.ts +168 -0
- package/dist/api/msgraph-webhooks-api.js +305 -0
- package/dist/api/notification-templates-api.d.ts +61 -41
- package/dist/api/notification-templates-api.js +119 -70
- package/dist/api/notifications-api.d.ts +66 -5
- package/dist/api/notifications-api.js +123 -12
- package/dist/api.d.ts +3 -0
- package/dist/api.js +3 -0
- package/dist/base.d.ts +26 -0
- package/dist/base.js +243 -60
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -0
- package/dist/configuration.d.ts +17 -0
- package/dist/configuration.js +2 -0
- package/dist/models/assign-email-thread-entity-body-dto.d.ts +43 -0
- package/dist/models/assign-email-thread-entity-body-dto.js +22 -0
- package/dist/models/assign-email-thread-entity-response-class.d.ts +25 -0
- package/dist/models/assign-email-thread-entity-response-class.js +15 -0
- package/dist/models/catch-up-email-subscription-response-class.d.ts +24 -0
- package/dist/models/catch-up-email-subscription-response-class.js +15 -0
- package/dist/models/catch-up-email-subscriptions-request-dto.d.ts +24 -0
- package/dist/models/catch-up-email-subscriptions-request-dto.js +15 -0
- package/dist/models/catch-up-email-subscriptions-response-class.d.ts +30 -0
- package/dist/models/catch-up-email-subscriptions-response-class.js +15 -0
- package/dist/models/email-mailbox-class.d.ts +47 -0
- package/dist/models/email-mailbox-class.js +20 -0
- package/dist/models/email-message-class.d.ts +102 -7
- package/dist/models/email-message-class.js +25 -2
- package/dist/models/email-message-summary-class.d.ts +121 -0
- package/dist/models/email-message-summary-class.js +37 -0
- package/dist/models/email-subscription-class.d.ts +110 -0
- package/dist/models/email-subscription-class.js +23 -0
- package/dist/models/email-thread-class.d.ts +37 -5
- package/dist/models/entity-ref-class.d.ts +37 -0
- package/dist/models/entity-ref-class.js +22 -0
- package/dist/models/get-email-subscription-response-class.d.ts +25 -0
- package/dist/models/get-email-subscription-response-class.js +15 -0
- package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
- package/dist/models/grpc-send-email-request-dto.js +22 -0
- package/dist/models/index.d.ts +22 -0
- package/dist/models/index.js +22 -0
- package/dist/models/inline-attachment-dto.d.ts +36 -0
- package/dist/models/inline-attachment-dto.js +15 -0
- package/dist/models/list-email-mailboxes-response-class.d.ts +43 -0
- package/dist/models/list-email-mailboxes-response-class.js +15 -0
- package/dist/models/list-email-subscriptions-response-class.d.ts +43 -0
- package/dist/models/list-email-subscriptions-response-class.js +15 -0
- package/dist/models/reconcile-email-subscriptions-request-dto.d.ts +24 -0
- package/dist/models/reconcile-email-subscriptions-request-dto.js +15 -0
- package/dist/models/reconcile-email-subscriptions-response-class.d.ts +48 -0
- package/dist/models/reconcile-email-subscriptions-response-class.js +15 -0
- package/dist/models/renew-email-subscription-response-class.d.ts +25 -0
- package/dist/models/renew-email-subscription-response-class.js +15 -0
- package/dist/models/resend-email-message-body-dto.d.ts +30 -0
- package/dist/models/resend-email-message-body-dto.js +15 -0
- package/dist/models/resend-email-message-response-class.d.ts +25 -0
- package/dist/models/resend-email-message-response-class.js +15 -0
- package/dist/models/send-email-request-dto.d.ts +131 -0
- package/dist/models/send-email-request-dto.js +22 -0
- package/dist/models/send-email-response-class.d.ts +24 -0
- package/dist/models/send-email-response-class.js +15 -0
- package/dist/models/send-notification-request-dto.d.ts +10 -1
- package/dist/models/send-notification-request-dto.js +2 -1
- package/dist/models/unassign-email-thread-entity-response-class.d.ts +25 -0
- package/dist/models/unassign-email-thread-entity-response-class.js +15 -0
- package/models/assign-email-thread-entity-body-dto.ts +52 -0
- package/models/assign-email-thread-entity-response-class.ts +31 -0
- package/models/catch-up-email-subscription-response-class.ts +30 -0
- package/models/catch-up-email-subscriptions-request-dto.ts +30 -0
- package/models/catch-up-email-subscriptions-response-class.ts +36 -0
- package/models/email-mailbox-class.ts +56 -0
- package/models/email-message-class.ts +108 -8
- package/models/email-message-summary-class.ts +133 -0
- package/models/email-subscription-class.ts +119 -0
- package/models/email-thread-class.ts +37 -5
- package/models/entity-ref-class.ts +46 -0
- package/models/get-email-subscription-response-class.ts +31 -0
- package/models/grpc-send-email-request-dto.ts +144 -0
- package/models/index.ts +22 -0
- package/models/inline-attachment-dto.ts +42 -0
- package/models/list-email-mailboxes-response-class.ts +49 -0
- package/models/list-email-subscriptions-response-class.ts +49 -0
- package/models/reconcile-email-subscriptions-request-dto.ts +30 -0
- package/models/reconcile-email-subscriptions-response-class.ts +54 -0
- package/models/renew-email-subscription-response-class.ts +31 -0
- package/models/resend-email-message-body-dto.ts +36 -0
- package/models/resend-email-message-response-class.ts +31 -0
- package/models/send-email-request-dto.ts +138 -0
- package/models/send-email-response-class.ts +30 -0
- package/models/send-notification-request-dto.ts +9 -2
- package/models/unassign-email-thread-entity-response-class.ts +31 -0
- package/package.json +2 -2
|
@@ -0,0 +1,225 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* EMIL NotificationService
|
|
6
|
+
* The EMIL NotificationService API description
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
* Contact: kontakt@emil.de
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __extends = (this && this.__extends) || (function () {
|
|
16
|
+
var extendStatics = function (d, b) {
|
|
17
|
+
extendStatics = Object.setPrototypeOf ||
|
|
18
|
+
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
19
|
+
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
20
|
+
return extendStatics(d, b);
|
|
21
|
+
};
|
|
22
|
+
return function (d, b) {
|
|
23
|
+
if (typeof b !== "function" && b !== null)
|
|
24
|
+
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
25
|
+
extendStatics(d, b);
|
|
26
|
+
function __() { this.constructor = d; }
|
|
27
|
+
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
28
|
+
};
|
|
29
|
+
})();
|
|
30
|
+
var __assign = (this && this.__assign) || function () {
|
|
31
|
+
__assign = Object.assign || function(t) {
|
|
32
|
+
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
33
|
+
s = arguments[i];
|
|
34
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
35
|
+
t[p] = s[p];
|
|
36
|
+
}
|
|
37
|
+
return t;
|
|
38
|
+
};
|
|
39
|
+
return __assign.apply(this, arguments);
|
|
40
|
+
};
|
|
41
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
42
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
43
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
44
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
45
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
46
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
47
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
48
|
+
});
|
|
49
|
+
};
|
|
50
|
+
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
51
|
+
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
|
|
52
|
+
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
53
|
+
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
54
|
+
function step(op) {
|
|
55
|
+
if (f) throw new TypeError("Generator is already executing.");
|
|
56
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
57
|
+
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
58
|
+
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
59
|
+
switch (op[0]) {
|
|
60
|
+
case 0: case 1: t = op; break;
|
|
61
|
+
case 4: _.label++; return { value: op[1], done: false };
|
|
62
|
+
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
63
|
+
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
64
|
+
default:
|
|
65
|
+
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
66
|
+
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
67
|
+
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
68
|
+
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
69
|
+
if (t[2]) _.ops.pop();
|
|
70
|
+
_.trys.pop(); continue;
|
|
71
|
+
}
|
|
72
|
+
op = body.call(thisArg, _);
|
|
73
|
+
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
74
|
+
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
75
|
+
}
|
|
76
|
+
};
|
|
77
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
78
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
79
|
+
};
|
|
80
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
81
|
+
exports.EmailMailboxesApi = exports.EmailMailboxesApiFactory = exports.EmailMailboxesApiFp = exports.EmailMailboxesApiAxiosParamCreator = void 0;
|
|
82
|
+
var axios_1 = __importDefault(require("axios"));
|
|
83
|
+
// Some imports not used depending on template conditions
|
|
84
|
+
// @ts-ignore
|
|
85
|
+
var common_1 = require("../common");
|
|
86
|
+
// @ts-ignore
|
|
87
|
+
var base_1 = require("../base");
|
|
88
|
+
/**
|
|
89
|
+
* EmailMailboxesApi - axios parameter creator
|
|
90
|
+
* @export
|
|
91
|
+
*/
|
|
92
|
+
var EmailMailboxesApiAxiosParamCreator = function (configuration) {
|
|
93
|
+
var _this = this;
|
|
94
|
+
return {
|
|
95
|
+
/**
|
|
96
|
+
* Returns the mailboxes of the tenant, sorted by address: the ones its email channel is configured with, merged with the ones that still have messages. Each mailbox carries how many messages it holds per direction. Use the address as the `mailbox` filter when listing email threads or messages. **Required Permissions** \"notification-management.email-messages.view\"
|
|
97
|
+
* @summary List the email mailboxes
|
|
98
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
99
|
+
* @param {*} [options] Override http request option.
|
|
100
|
+
* @throws {RequiredError}
|
|
101
|
+
*/
|
|
102
|
+
listEmailMailboxes: function (authorization, options) {
|
|
103
|
+
if (options === void 0) { options = {}; }
|
|
104
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
105
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationIsAuth, authorizationValue, authorizationKeepEmpty, headersFromBaseOptions;
|
|
106
|
+
var _a;
|
|
107
|
+
return __generator(this, function (_b) {
|
|
108
|
+
switch (_b.label) {
|
|
109
|
+
case 0:
|
|
110
|
+
localVarPath = "/notificationservice/v1/email-mailboxes";
|
|
111
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
112
|
+
if (configuration) {
|
|
113
|
+
baseOptions = configuration.baseOptions;
|
|
114
|
+
baseAccessToken = configuration.accessToken;
|
|
115
|
+
}
|
|
116
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
117
|
+
localVarHeaderParameter = {};
|
|
118
|
+
localVarQueryParameter = {};
|
|
119
|
+
// authentication bearer required
|
|
120
|
+
// http bearer authentication required
|
|
121
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
122
|
+
// Only Authorization falls back to the configured token. Without a session it is sent as before, empty when
|
|
123
|
+
// no token is stored, so a refused call still refreshes; a session call (account header) sends none.
|
|
124
|
+
];
|
|
125
|
+
case 1:
|
|
126
|
+
// authentication bearer required
|
|
127
|
+
// http bearer authentication required
|
|
128
|
+
_b.sent();
|
|
129
|
+
authorizationIsAuth = 'Authorization'.toLowerCase() === 'authorization';
|
|
130
|
+
authorizationValue = authorizationIsAuth ? (authorization || baseAccessToken) : authorization;
|
|
131
|
+
authorizationKeepEmpty = authorizationIsAuth && authorizationValue === '' && !((_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) === null || _a === void 0 ? void 0 : _a['X-Emil-Account']);
|
|
132
|
+
if (authorizationValue || authorizationKeepEmpty) {
|
|
133
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
134
|
+
}
|
|
135
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
136
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
137
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
138
|
+
return [2 /*return*/, {
|
|
139
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
140
|
+
options: localVarRequestOptions,
|
|
141
|
+
}];
|
|
142
|
+
}
|
|
143
|
+
});
|
|
144
|
+
});
|
|
145
|
+
},
|
|
146
|
+
};
|
|
147
|
+
};
|
|
148
|
+
exports.EmailMailboxesApiAxiosParamCreator = EmailMailboxesApiAxiosParamCreator;
|
|
149
|
+
/**
|
|
150
|
+
* EmailMailboxesApi - functional programming interface
|
|
151
|
+
* @export
|
|
152
|
+
*/
|
|
153
|
+
var EmailMailboxesApiFp = function (configuration) {
|
|
154
|
+
var localVarAxiosParamCreator = (0, exports.EmailMailboxesApiAxiosParamCreator)(configuration);
|
|
155
|
+
return {
|
|
156
|
+
/**
|
|
157
|
+
* Returns the mailboxes of the tenant, sorted by address: the ones its email channel is configured with, merged with the ones that still have messages. Each mailbox carries how many messages it holds per direction. Use the address as the `mailbox` filter when listing email threads or messages. **Required Permissions** \"notification-management.email-messages.view\"
|
|
158
|
+
* @summary List the email mailboxes
|
|
159
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
160
|
+
* @param {*} [options] Override http request option.
|
|
161
|
+
* @throws {RequiredError}
|
|
162
|
+
*/
|
|
163
|
+
listEmailMailboxes: function (authorization, options) {
|
|
164
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
165
|
+
var localVarAxiosArgs;
|
|
166
|
+
return __generator(this, function (_a) {
|
|
167
|
+
switch (_a.label) {
|
|
168
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listEmailMailboxes(authorization, options)];
|
|
169
|
+
case 1:
|
|
170
|
+
localVarAxiosArgs = _a.sent();
|
|
171
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
172
|
+
}
|
|
173
|
+
});
|
|
174
|
+
});
|
|
175
|
+
},
|
|
176
|
+
};
|
|
177
|
+
};
|
|
178
|
+
exports.EmailMailboxesApiFp = EmailMailboxesApiFp;
|
|
179
|
+
/**
|
|
180
|
+
* EmailMailboxesApi - factory interface
|
|
181
|
+
* @export
|
|
182
|
+
*/
|
|
183
|
+
var EmailMailboxesApiFactory = function (configuration, basePath, axios) {
|
|
184
|
+
var localVarFp = (0, exports.EmailMailboxesApiFp)(configuration);
|
|
185
|
+
return {
|
|
186
|
+
/**
|
|
187
|
+
* Returns the mailboxes of the tenant, sorted by address: the ones its email channel is configured with, merged with the ones that still have messages. Each mailbox carries how many messages it holds per direction. Use the address as the `mailbox` filter when listing email threads or messages. **Required Permissions** \"notification-management.email-messages.view\"
|
|
188
|
+
* @summary List the email mailboxes
|
|
189
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
190
|
+
* @param {*} [options] Override http request option.
|
|
191
|
+
* @throws {RequiredError}
|
|
192
|
+
*/
|
|
193
|
+
listEmailMailboxes: function (authorization, options) {
|
|
194
|
+
return localVarFp.listEmailMailboxes(authorization, options).then(function (request) { return request(axios, basePath); });
|
|
195
|
+
},
|
|
196
|
+
};
|
|
197
|
+
};
|
|
198
|
+
exports.EmailMailboxesApiFactory = EmailMailboxesApiFactory;
|
|
199
|
+
/**
|
|
200
|
+
* EmailMailboxesApi - object-oriented interface
|
|
201
|
+
* @export
|
|
202
|
+
* @class EmailMailboxesApi
|
|
203
|
+
* @extends {BaseAPI}
|
|
204
|
+
*/
|
|
205
|
+
var EmailMailboxesApi = /** @class */ (function (_super) {
|
|
206
|
+
__extends(EmailMailboxesApi, _super);
|
|
207
|
+
function EmailMailboxesApi() {
|
|
208
|
+
return _super !== null && _super.apply(this, arguments) || this;
|
|
209
|
+
}
|
|
210
|
+
/**
|
|
211
|
+
* Returns the mailboxes of the tenant, sorted by address: the ones its email channel is configured with, merged with the ones that still have messages. Each mailbox carries how many messages it holds per direction. Use the address as the `mailbox` filter when listing email threads or messages. **Required Permissions** \"notification-management.email-messages.view\"
|
|
212
|
+
* @summary List the email mailboxes
|
|
213
|
+
* @param {EmailMailboxesApiListEmailMailboxesRequest} requestParameters Request parameters.
|
|
214
|
+
* @param {*} [options] Override http request option.
|
|
215
|
+
* @throws {RequiredError}
|
|
216
|
+
* @memberof EmailMailboxesApi
|
|
217
|
+
*/
|
|
218
|
+
EmailMailboxesApi.prototype.listEmailMailboxes = function (requestParameters, options) {
|
|
219
|
+
var _this = this;
|
|
220
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
221
|
+
return (0, exports.EmailMailboxesApiFp)(this.configuration).listEmailMailboxes(requestParameters.authorization, this.withOwner(options)).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
222
|
+
};
|
|
223
|
+
return EmailMailboxesApi;
|
|
224
|
+
}(base_1.BaseAPI));
|
|
225
|
+
exports.EmailMailboxesApi = EmailMailboxesApi;
|
|
@@ -16,13 +16,16 @@ import { DownloadAttachmentResponseClass } from '../models';
|
|
|
16
16
|
import { GetEmailMessageResponseClass } from '../models';
|
|
17
17
|
import { ListEmailAttachmentsResponseClass } from '../models';
|
|
18
18
|
import { ListEmailMessagesResponseClass } from '../models';
|
|
19
|
+
import { ResendEmailMessageBodyDto } from '../models';
|
|
20
|
+
import { ResendEmailMessageResponseClass } from '../models';
|
|
19
21
|
/**
|
|
20
22
|
* EmailMessagesApi - axios parameter creator
|
|
21
23
|
* @export
|
|
22
24
|
*/
|
|
23
25
|
export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
26
|
/**
|
|
25
|
-
*
|
|
27
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
28
|
+
* @summary Download the email message attachment
|
|
26
29
|
* @param {string} code
|
|
27
30
|
* @param {number} attachmentId
|
|
28
31
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -31,7 +34,8 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
31
34
|
*/
|
|
32
35
|
downloadAttachment: (code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
36
|
/**
|
|
34
|
-
*
|
|
37
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
38
|
+
* @summary Retrieve the email message
|
|
35
39
|
* @param {string} code
|
|
36
40
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
37
41
|
* @param {*} [options] Override http request option.
|
|
@@ -39,7 +43,8 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
39
43
|
*/
|
|
40
44
|
getMessage: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41
45
|
/**
|
|
42
|
-
*
|
|
46
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
47
|
+
* @summary List the email message attachments
|
|
43
48
|
* @param {string} code
|
|
44
49
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
45
50
|
* @param {*} [options] Override http request option.
|
|
@@ -47,20 +52,30 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
47
52
|
*/
|
|
48
53
|
listAttachments: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
54
|
/**
|
|
50
|
-
*
|
|
55
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
51
56
|
* @summary List email messages
|
|
52
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
53
58
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
54
59
|
* @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.
|
|
55
|
-
* @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>
|
|
60
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
56
61
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
57
|
-
* @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>
|
|
62
|
+
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
58
63
|
* @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>
|
|
59
|
-
* @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>
|
|
64
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
60
65
|
* @param {*} [options] Override http request option.
|
|
61
66
|
* @throws {RequiredError}
|
|
62
67
|
*/
|
|
63
68
|
listEmailMessages: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
|
+
/**
|
|
70
|
+
* Sends an outgoing email with delivery status bounced or failed again, as a new email in the same thread, and returns the new email. A bounced email is resent to every recipient that bounced, not to the recipients that received it. newAddress replaces one bounced recipient; pass recipient to name it when more than one bounced. A failed email is resent to all its original recipients; recipient and newAddress are not allowed for it. The original email is not changed and can be resent again. The new email starts as pending and carries resentFromMessageCode, resendReason and, for a bounce, resentOriginalRecipient. **Required Permissions** \"notification-management.email-messages.create\"
|
|
71
|
+
* @summary Resend the email message
|
|
72
|
+
* @param {string} code
|
|
73
|
+
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
74
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
75
|
+
* @param {*} [options] Override http request option.
|
|
76
|
+
* @throws {RequiredError}
|
|
77
|
+
*/
|
|
78
|
+
resendMessage: (code: string, resendEmailMessageBodyDto: ResendEmailMessageBodyDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
79
|
};
|
|
65
80
|
/**
|
|
66
81
|
* EmailMessagesApi - functional programming interface
|
|
@@ -68,7 +83,8 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
68
83
|
*/
|
|
69
84
|
export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
70
85
|
/**
|
|
71
|
-
*
|
|
86
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
87
|
+
* @summary Download the email message attachment
|
|
72
88
|
* @param {string} code
|
|
73
89
|
* @param {number} attachmentId
|
|
74
90
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -77,7 +93,8 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
77
93
|
*/
|
|
78
94
|
downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DownloadAttachmentResponseClass>>;
|
|
79
95
|
/**
|
|
80
|
-
*
|
|
96
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
97
|
+
* @summary Retrieve the email message
|
|
81
98
|
* @param {string} code
|
|
82
99
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
83
100
|
* @param {*} [options] Override http request option.
|
|
@@ -85,7 +102,8 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
85
102
|
*/
|
|
86
103
|
getMessage(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailMessageResponseClass>>;
|
|
87
104
|
/**
|
|
88
|
-
*
|
|
105
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
106
|
+
* @summary List the email message attachments
|
|
89
107
|
* @param {string} code
|
|
90
108
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
91
109
|
* @param {*} [options] Override http request option.
|
|
@@ -93,20 +111,30 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
93
111
|
*/
|
|
94
112
|
listAttachments(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailAttachmentsResponseClass>>;
|
|
95
113
|
/**
|
|
96
|
-
*
|
|
114
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
97
115
|
* @summary List email messages
|
|
98
116
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
99
117
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
100
118
|
* @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.
|
|
101
|
-
* @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>
|
|
119
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
102
120
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
103
|
-
* @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>
|
|
121
|
+
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
104
122
|
* @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>
|
|
105
|
-
* @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>
|
|
123
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
106
124
|
* @param {*} [options] Override http request option.
|
|
107
125
|
* @throws {RequiredError}
|
|
108
126
|
*/
|
|
109
127
|
listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>>;
|
|
128
|
+
/**
|
|
129
|
+
* Sends an outgoing email with delivery status bounced or failed again, as a new email in the same thread, and returns the new email. A bounced email is resent to every recipient that bounced, not to the recipients that received it. newAddress replaces one bounced recipient; pass recipient to name it when more than one bounced. A failed email is resent to all its original recipients; recipient and newAddress are not allowed for it. The original email is not changed and can be resent again. The new email starts as pending and carries resentFromMessageCode, resendReason and, for a bounce, resentOriginalRecipient. **Required Permissions** \"notification-management.email-messages.create\"
|
|
130
|
+
* @summary Resend the email message
|
|
131
|
+
* @param {string} code
|
|
132
|
+
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
133
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
*/
|
|
137
|
+
resendMessage(code: string, resendEmailMessageBodyDto: ResendEmailMessageBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResendEmailMessageResponseClass>>;
|
|
110
138
|
};
|
|
111
139
|
/**
|
|
112
140
|
* EmailMessagesApi - factory interface
|
|
@@ -114,7 +142,8 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
114
142
|
*/
|
|
115
143
|
export declare const EmailMessagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
116
144
|
/**
|
|
117
|
-
*
|
|
145
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
146
|
+
* @summary Download the email message attachment
|
|
118
147
|
* @param {string} code
|
|
119
148
|
* @param {number} attachmentId
|
|
120
149
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -123,7 +152,8 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
123
152
|
*/
|
|
124
153
|
downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: any): AxiosPromise<DownloadAttachmentResponseClass>;
|
|
125
154
|
/**
|
|
126
|
-
*
|
|
155
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
156
|
+
* @summary Retrieve the email message
|
|
127
157
|
* @param {string} code
|
|
128
158
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
129
159
|
* @param {*} [options] Override http request option.
|
|
@@ -131,7 +161,8 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
131
161
|
*/
|
|
132
162
|
getMessage(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailMessageResponseClass>;
|
|
133
163
|
/**
|
|
134
|
-
*
|
|
164
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
165
|
+
* @summary List the email message attachments
|
|
135
166
|
* @param {string} code
|
|
136
167
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
137
168
|
* @param {*} [options] Override http request option.
|
|
@@ -139,20 +170,30 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
139
170
|
*/
|
|
140
171
|
listAttachments(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailAttachmentsResponseClass>;
|
|
141
172
|
/**
|
|
142
|
-
*
|
|
173
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
143
174
|
* @summary List email messages
|
|
144
175
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
145
176
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
146
177
|
* @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.
|
|
147
|
-
* @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>
|
|
178
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
148
179
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
149
|
-
* @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>
|
|
180
|
+
* @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
150
181
|
* @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>
|
|
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, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
182
|
+
* @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
152
183
|
* @param {*} [options] Override http request option.
|
|
153
184
|
* @throws {RequiredError}
|
|
154
185
|
*/
|
|
155
186
|
listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass>;
|
|
187
|
+
/**
|
|
188
|
+
* Sends an outgoing email with delivery status bounced or failed again, as a new email in the same thread, and returns the new email. A bounced email is resent to every recipient that bounced, not to the recipients that received it. newAddress replaces one bounced recipient; pass recipient to name it when more than one bounced. A failed email is resent to all its original recipients; recipient and newAddress are not allowed for it. The original email is not changed and can be resent again. The new email starts as pending and carries resentFromMessageCode, resendReason and, for a bounce, resentOriginalRecipient. **Required Permissions** \"notification-management.email-messages.create\"
|
|
189
|
+
* @summary Resend the email message
|
|
190
|
+
* @param {string} code
|
|
191
|
+
* @param {ResendEmailMessageBodyDto} resendEmailMessageBodyDto
|
|
192
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
|
+
* @param {*} [options] Override http request option.
|
|
194
|
+
* @throws {RequiredError}
|
|
195
|
+
*/
|
|
196
|
+
resendMessage(code: string, resendEmailMessageBodyDto: ResendEmailMessageBodyDto, authorization?: string, options?: any): AxiosPromise<ResendEmailMessageResponseClass>;
|
|
156
197
|
};
|
|
157
198
|
/**
|
|
158
199
|
* Request parameters for downloadAttachment operation in EmailMessagesApi.
|
|
@@ -242,7 +283,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
242
283
|
*/
|
|
243
284
|
readonly pageToken?: string;
|
|
244
285
|
/**
|
|
245
|
-
* 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>
|
|
286
|
+
* 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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
246
287
|
* @type {string}
|
|
247
288
|
* @memberof EmailMessagesApiListEmailMessages
|
|
248
289
|
*/
|
|
@@ -254,7 +295,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
254
295
|
*/
|
|
255
296
|
readonly search?: string;
|
|
256
297
|
/**
|
|
257
|
-
* 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>
|
|
298
|
+
* 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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
258
299
|
* @type {string}
|
|
259
300
|
* @memberof EmailMessagesApiListEmailMessages
|
|
260
301
|
*/
|
|
@@ -266,12 +307,37 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
266
307
|
*/
|
|
267
308
|
readonly expand?: string;
|
|
268
309
|
/**
|
|
269
|
-
* 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>
|
|
310
|
+
* 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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, resentFromMessageCode, resendReason, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
270
311
|
* @type {string}
|
|
271
312
|
* @memberof EmailMessagesApiListEmailMessages
|
|
272
313
|
*/
|
|
273
314
|
readonly filters?: string;
|
|
274
315
|
}
|
|
316
|
+
/**
|
|
317
|
+
* Request parameters for resendMessage operation in EmailMessagesApi.
|
|
318
|
+
* @export
|
|
319
|
+
* @interface EmailMessagesApiResendMessageRequest
|
|
320
|
+
*/
|
|
321
|
+
export interface EmailMessagesApiResendMessageRequest {
|
|
322
|
+
/**
|
|
323
|
+
*
|
|
324
|
+
* @type {string}
|
|
325
|
+
* @memberof EmailMessagesApiResendMessage
|
|
326
|
+
*/
|
|
327
|
+
readonly code: string;
|
|
328
|
+
/**
|
|
329
|
+
*
|
|
330
|
+
* @type {ResendEmailMessageBodyDto}
|
|
331
|
+
* @memberof EmailMessagesApiResendMessage
|
|
332
|
+
*/
|
|
333
|
+
readonly resendEmailMessageBodyDto: ResendEmailMessageBodyDto;
|
|
334
|
+
/**
|
|
335
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
336
|
+
* @type {string}
|
|
337
|
+
* @memberof EmailMessagesApiResendMessage
|
|
338
|
+
*/
|
|
339
|
+
readonly authorization?: string;
|
|
340
|
+
}
|
|
275
341
|
/**
|
|
276
342
|
* EmailMessagesApi - object-oriented interface
|
|
277
343
|
* @export
|
|
@@ -280,36 +346,48 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
280
346
|
*/
|
|
281
347
|
export declare class EmailMessagesApi extends BaseAPI {
|
|
282
348
|
/**
|
|
283
|
-
*
|
|
349
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
350
|
+
* @summary Download the email message attachment
|
|
284
351
|
* @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
|
|
285
352
|
* @param {*} [options] Override http request option.
|
|
286
353
|
* @throws {RequiredError}
|
|
287
354
|
* @memberof EmailMessagesApi
|
|
288
355
|
*/
|
|
289
|
-
downloadAttachment(requestParameters: EmailMessagesApiDownloadAttachmentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DownloadAttachmentResponseClass, any, {}>>;
|
|
356
|
+
downloadAttachment(requestParameters: EmailMessagesApiDownloadAttachmentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DownloadAttachmentResponseClass, any, {}, any>>;
|
|
290
357
|
/**
|
|
291
|
-
*
|
|
358
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
359
|
+
* @summary Retrieve the email message
|
|
292
360
|
* @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
|
|
293
361
|
* @param {*} [options] Override http request option.
|
|
294
362
|
* @throws {RequiredError}
|
|
295
363
|
* @memberof EmailMessagesApi
|
|
296
364
|
*/
|
|
297
|
-
getMessage(requestParameters: EmailMessagesApiGetMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailMessageResponseClass, any, {}>>;
|
|
365
|
+
getMessage(requestParameters: EmailMessagesApiGetMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailMessageResponseClass, any, {}, any>>;
|
|
298
366
|
/**
|
|
299
|
-
*
|
|
367
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
368
|
+
* @summary List the email message attachments
|
|
300
369
|
* @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
|
|
301
370
|
* @param {*} [options] Override http request option.
|
|
302
371
|
* @throws {RequiredError}
|
|
303
372
|
* @memberof EmailMessagesApi
|
|
304
373
|
*/
|
|
305
|
-
listAttachments(requestParameters: EmailMessagesApiListAttachmentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailAttachmentsResponseClass, any, {}>>;
|
|
374
|
+
listAttachments(requestParameters: EmailMessagesApiListAttachmentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailAttachmentsResponseClass, any, {}, any>>;
|
|
306
375
|
/**
|
|
307
|
-
*
|
|
376
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
308
377
|
* @summary List email messages
|
|
309
378
|
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
310
379
|
* @param {*} [options] Override http request option.
|
|
311
380
|
* @throws {RequiredError}
|
|
312
381
|
* @memberof EmailMessagesApi
|
|
313
382
|
*/
|
|
314
|
-
listEmailMessages(requestParameters?: EmailMessagesApiListEmailMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailMessagesResponseClass, any, {}>>;
|
|
383
|
+
listEmailMessages(requestParameters?: EmailMessagesApiListEmailMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailMessagesResponseClass, any, {}, any>>;
|
|
384
|
+
/**
|
|
385
|
+
* Sends an outgoing email with delivery status bounced or failed again, as a new email in the same thread, and returns the new email. A bounced email is resent to every recipient that bounced, not to the recipients that received it. newAddress replaces one bounced recipient; pass recipient to name it when more than one bounced. A failed email is resent to all its original recipients; recipient and newAddress are not allowed for it. The original email is not changed and can be resent again. The new email starts as pending and carries resentFromMessageCode, resendReason and, for a bounce, resentOriginalRecipient. **Required Permissions** \"notification-management.email-messages.create\"
|
|
386
|
+
* @summary Resend the email message
|
|
387
|
+
* @param {EmailMessagesApiResendMessageRequest} requestParameters Request parameters.
|
|
388
|
+
* @param {*} [options] Override http request option.
|
|
389
|
+
* @throws {RequiredError}
|
|
390
|
+
* @memberof EmailMessagesApi
|
|
391
|
+
*/
|
|
392
|
+
resendMessage(requestParameters: EmailMessagesApiResendMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResendEmailMessageResponseClass, any, {}, any>>;
|
|
315
393
|
}
|