@emilgroup/notification-sdk 0.8.1-beta.7 → 0.8.1-beta.70
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,305 @@
|
|
|
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.MSGraphWebhooksApi = exports.MSGraphWebhooksApiFactory = exports.MSGraphWebhooksApiFp = exports.MSGraphWebhooksApiAxiosParamCreator = 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
|
+
* MSGraphWebhooksApi - axios parameter creator
|
|
90
|
+
* @export
|
|
91
|
+
*/
|
|
92
|
+
var MSGraphWebhooksApiAxiosParamCreator = function (configuration) {
|
|
93
|
+
var _this = this;
|
|
94
|
+
return {
|
|
95
|
+
/**
|
|
96
|
+
* Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the lifecycle events and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
|
|
97
|
+
* @summary Receive Microsoft Graph subscription lifecycle notifications
|
|
98
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
99
|
+
* @param {string} [validationToken] Echoed back as text/plain when present.
|
|
100
|
+
* @param {object} [body] Graph lifecycle collection `{ \"value\": [...] }`.
|
|
101
|
+
* @param {*} [options] Override http request option.
|
|
102
|
+
* @throws {RequiredError}
|
|
103
|
+
*/
|
|
104
|
+
receiveLifecycle: function (tenantSlug, validationToken, body, options) {
|
|
105
|
+
if (options === void 0) { options = {}; }
|
|
106
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
107
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
108
|
+
return __generator(this, function (_a) {
|
|
109
|
+
// verify required parameter 'tenantSlug' is not null or undefined
|
|
110
|
+
(0, common_1.assertParamExists)('receiveLifecycle', 'tenantSlug', tenantSlug);
|
|
111
|
+
localVarPath = "/notificationservice/v1/webhooks/msgraph/{tenantSlug}/lifecycle"
|
|
112
|
+
.replace("{".concat("tenantSlug", "}"), encodeURIComponent(String(tenantSlug)));
|
|
113
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
114
|
+
if (configuration) {
|
|
115
|
+
baseOptions = configuration.baseOptions;
|
|
116
|
+
baseAccessToken = configuration.accessToken;
|
|
117
|
+
}
|
|
118
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
119
|
+
localVarHeaderParameter = {};
|
|
120
|
+
localVarQueryParameter = {};
|
|
121
|
+
if (validationToken !== undefined) {
|
|
122
|
+
localVarQueryParameter['validationToken'] = validationToken;
|
|
123
|
+
}
|
|
124
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
125
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
126
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
127
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
128
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
129
|
+
return [2 /*return*/, {
|
|
130
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
131
|
+
options: localVarRequestOptions,
|
|
132
|
+
}];
|
|
133
|
+
});
|
|
134
|
+
});
|
|
135
|
+
},
|
|
136
|
+
/**
|
|
137
|
+
* Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the notifications and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
|
|
138
|
+
* @summary Receive Microsoft Graph change notifications
|
|
139
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
140
|
+
* @param {string} [validationToken] Echoed back as text/plain when present.
|
|
141
|
+
* @param {object} [body] Graph change-notification collection: `{ \"value\": [ ... ] }`.
|
|
142
|
+
* @param {*} [options] Override http request option.
|
|
143
|
+
* @throws {RequiredError}
|
|
144
|
+
*/
|
|
145
|
+
receiveNotifications: function (tenantSlug, validationToken, body, options) {
|
|
146
|
+
if (options === void 0) { options = {}; }
|
|
147
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
148
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
149
|
+
return __generator(this, function (_a) {
|
|
150
|
+
// verify required parameter 'tenantSlug' is not null or undefined
|
|
151
|
+
(0, common_1.assertParamExists)('receiveNotifications', 'tenantSlug', tenantSlug);
|
|
152
|
+
localVarPath = "/notificationservice/v1/webhooks/msgraph/{tenantSlug}/notifications"
|
|
153
|
+
.replace("{".concat("tenantSlug", "}"), encodeURIComponent(String(tenantSlug)));
|
|
154
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
155
|
+
if (configuration) {
|
|
156
|
+
baseOptions = configuration.baseOptions;
|
|
157
|
+
baseAccessToken = configuration.accessToken;
|
|
158
|
+
}
|
|
159
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
160
|
+
localVarHeaderParameter = {};
|
|
161
|
+
localVarQueryParameter = {};
|
|
162
|
+
if (validationToken !== undefined) {
|
|
163
|
+
localVarQueryParameter['validationToken'] = validationToken;
|
|
164
|
+
}
|
|
165
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
166
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
167
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
168
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
169
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
170
|
+
return [2 /*return*/, {
|
|
171
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
172
|
+
options: localVarRequestOptions,
|
|
173
|
+
}];
|
|
174
|
+
});
|
|
175
|
+
});
|
|
176
|
+
},
|
|
177
|
+
};
|
|
178
|
+
};
|
|
179
|
+
exports.MSGraphWebhooksApiAxiosParamCreator = MSGraphWebhooksApiAxiosParamCreator;
|
|
180
|
+
/**
|
|
181
|
+
* MSGraphWebhooksApi - functional programming interface
|
|
182
|
+
* @export
|
|
183
|
+
*/
|
|
184
|
+
var MSGraphWebhooksApiFp = function (configuration) {
|
|
185
|
+
var localVarAxiosParamCreator = (0, exports.MSGraphWebhooksApiAxiosParamCreator)(configuration);
|
|
186
|
+
return {
|
|
187
|
+
/**
|
|
188
|
+
* Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the lifecycle events and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
|
|
189
|
+
* @summary Receive Microsoft Graph subscription lifecycle notifications
|
|
190
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
191
|
+
* @param {string} [validationToken] Echoed back as text/plain when present.
|
|
192
|
+
* @param {object} [body] Graph lifecycle collection `{ \"value\": [...] }`.
|
|
193
|
+
* @param {*} [options] Override http request option.
|
|
194
|
+
* @throws {RequiredError}
|
|
195
|
+
*/
|
|
196
|
+
receiveLifecycle: function (tenantSlug, validationToken, body, options) {
|
|
197
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
198
|
+
var localVarAxiosArgs;
|
|
199
|
+
return __generator(this, function (_a) {
|
|
200
|
+
switch (_a.label) {
|
|
201
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.receiveLifecycle(tenantSlug, validationToken, body, options)];
|
|
202
|
+
case 1:
|
|
203
|
+
localVarAxiosArgs = _a.sent();
|
|
204
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
205
|
+
}
|
|
206
|
+
});
|
|
207
|
+
});
|
|
208
|
+
},
|
|
209
|
+
/**
|
|
210
|
+
* Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the notifications and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
|
|
211
|
+
* @summary Receive Microsoft Graph change notifications
|
|
212
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
213
|
+
* @param {string} [validationToken] Echoed back as text/plain when present.
|
|
214
|
+
* @param {object} [body] Graph change-notification collection: `{ \"value\": [ ... ] }`.
|
|
215
|
+
* @param {*} [options] Override http request option.
|
|
216
|
+
* @throws {RequiredError}
|
|
217
|
+
*/
|
|
218
|
+
receiveNotifications: function (tenantSlug, validationToken, body, options) {
|
|
219
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
220
|
+
var localVarAxiosArgs;
|
|
221
|
+
return __generator(this, function (_a) {
|
|
222
|
+
switch (_a.label) {
|
|
223
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.receiveNotifications(tenantSlug, validationToken, body, options)];
|
|
224
|
+
case 1:
|
|
225
|
+
localVarAxiosArgs = _a.sent();
|
|
226
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
227
|
+
}
|
|
228
|
+
});
|
|
229
|
+
});
|
|
230
|
+
},
|
|
231
|
+
};
|
|
232
|
+
};
|
|
233
|
+
exports.MSGraphWebhooksApiFp = MSGraphWebhooksApiFp;
|
|
234
|
+
/**
|
|
235
|
+
* MSGraphWebhooksApi - factory interface
|
|
236
|
+
* @export
|
|
237
|
+
*/
|
|
238
|
+
var MSGraphWebhooksApiFactory = function (configuration, basePath, axios) {
|
|
239
|
+
var localVarFp = (0, exports.MSGraphWebhooksApiFp)(configuration);
|
|
240
|
+
return {
|
|
241
|
+
/**
|
|
242
|
+
* Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the lifecycle events and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
|
|
243
|
+
* @summary Receive Microsoft Graph subscription lifecycle notifications
|
|
244
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
245
|
+
* @param {string} [validationToken] Echoed back as text/plain when present.
|
|
246
|
+
* @param {object} [body] Graph lifecycle collection `{ \"value\": [...] }`.
|
|
247
|
+
* @param {*} [options] Override http request option.
|
|
248
|
+
* @throws {RequiredError}
|
|
249
|
+
*/
|
|
250
|
+
receiveLifecycle: function (tenantSlug, validationToken, body, options) {
|
|
251
|
+
return localVarFp.receiveLifecycle(tenantSlug, validationToken, body, options).then(function (request) { return request(axios, basePath); });
|
|
252
|
+
},
|
|
253
|
+
/**
|
|
254
|
+
* Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the notifications and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
|
|
255
|
+
* @summary Receive Microsoft Graph change notifications
|
|
256
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
257
|
+
* @param {string} [validationToken] Echoed back as text/plain when present.
|
|
258
|
+
* @param {object} [body] Graph change-notification collection: `{ \"value\": [ ... ] }`.
|
|
259
|
+
* @param {*} [options] Override http request option.
|
|
260
|
+
* @throws {RequiredError}
|
|
261
|
+
*/
|
|
262
|
+
receiveNotifications: function (tenantSlug, validationToken, body, options) {
|
|
263
|
+
return localVarFp.receiveNotifications(tenantSlug, validationToken, body, options).then(function (request) { return request(axios, basePath); });
|
|
264
|
+
},
|
|
265
|
+
};
|
|
266
|
+
};
|
|
267
|
+
exports.MSGraphWebhooksApiFactory = MSGraphWebhooksApiFactory;
|
|
268
|
+
/**
|
|
269
|
+
* MSGraphWebhooksApi - object-oriented interface
|
|
270
|
+
* @export
|
|
271
|
+
* @class MSGraphWebhooksApi
|
|
272
|
+
* @extends {BaseAPI}
|
|
273
|
+
*/
|
|
274
|
+
var MSGraphWebhooksApi = /** @class */ (function (_super) {
|
|
275
|
+
__extends(MSGraphWebhooksApi, _super);
|
|
276
|
+
function MSGraphWebhooksApi() {
|
|
277
|
+
return _super !== null && _super.apply(this, arguments) || this;
|
|
278
|
+
}
|
|
279
|
+
/**
|
|
280
|
+
* Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the lifecycle events and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
|
|
281
|
+
* @summary Receive Microsoft Graph subscription lifecycle notifications
|
|
282
|
+
* @param {MSGraphWebhooksApiReceiveLifecycleRequest} requestParameters Request parameters.
|
|
283
|
+
* @param {*} [options] Override http request option.
|
|
284
|
+
* @throws {RequiredError}
|
|
285
|
+
* @memberof MSGraphWebhooksApi
|
|
286
|
+
*/
|
|
287
|
+
MSGraphWebhooksApi.prototype.receiveLifecycle = function (requestParameters, options) {
|
|
288
|
+
var _this = this;
|
|
289
|
+
return (0, exports.MSGraphWebhooksApiFp)(this.configuration).receiveLifecycle(requestParameters.tenantSlug, requestParameters.validationToken, requestParameters.body, this.withOwner(options)).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
290
|
+
};
|
|
291
|
+
/**
|
|
292
|
+
* Public route called by Microsoft Graph. Echoes `validationToken` as text/plain, otherwise enqueues the notifications and answers 202. See docs/webhooks/msgraph.md. **Required Permissions** none
|
|
293
|
+
* @summary Receive Microsoft Graph change notifications
|
|
294
|
+
* @param {MSGraphWebhooksApiReceiveNotificationsRequest} requestParameters Request parameters.
|
|
295
|
+
* @param {*} [options] Override http request option.
|
|
296
|
+
* @throws {RequiredError}
|
|
297
|
+
* @memberof MSGraphWebhooksApi
|
|
298
|
+
*/
|
|
299
|
+
MSGraphWebhooksApi.prototype.receiveNotifications = function (requestParameters, options) {
|
|
300
|
+
var _this = this;
|
|
301
|
+
return (0, exports.MSGraphWebhooksApiFp)(this.configuration).receiveNotifications(requestParameters.tenantSlug, requestParameters.validationToken, requestParameters.body, this.withOwner(options)).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
302
|
+
};
|
|
303
|
+
return MSGraphWebhooksApi;
|
|
304
|
+
}(base_1.BaseAPI));
|
|
305
|
+
exports.MSGraphWebhooksApi = MSGraphWebhooksApi;
|
|
@@ -24,7 +24,8 @@ import { UpdateNotificationTemplateResponseClass } from '../models';
|
|
|
24
24
|
*/
|
|
25
25
|
export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
|
|
28
|
+
* @summary Create the notification template
|
|
28
29
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
29
30
|
* @param {string} [authorization] Bearer Token
|
|
30
31
|
* @param {*} [options] Override http request option.
|
|
@@ -32,7 +33,8 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
|
|
|
32
33
|
*/
|
|
33
34
|
createNotificationTemplate: (createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
35
|
/**
|
|
35
|
-
*
|
|
36
|
+
* Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
37
|
+
* @summary Delete the notification template
|
|
36
38
|
* @param {number} id
|
|
37
39
|
* @param {string} [authorization] Bearer Token
|
|
38
40
|
* @param {*} [options] Override http request option.
|
|
@@ -40,7 +42,8 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
|
|
|
40
42
|
*/
|
|
41
43
|
deleteNotificationTemplate: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
44
|
/**
|
|
43
|
-
*
|
|
45
|
+
* Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
46
|
+
* @summary Retrieve the notification template
|
|
44
47
|
* @param {number} id
|
|
45
48
|
* @param {number} id2
|
|
46
49
|
* @param {string} [authorization] Bearer Token
|
|
@@ -50,21 +53,23 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
|
|
|
50
53
|
*/
|
|
51
54
|
getNotificationTemplate: (id: number, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
55
|
/**
|
|
53
|
-
*
|
|
56
|
+
* Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
57
|
+
* @summary List notification templates
|
|
54
58
|
* @param {string} [authorization] Bearer Token
|
|
55
59
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
56
60
|
* @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.
|
|
57
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
61
|
+
* @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: name, slug</i>
|
|
58
62
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
59
|
-
* @param {string} [order]
|
|
60
|
-
* @param {string} [expand]
|
|
61
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
63
|
+
* @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, name, createdAt</i>
|
|
64
|
+
* @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: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias<i>
|
|
65
|
+
* @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: name, slug</i>
|
|
62
66
|
* @param {*} [options] Override http request option.
|
|
63
67
|
* @throws {RequiredError}
|
|
64
68
|
*/
|
|
65
69
|
listNotificationTemplates: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
70
|
/**
|
|
67
|
-
*
|
|
71
|
+
* Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
|
|
72
|
+
* @summary Update the notification template
|
|
68
73
|
* @param {number} id
|
|
69
74
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
70
75
|
* @param {string} [authorization] Bearer Token
|
|
@@ -79,7 +84,8 @@ export declare const NotificationTemplatesApiAxiosParamCreator: (configuration?:
|
|
|
79
84
|
*/
|
|
80
85
|
export declare const NotificationTemplatesApiFp: (configuration?: Configuration) => {
|
|
81
86
|
/**
|
|
82
|
-
*
|
|
87
|
+
* Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
|
|
88
|
+
* @summary Create the notification template
|
|
83
89
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
84
90
|
* @param {string} [authorization] Bearer Token
|
|
85
91
|
* @param {*} [options] Override http request option.
|
|
@@ -87,7 +93,8 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
|
|
|
87
93
|
*/
|
|
88
94
|
createNotificationTemplate(createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateNotificationTemplateResponseClass>>;
|
|
89
95
|
/**
|
|
90
|
-
*
|
|
96
|
+
* Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
97
|
+
* @summary Delete the notification template
|
|
91
98
|
* @param {number} id
|
|
92
99
|
* @param {string} [authorization] Bearer Token
|
|
93
100
|
* @param {*} [options] Override http request option.
|
|
@@ -95,7 +102,8 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
|
|
|
95
102
|
*/
|
|
96
103
|
deleteNotificationTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
97
104
|
/**
|
|
98
|
-
*
|
|
105
|
+
* Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
106
|
+
* @summary Retrieve the notification template
|
|
99
107
|
* @param {number} id
|
|
100
108
|
* @param {number} id2
|
|
101
109
|
* @param {string} [authorization] Bearer Token
|
|
@@ -105,21 +113,23 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
|
|
|
105
113
|
*/
|
|
106
114
|
getNotificationTemplate(id: number, id2: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetNotificationTemplateResponseClass>>;
|
|
107
115
|
/**
|
|
108
|
-
*
|
|
116
|
+
* Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
117
|
+
* @summary List notification templates
|
|
109
118
|
* @param {string} [authorization] Bearer Token
|
|
110
119
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
111
120
|
* @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.
|
|
112
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
121
|
+
* @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: name, slug</i>
|
|
113
122
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
114
|
-
* @param {string} [order]
|
|
115
|
-
* @param {string} [expand]
|
|
116
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
123
|
+
* @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, name, createdAt</i>
|
|
124
|
+
* @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: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias<i>
|
|
125
|
+
* @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: name, slug</i>
|
|
117
126
|
* @param {*} [options] Override http request option.
|
|
118
127
|
* @throws {RequiredError}
|
|
119
128
|
*/
|
|
120
129
|
listNotificationTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNotificationTemplatesResponseClass>>;
|
|
121
130
|
/**
|
|
122
|
-
*
|
|
131
|
+
* Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
|
|
132
|
+
* @summary Update the notification template
|
|
123
133
|
* @param {number} id
|
|
124
134
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
125
135
|
* @param {string} [authorization] Bearer Token
|
|
@@ -134,7 +144,8 @@ export declare const NotificationTemplatesApiFp: (configuration?: Configuration)
|
|
|
134
144
|
*/
|
|
135
145
|
export declare const NotificationTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
136
146
|
/**
|
|
137
|
-
*
|
|
147
|
+
* Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
|
|
148
|
+
* @summary Create the notification template
|
|
138
149
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
139
150
|
* @param {string} [authorization] Bearer Token
|
|
140
151
|
* @param {*} [options] Override http request option.
|
|
@@ -142,7 +153,8 @@ export declare const NotificationTemplatesApiFactory: (configuration?: Configura
|
|
|
142
153
|
*/
|
|
143
154
|
createNotificationTemplate(createNotificationTemplateRequestDto: CreateNotificationTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<CreateNotificationTemplateResponseClass>;
|
|
144
155
|
/**
|
|
145
|
-
*
|
|
156
|
+
* Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
157
|
+
* @summary Delete the notification template
|
|
146
158
|
* @param {number} id
|
|
147
159
|
* @param {string} [authorization] Bearer Token
|
|
148
160
|
* @param {*} [options] Override http request option.
|
|
@@ -150,7 +162,8 @@ export declare const NotificationTemplatesApiFactory: (configuration?: Configura
|
|
|
150
162
|
*/
|
|
151
163
|
deleteNotificationTemplate(id: number, authorization?: string, options?: any): AxiosPromise<object>;
|
|
152
164
|
/**
|
|
153
|
-
*
|
|
165
|
+
* Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
166
|
+
* @summary Retrieve the notification template
|
|
154
167
|
* @param {number} id
|
|
155
168
|
* @param {number} id2
|
|
156
169
|
* @param {string} [authorization] Bearer Token
|
|
@@ -160,21 +173,23 @@ export declare const NotificationTemplatesApiFactory: (configuration?: Configura
|
|
|
160
173
|
*/
|
|
161
174
|
getNotificationTemplate(id: number, id2: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetNotificationTemplateResponseClass>;
|
|
162
175
|
/**
|
|
163
|
-
*
|
|
176
|
+
* Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
177
|
+
* @summary List notification templates
|
|
164
178
|
* @param {string} [authorization] Bearer Token
|
|
165
179
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
166
180
|
* @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.
|
|
167
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
181
|
+
* @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: name, slug</i>
|
|
168
182
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
169
|
-
* @param {string} [order]
|
|
170
|
-
* @param {string} [expand]
|
|
171
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
183
|
+
* @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, name, createdAt</i>
|
|
184
|
+
* @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: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias<i>
|
|
185
|
+
* @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: name, slug</i>
|
|
172
186
|
* @param {*} [options] Override http request option.
|
|
173
187
|
* @throws {RequiredError}
|
|
174
188
|
*/
|
|
175
189
|
listNotificationTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListNotificationTemplatesResponseClass>;
|
|
176
190
|
/**
|
|
177
|
-
*
|
|
191
|
+
* Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
|
|
192
|
+
* @summary Update the notification template
|
|
178
193
|
* @param {number} id
|
|
179
194
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
180
195
|
* @param {string} [authorization] Bearer Token
|
|
@@ -277,7 +292,7 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
|
|
|
277
292
|
*/
|
|
278
293
|
readonly pageToken?: string;
|
|
279
294
|
/**
|
|
280
|
-
* Filter the response by one or multiple fields.
|
|
295
|
+
* 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: name, slug</i>
|
|
281
296
|
* @type {string}
|
|
282
297
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
283
298
|
*/
|
|
@@ -289,19 +304,19 @@ export interface NotificationTemplatesApiListNotificationTemplatesRequest {
|
|
|
289
304
|
*/
|
|
290
305
|
readonly search?: string;
|
|
291
306
|
/**
|
|
292
|
-
*
|
|
307
|
+
* 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, name, createdAt</i>
|
|
293
308
|
* @type {string}
|
|
294
309
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
295
310
|
*/
|
|
296
311
|
readonly order?: string;
|
|
297
312
|
/**
|
|
298
|
-
*
|
|
313
|
+
* 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: bodyTemplateAlias, headerTemplateAlias, footerTemplateAlias<i>
|
|
299
314
|
* @type {string}
|
|
300
315
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
301
316
|
*/
|
|
302
317
|
readonly expand?: string;
|
|
303
318
|
/**
|
|
304
|
-
* Filters the response by one or multiple fields.
|
|
319
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: name, slug</i>
|
|
305
320
|
* @type {string}
|
|
306
321
|
* @memberof NotificationTemplatesApiListNotificationTemplates
|
|
307
322
|
*/
|
|
@@ -340,43 +355,48 @@ export interface NotificationTemplatesApiUpdateNotificationTemplateRequest {
|
|
|
340
355
|
*/
|
|
341
356
|
export declare class NotificationTemplatesApi extends BaseAPI {
|
|
342
357
|
/**
|
|
343
|
-
*
|
|
358
|
+
* Creates a notification template that defines the subject and body of an email. Templates are referenced by their `slug` when sending notifications. **Required Permissions** \"notification-management.email-templates.create\"
|
|
359
|
+
* @summary Create the notification template
|
|
344
360
|
* @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
|
|
345
361
|
* @param {*} [options] Override http request option.
|
|
346
362
|
* @throws {RequiredError}
|
|
347
363
|
* @memberof NotificationTemplatesApi
|
|
348
364
|
*/
|
|
349
|
-
createNotificationTemplate(requestParameters: NotificationTemplatesApiCreateNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateNotificationTemplateResponseClass, any, {}>>;
|
|
365
|
+
createNotificationTemplate(requestParameters: NotificationTemplatesApiCreateNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateNotificationTemplateResponseClass, any, {}, any>>;
|
|
350
366
|
/**
|
|
351
|
-
*
|
|
367
|
+
* Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
368
|
+
* @summary Delete the notification template
|
|
352
369
|
* @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
|
|
353
370
|
* @param {*} [options] Override http request option.
|
|
354
371
|
* @throws {RequiredError}
|
|
355
372
|
* @memberof NotificationTemplatesApi
|
|
356
373
|
*/
|
|
357
|
-
deleteNotificationTemplate(requestParameters: NotificationTemplatesApiDeleteNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
374
|
+
deleteNotificationTemplate(requestParameters: NotificationTemplatesApiDeleteNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}, any>>;
|
|
358
375
|
/**
|
|
359
|
-
*
|
|
376
|
+
* Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
377
|
+
* @summary Retrieve the notification template
|
|
360
378
|
* @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
|
|
361
379
|
* @param {*} [options] Override http request option.
|
|
362
380
|
* @throws {RequiredError}
|
|
363
381
|
* @memberof NotificationTemplatesApi
|
|
364
382
|
*/
|
|
365
|
-
getNotificationTemplate(requestParameters: NotificationTemplatesApiGetNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetNotificationTemplateResponseClass, any, {}>>;
|
|
383
|
+
getNotificationTemplate(requestParameters: NotificationTemplatesApiGetNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetNotificationTemplateResponseClass, any, {}, any>>;
|
|
366
384
|
/**
|
|
367
|
-
*
|
|
385
|
+
* Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
386
|
+
* @summary List notification templates
|
|
368
387
|
* @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
|
|
369
388
|
* @param {*} [options] Override http request option.
|
|
370
389
|
* @throws {RequiredError}
|
|
371
390
|
* @memberof NotificationTemplatesApi
|
|
372
391
|
*/
|
|
373
|
-
listNotificationTemplates(requestParameters?: NotificationTemplatesApiListNotificationTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListNotificationTemplatesResponseClass, any, {}>>;
|
|
392
|
+
listNotificationTemplates(requestParameters?: NotificationTemplatesApiListNotificationTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListNotificationTemplatesResponseClass, any, {}, any>>;
|
|
374
393
|
/**
|
|
375
|
-
*
|
|
394
|
+
* Updates the specified notification template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
|
|
395
|
+
* @summary Update the notification template
|
|
376
396
|
* @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
|
|
377
397
|
* @param {*} [options] Override http request option.
|
|
378
398
|
* @throws {RequiredError}
|
|
379
399
|
* @memberof NotificationTemplatesApi
|
|
380
400
|
*/
|
|
381
|
-
updateNotificationTemplate(requestParameters: NotificationTemplatesApiUpdateNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateNotificationTemplateResponseClass, any, {}>>;
|
|
401
|
+
updateNotificationTemplate(requestParameters: NotificationTemplatesApiUpdateNotificationTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateNotificationTemplateResponseClass, any, {}, any>>;
|
|
382
402
|
}
|