@emilgroup/notification-sdk 0.8.1-beta.5 → 0.8.1-beta.50
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 +20 -0
- package/README.md +2 -2
- package/api/email-mailboxes-api.ts +148 -0
- package/api/email-messages-api.ts +40 -28
- package/api/email-subscriptions-api.ts +559 -0
- package/api/email-tracking-api.ts +271 -40
- package/api/email-verifications-api.ts +16 -8
- package/api/layouts-api.ts +56 -36
- package/api/msgraph-webhooks-api.ts +278 -0
- package/api/notification-templates-api.ts +56 -36
- package/api/notifications-api.ts +115 -4
- package/api.ts +6 -0
- package/base.ts +36 -15
- package/configuration.ts +11 -0
- package/dist/api/email-mailboxes-api.d.ts +87 -0
- package/dist/api/email-mailboxes-api.js +218 -0
- package/dist/api/email-messages-api.d.ts +40 -28
- package/dist/api/email-messages-api.js +37 -25
- package/dist/api/email-subscriptions-api.d.ts +319 -0
- package/dist/api/email-subscriptions-api.js +537 -0
- package/dist/api/email-tracking-api.d.ts +170 -40
- package/dist/api/email-tracking-api.js +233 -34
- package/dist/api/email-verifications-api.d.ts +16 -8
- package/dist/api/email-verifications-api.js +16 -8
- package/dist/api/layouts-api.d.ts +56 -36
- package/dist/api/layouts-api.js +52 -32
- 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 +56 -36
- package/dist/api/notification-templates-api.js +52 -32
- package/dist/api/notifications-api.d.ts +65 -4
- package/dist/api/notifications-api.js +101 -4
- package/dist/api.d.ts +3 -0
- package/dist/api.js +3 -0
- package/dist/base.d.ts +1 -0
- package/dist/base.js +36 -16
- package/dist/configuration.d.ts +9 -0
- package/dist/configuration.js +1 -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/email-mailbox-class.d.ts +47 -0
- package/dist/models/email-mailbox-class.js +20 -0
- package/dist/models/email-message-class.d.ts +73 -7
- package/dist/models/email-message-class.js +22 -3
- package/dist/models/email-message-summary-class.d.ts +98 -0
- package/dist/models/email-message-summary-class.js +33 -0
- package/dist/models/email-subscription-class.d.ts +104 -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 +17 -0
- package/dist/models/index.js +17 -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/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/email-mailbox-class.ts +56 -0
- package/models/email-message-class.ts +78 -8
- package/models/email-message-summary-class.ts +109 -0
- package/models/email-subscription-class.ts +113 -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 +17 -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/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 +1 -1
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL NotificationService
|
|
3
|
+
* The EMIL NotificationService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
|
+
import { Configuration } from '../configuration';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { ListEmailMailboxesResponseClass } from '../models';
|
|
16
|
+
/**
|
|
17
|
+
* EmailMailboxesApi - axios parameter creator
|
|
18
|
+
* @export
|
|
19
|
+
*/
|
|
20
|
+
export declare const EmailMailboxesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
|
+
/**
|
|
22
|
+
* 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\"
|
|
23
|
+
* @summary List the email mailboxes
|
|
24
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
25
|
+
* @param {*} [options] Override http request option.
|
|
26
|
+
* @throws {RequiredError}
|
|
27
|
+
*/
|
|
28
|
+
listEmailMailboxes: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* EmailMailboxesApi - functional programming interface
|
|
32
|
+
* @export
|
|
33
|
+
*/
|
|
34
|
+
export declare const EmailMailboxesApiFp: (configuration?: Configuration) => {
|
|
35
|
+
/**
|
|
36
|
+
* 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\"
|
|
37
|
+
* @summary List the email mailboxes
|
|
38
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
39
|
+
* @param {*} [options] Override http request option.
|
|
40
|
+
* @throws {RequiredError}
|
|
41
|
+
*/
|
|
42
|
+
listEmailMailboxes(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMailboxesResponseClass>>;
|
|
43
|
+
};
|
|
44
|
+
/**
|
|
45
|
+
* EmailMailboxesApi - factory interface
|
|
46
|
+
* @export
|
|
47
|
+
*/
|
|
48
|
+
export declare const EmailMailboxesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
49
|
+
/**
|
|
50
|
+
* 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\"
|
|
51
|
+
* @summary List the email mailboxes
|
|
52
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
53
|
+
* @param {*} [options] Override http request option.
|
|
54
|
+
* @throws {RequiredError}
|
|
55
|
+
*/
|
|
56
|
+
listEmailMailboxes(authorization?: string, options?: any): AxiosPromise<ListEmailMailboxesResponseClass>;
|
|
57
|
+
};
|
|
58
|
+
/**
|
|
59
|
+
* Request parameters for listEmailMailboxes operation in EmailMailboxesApi.
|
|
60
|
+
* @export
|
|
61
|
+
* @interface EmailMailboxesApiListEmailMailboxesRequest
|
|
62
|
+
*/
|
|
63
|
+
export interface EmailMailboxesApiListEmailMailboxesRequest {
|
|
64
|
+
/**
|
|
65
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
66
|
+
* @type {string}
|
|
67
|
+
* @memberof EmailMailboxesApiListEmailMailboxes
|
|
68
|
+
*/
|
|
69
|
+
readonly authorization?: string;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* EmailMailboxesApi - object-oriented interface
|
|
73
|
+
* @export
|
|
74
|
+
* @class EmailMailboxesApi
|
|
75
|
+
* @extends {BaseAPI}
|
|
76
|
+
*/
|
|
77
|
+
export declare class EmailMailboxesApi extends BaseAPI {
|
|
78
|
+
/**
|
|
79
|
+
* 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\"
|
|
80
|
+
* @summary List the email mailboxes
|
|
81
|
+
* @param {EmailMailboxesApiListEmailMailboxesRequest} requestParameters Request parameters.
|
|
82
|
+
* @param {*} [options] Override http request option.
|
|
83
|
+
* @throws {RequiredError}
|
|
84
|
+
* @memberof EmailMailboxesApi
|
|
85
|
+
*/
|
|
86
|
+
listEmailMailboxes(requestParameters?: EmailMailboxesApiListEmailMailboxesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailMailboxesResponseClass, any, {}>>;
|
|
87
|
+
}
|
|
@@ -0,0 +1,218 @@
|
|
|
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, headersFromBaseOptions;
|
|
106
|
+
return __generator(this, function (_a) {
|
|
107
|
+
switch (_a.label) {
|
|
108
|
+
case 0:
|
|
109
|
+
localVarPath = "/notificationservice/v1/email-mailboxes";
|
|
110
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
111
|
+
if (configuration) {
|
|
112
|
+
baseOptions = configuration.baseOptions;
|
|
113
|
+
baseAccessToken = configuration.accessToken;
|
|
114
|
+
}
|
|
115
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
116
|
+
localVarHeaderParameter = {};
|
|
117
|
+
localVarQueryParameter = {};
|
|
118
|
+
// authentication bearer required
|
|
119
|
+
// http bearer authentication required
|
|
120
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
121
|
+
case 1:
|
|
122
|
+
// authentication bearer required
|
|
123
|
+
// http bearer authentication required
|
|
124
|
+
_a.sent();
|
|
125
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
126
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
127
|
+
}
|
|
128
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
129
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
130
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
131
|
+
return [2 /*return*/, {
|
|
132
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
133
|
+
options: localVarRequestOptions,
|
|
134
|
+
}];
|
|
135
|
+
}
|
|
136
|
+
});
|
|
137
|
+
});
|
|
138
|
+
},
|
|
139
|
+
};
|
|
140
|
+
};
|
|
141
|
+
exports.EmailMailboxesApiAxiosParamCreator = EmailMailboxesApiAxiosParamCreator;
|
|
142
|
+
/**
|
|
143
|
+
* EmailMailboxesApi - functional programming interface
|
|
144
|
+
* @export
|
|
145
|
+
*/
|
|
146
|
+
var EmailMailboxesApiFp = function (configuration) {
|
|
147
|
+
var localVarAxiosParamCreator = (0, exports.EmailMailboxesApiAxiosParamCreator)(configuration);
|
|
148
|
+
return {
|
|
149
|
+
/**
|
|
150
|
+
* 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\"
|
|
151
|
+
* @summary List the email mailboxes
|
|
152
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
153
|
+
* @param {*} [options] Override http request option.
|
|
154
|
+
* @throws {RequiredError}
|
|
155
|
+
*/
|
|
156
|
+
listEmailMailboxes: function (authorization, options) {
|
|
157
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
158
|
+
var localVarAxiosArgs;
|
|
159
|
+
return __generator(this, function (_a) {
|
|
160
|
+
switch (_a.label) {
|
|
161
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listEmailMailboxes(authorization, options)];
|
|
162
|
+
case 1:
|
|
163
|
+
localVarAxiosArgs = _a.sent();
|
|
164
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
165
|
+
}
|
|
166
|
+
});
|
|
167
|
+
});
|
|
168
|
+
},
|
|
169
|
+
};
|
|
170
|
+
};
|
|
171
|
+
exports.EmailMailboxesApiFp = EmailMailboxesApiFp;
|
|
172
|
+
/**
|
|
173
|
+
* EmailMailboxesApi - factory interface
|
|
174
|
+
* @export
|
|
175
|
+
*/
|
|
176
|
+
var EmailMailboxesApiFactory = function (configuration, basePath, axios) {
|
|
177
|
+
var localVarFp = (0, exports.EmailMailboxesApiFp)(configuration);
|
|
178
|
+
return {
|
|
179
|
+
/**
|
|
180
|
+
* 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\"
|
|
181
|
+
* @summary List the email mailboxes
|
|
182
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
183
|
+
* @param {*} [options] Override http request option.
|
|
184
|
+
* @throws {RequiredError}
|
|
185
|
+
*/
|
|
186
|
+
listEmailMailboxes: function (authorization, options) {
|
|
187
|
+
return localVarFp.listEmailMailboxes(authorization, options).then(function (request) { return request(axios, basePath); });
|
|
188
|
+
},
|
|
189
|
+
};
|
|
190
|
+
};
|
|
191
|
+
exports.EmailMailboxesApiFactory = EmailMailboxesApiFactory;
|
|
192
|
+
/**
|
|
193
|
+
* EmailMailboxesApi - object-oriented interface
|
|
194
|
+
* @export
|
|
195
|
+
* @class EmailMailboxesApi
|
|
196
|
+
* @extends {BaseAPI}
|
|
197
|
+
*/
|
|
198
|
+
var EmailMailboxesApi = /** @class */ (function (_super) {
|
|
199
|
+
__extends(EmailMailboxesApi, _super);
|
|
200
|
+
function EmailMailboxesApi() {
|
|
201
|
+
return _super !== null && _super.apply(this, arguments) || this;
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* 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\"
|
|
205
|
+
* @summary List the email mailboxes
|
|
206
|
+
* @param {EmailMailboxesApiListEmailMailboxesRequest} requestParameters Request parameters.
|
|
207
|
+
* @param {*} [options] Override http request option.
|
|
208
|
+
* @throws {RequiredError}
|
|
209
|
+
* @memberof EmailMailboxesApi
|
|
210
|
+
*/
|
|
211
|
+
EmailMailboxesApi.prototype.listEmailMailboxes = function (requestParameters, options) {
|
|
212
|
+
var _this = this;
|
|
213
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
214
|
+
return (0, exports.EmailMailboxesApiFp)(this.configuration).listEmailMailboxes(requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
215
|
+
};
|
|
216
|
+
return EmailMailboxesApi;
|
|
217
|
+
}(base_1.BaseAPI));
|
|
218
|
+
exports.EmailMailboxesApi = EmailMailboxesApi;
|
|
@@ -22,7 +22,8 @@ import { ListEmailMessagesResponseClass } from '../models';
|
|
|
22
22
|
*/
|
|
23
23
|
export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
26
|
+
* @summary Download the email message attachment
|
|
26
27
|
* @param {string} code
|
|
27
28
|
* @param {number} attachmentId
|
|
28
29
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -31,7 +32,8 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
31
32
|
*/
|
|
32
33
|
downloadAttachment: (code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
34
|
/**
|
|
34
|
-
*
|
|
35
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
36
|
+
* @summary Retrieve the email message
|
|
35
37
|
* @param {string} code
|
|
36
38
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
37
39
|
* @param {*} [options] Override http request option.
|
|
@@ -39,7 +41,8 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
39
41
|
*/
|
|
40
42
|
getMessage: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41
43
|
/**
|
|
42
|
-
*
|
|
44
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
45
|
+
* @summary List the email message attachments
|
|
43
46
|
* @param {string} code
|
|
44
47
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
45
48
|
* @param {*} [options] Override http request option.
|
|
@@ -47,16 +50,16 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
47
50
|
*/
|
|
48
51
|
listAttachments: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
52
|
/**
|
|
50
|
-
*
|
|
53
|
+
* 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
54
|
* @summary List email messages
|
|
52
55
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
53
56
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
54
57
|
* @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>
|
|
58
|
+
* @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, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
56
59
|
* @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>
|
|
60
|
+
* @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
61
|
* @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>
|
|
62
|
+
* @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, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
60
63
|
* @param {*} [options] Override http request option.
|
|
61
64
|
* @throws {RequiredError}
|
|
62
65
|
*/
|
|
@@ -68,7 +71,8 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
68
71
|
*/
|
|
69
72
|
export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
70
73
|
/**
|
|
71
|
-
*
|
|
74
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
75
|
+
* @summary Download the email message attachment
|
|
72
76
|
* @param {string} code
|
|
73
77
|
* @param {number} attachmentId
|
|
74
78
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -77,7 +81,8 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
77
81
|
*/
|
|
78
82
|
downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DownloadAttachmentResponseClass>>;
|
|
79
83
|
/**
|
|
80
|
-
*
|
|
84
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
85
|
+
* @summary Retrieve the email message
|
|
81
86
|
* @param {string} code
|
|
82
87
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
83
88
|
* @param {*} [options] Override http request option.
|
|
@@ -85,7 +90,8 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
85
90
|
*/
|
|
86
91
|
getMessage(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailMessageResponseClass>>;
|
|
87
92
|
/**
|
|
88
|
-
*
|
|
93
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
94
|
+
* @summary List the email message attachments
|
|
89
95
|
* @param {string} code
|
|
90
96
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
91
97
|
* @param {*} [options] Override http request option.
|
|
@@ -93,16 +99,16 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
93
99
|
*/
|
|
94
100
|
listAttachments(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailAttachmentsResponseClass>>;
|
|
95
101
|
/**
|
|
96
|
-
*
|
|
102
|
+
* 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
103
|
* @summary List email messages
|
|
98
104
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
99
105
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
100
106
|
* @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>
|
|
107
|
+
* @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, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
102
108
|
* @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>
|
|
109
|
+
* @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
110
|
* @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>
|
|
111
|
+
* @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, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
106
112
|
* @param {*} [options] Override http request option.
|
|
107
113
|
* @throws {RequiredError}
|
|
108
114
|
*/
|
|
@@ -114,7 +120,8 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
114
120
|
*/
|
|
115
121
|
export declare const EmailMessagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
116
122
|
/**
|
|
117
|
-
*
|
|
123
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
124
|
+
* @summary Download the email message attachment
|
|
118
125
|
* @param {string} code
|
|
119
126
|
* @param {number} attachmentId
|
|
120
127
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -123,7 +130,8 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
123
130
|
*/
|
|
124
131
|
downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: any): AxiosPromise<DownloadAttachmentResponseClass>;
|
|
125
132
|
/**
|
|
126
|
-
*
|
|
133
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
134
|
+
* @summary Retrieve the email message
|
|
127
135
|
* @param {string} code
|
|
128
136
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
129
137
|
* @param {*} [options] Override http request option.
|
|
@@ -131,7 +139,8 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
131
139
|
*/
|
|
132
140
|
getMessage(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailMessageResponseClass>;
|
|
133
141
|
/**
|
|
134
|
-
*
|
|
142
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
143
|
+
* @summary List the email message attachments
|
|
135
144
|
* @param {string} code
|
|
136
145
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
137
146
|
* @param {*} [options] Override http request option.
|
|
@@ -139,16 +148,16 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
139
148
|
*/
|
|
140
149
|
listAttachments(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailAttachmentsResponseClass>;
|
|
141
150
|
/**
|
|
142
|
-
*
|
|
151
|
+
* 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
152
|
* @summary List email messages
|
|
144
153
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
145
154
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
146
155
|
* @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>
|
|
156
|
+
* @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, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
148
157
|
* @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>
|
|
158
|
+
* @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
159
|
* @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>
|
|
160
|
+
* @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, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
152
161
|
* @param {*} [options] Override http request option.
|
|
153
162
|
* @throws {RequiredError}
|
|
154
163
|
*/
|
|
@@ -242,7 +251,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
242
251
|
*/
|
|
243
252
|
readonly pageToken?: string;
|
|
244
253
|
/**
|
|
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>
|
|
254
|
+
* 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, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
246
255
|
* @type {string}
|
|
247
256
|
* @memberof EmailMessagesApiListEmailMessages
|
|
248
257
|
*/
|
|
@@ -254,7 +263,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
254
263
|
*/
|
|
255
264
|
readonly search?: string;
|
|
256
265
|
/**
|
|
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>
|
|
266
|
+
* 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
267
|
* @type {string}
|
|
259
268
|
* @memberof EmailMessagesApiListEmailMessages
|
|
260
269
|
*/
|
|
@@ -266,7 +275,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
266
275
|
*/
|
|
267
276
|
readonly expand?: string;
|
|
268
277
|
/**
|
|
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>
|
|
278
|
+
* 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, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
270
279
|
* @type {string}
|
|
271
280
|
* @memberof EmailMessagesApiListEmailMessages
|
|
272
281
|
*/
|
|
@@ -280,7 +289,8 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
280
289
|
*/
|
|
281
290
|
export declare class EmailMessagesApi extends BaseAPI {
|
|
282
291
|
/**
|
|
283
|
-
*
|
|
292
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
293
|
+
* @summary Download the email message attachment
|
|
284
294
|
* @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
|
|
285
295
|
* @param {*} [options] Override http request option.
|
|
286
296
|
* @throws {RequiredError}
|
|
@@ -288,7 +298,8 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
288
298
|
*/
|
|
289
299
|
downloadAttachment(requestParameters: EmailMessagesApiDownloadAttachmentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DownloadAttachmentResponseClass, any, {}>>;
|
|
290
300
|
/**
|
|
291
|
-
*
|
|
301
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
302
|
+
* @summary Retrieve the email message
|
|
292
303
|
* @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
|
|
293
304
|
* @param {*} [options] Override http request option.
|
|
294
305
|
* @throws {RequiredError}
|
|
@@ -296,7 +307,8 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
296
307
|
*/
|
|
297
308
|
getMessage(requestParameters: EmailMessagesApiGetMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailMessageResponseClass, any, {}>>;
|
|
298
309
|
/**
|
|
299
|
-
*
|
|
310
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
311
|
+
* @summary List the email message attachments
|
|
300
312
|
* @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
|
|
301
313
|
* @param {*} [options] Override http request option.
|
|
302
314
|
* @throws {RequiredError}
|
|
@@ -304,7 +316,7 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
304
316
|
*/
|
|
305
317
|
listAttachments(requestParameters: EmailMessagesApiListAttachmentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailAttachmentsResponseClass, any, {}>>;
|
|
306
318
|
/**
|
|
307
|
-
*
|
|
319
|
+
* 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
320
|
* @summary List email messages
|
|
309
321
|
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
310
322
|
* @param {*} [options] Override http request option.
|