@emilgroup/notification-sdk 0.8.1-beta.6 → 0.8.1-beta.60
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 +23 -0
- package/README.md +2 -2
- package/api/email-mailboxes-api.ts +150 -0
- package/api/email-messages-api.ts +56 -36
- package/api/email-subscriptions-api.ts +781 -0
- package/api/email-tracking-api.ts +291 -48
- package/api/email-verifications-api.ts +24 -12
- package/api/layouts-api.ts +76 -46
- package/api/msgraph-webhooks-api.ts +278 -0
- package/api/notification-templates-api.ts +76 -46
- package/api/notifications-api.ts +121 -6
- package/api.ts +6 -0
- package/base.ts +174 -41
- 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 +221 -0
- package/dist/api/email-messages-api.d.ts +44 -32
- package/dist/api/email-messages-api.js +62 -40
- package/dist/api/email-subscriptions-api.d.ts +432 -0
- package/dist/api/email-subscriptions-api.js +738 -0
- package/dist/api/email-tracking-api.d.ts +174 -44
- package/dist/api/email-tracking-api.js +261 -48
- package/dist/api/email-verifications-api.d.ts +18 -10
- package/dist/api/email-verifications-api.js +30 -16
- package/dist/api/health-api.d.ts +1 -1
- package/dist/api/layouts-api.d.ts +61 -41
- package/dist/api/layouts-api.js +81 -50
- 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 +81 -50
- package/dist/api/notifications-api.d.ts +66 -5
- package/dist/api/notifications-api.js +111 -8
- package/dist/api.d.ts +3 -0
- package/dist/api.js +3 -0
- package/dist/base.d.ts +24 -0
- package/dist/base.js +178 -59
- 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 +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 +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 +20 -0
- package/dist/models/index.js +20 -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/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 +78 -8
- package/models/email-message-summary-class.ts +109 -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 +20 -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 +2 -2
package/dist/api/layouts-api.js
CHANGED
|
@@ -93,7 +93,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
*
|
|
96
|
+
* Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
|
|
97
|
+
* @summary Create the layout
|
|
97
98
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
98
99
|
* @param {string} [authorization] Bearer Token
|
|
99
100
|
* @param {*} [options] Override http request option.
|
|
@@ -102,7 +103,7 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
102
103
|
createLayout: function (createLayoutRequestDto, authorization, options) {
|
|
103
104
|
if (options === void 0) { options = {}; }
|
|
104
105
|
return __awaiter(_this, void 0, void 0, function () {
|
|
105
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
106
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
|
|
106
107
|
return __generator(this, function (_a) {
|
|
107
108
|
switch (_a.label) {
|
|
108
109
|
case 0:
|
|
@@ -119,13 +120,16 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
119
120
|
localVarQueryParameter = {};
|
|
120
121
|
// authentication bearer required
|
|
121
122
|
// http bearer authentication required
|
|
122
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
123
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
124
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
125
|
+
];
|
|
123
126
|
case 1:
|
|
124
127
|
// authentication bearer required
|
|
125
128
|
// http bearer authentication required
|
|
126
129
|
_a.sent();
|
|
127
|
-
|
|
128
|
-
|
|
130
|
+
authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
131
|
+
if (authorizationValue) {
|
|
132
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
129
133
|
}
|
|
130
134
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
131
135
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -141,7 +145,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
141
145
|
});
|
|
142
146
|
},
|
|
143
147
|
/**
|
|
144
|
-
*
|
|
148
|
+
* Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
149
|
+
* @summary Delete the layout
|
|
145
150
|
* @param {number} id
|
|
146
151
|
* @param {string} [authorization] Bearer Token
|
|
147
152
|
* @param {*} [options] Override http request option.
|
|
@@ -150,7 +155,7 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
150
155
|
deleteLayout: function (id, authorization, options) {
|
|
151
156
|
if (options === void 0) { options = {}; }
|
|
152
157
|
return __awaiter(_this, void 0, void 0, function () {
|
|
153
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
158
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
|
|
154
159
|
return __generator(this, function (_a) {
|
|
155
160
|
switch (_a.label) {
|
|
156
161
|
case 0:
|
|
@@ -168,13 +173,16 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
168
173
|
localVarQueryParameter = {};
|
|
169
174
|
// authentication bearer required
|
|
170
175
|
// http bearer authentication required
|
|
171
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
176
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
177
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
178
|
+
];
|
|
172
179
|
case 1:
|
|
173
180
|
// authentication bearer required
|
|
174
181
|
// http bearer authentication required
|
|
175
182
|
_a.sent();
|
|
176
|
-
|
|
177
|
-
|
|
183
|
+
authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
184
|
+
if (authorizationValue) {
|
|
185
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
178
186
|
}
|
|
179
187
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
180
188
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -188,7 +196,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
188
196
|
});
|
|
189
197
|
},
|
|
190
198
|
/**
|
|
191
|
-
*
|
|
199
|
+
* Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
200
|
+
* @summary Retrieve the layout
|
|
192
201
|
* @param {number} id
|
|
193
202
|
* @param {number} id2 Layout id
|
|
194
203
|
* @param {string} [authorization] Bearer Token
|
|
@@ -198,7 +207,7 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
198
207
|
getLayout: function (id, id2, authorization, options) {
|
|
199
208
|
if (options === void 0) { options = {}; }
|
|
200
209
|
return __awaiter(_this, void 0, void 0, function () {
|
|
201
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
210
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
|
|
202
211
|
return __generator(this, function (_a) {
|
|
203
212
|
switch (_a.label) {
|
|
204
213
|
case 0:
|
|
@@ -226,8 +235,9 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
226
235
|
if (id2 !== undefined) {
|
|
227
236
|
localVarQueryParameter['id'] = id2;
|
|
228
237
|
}
|
|
229
|
-
|
|
230
|
-
|
|
238
|
+
authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
239
|
+
if (authorizationValue) {
|
|
240
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
231
241
|
}
|
|
232
242
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
233
243
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -241,22 +251,23 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
241
251
|
});
|
|
242
252
|
},
|
|
243
253
|
/**
|
|
244
|
-
*
|
|
254
|
+
* Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
255
|
+
* @summary List layouts
|
|
245
256
|
* @param {string} [authorization] Bearer Token
|
|
246
257
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
247
258
|
* @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.
|
|
248
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
259
|
+
* @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, name, slug</i>
|
|
249
260
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
250
|
-
* @param {string} [order]
|
|
251
|
-
* @param {string} [expand]
|
|
252
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
261
|
+
* @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, createdAt</i>
|
|
262
|
+
* @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: headerTemplate, footerTemplate<i>
|
|
263
|
+
* @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, name, slug</i>
|
|
253
264
|
* @param {*} [options] Override http request option.
|
|
254
265
|
* @throws {RequiredError}
|
|
255
266
|
*/
|
|
256
267
|
listLayouts: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
257
268
|
if (options === void 0) { options = {}; }
|
|
258
269
|
return __awaiter(_this, void 0, void 0, function () {
|
|
259
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
270
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
|
|
260
271
|
return __generator(this, function (_a) {
|
|
261
272
|
switch (_a.label) {
|
|
262
273
|
case 0:
|
|
@@ -297,8 +308,9 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
297
308
|
if (filters !== undefined) {
|
|
298
309
|
localVarQueryParameter['filters'] = filters;
|
|
299
310
|
}
|
|
300
|
-
|
|
301
|
-
|
|
311
|
+
authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
312
|
+
if (authorizationValue) {
|
|
313
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
302
314
|
}
|
|
303
315
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
304
316
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -312,7 +324,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
312
324
|
});
|
|
313
325
|
},
|
|
314
326
|
/**
|
|
315
|
-
*
|
|
327
|
+
* Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
|
|
328
|
+
* @summary Update the layout
|
|
316
329
|
* @param {number} id
|
|
317
330
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
318
331
|
* @param {string} [authorization] Bearer Token
|
|
@@ -322,7 +335,7 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
322
335
|
updateLayout: function (id, updateLayoutRequestDto, authorization, options) {
|
|
323
336
|
if (options === void 0) { options = {}; }
|
|
324
337
|
return __awaiter(_this, void 0, void 0, function () {
|
|
325
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
338
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
|
|
326
339
|
return __generator(this, function (_a) {
|
|
327
340
|
switch (_a.label) {
|
|
328
341
|
case 0:
|
|
@@ -342,13 +355,16 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
|
|
|
342
355
|
localVarQueryParameter = {};
|
|
343
356
|
// authentication bearer required
|
|
344
357
|
// http bearer authentication required
|
|
345
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
358
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
359
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
360
|
+
];
|
|
346
361
|
case 1:
|
|
347
362
|
// authentication bearer required
|
|
348
363
|
// http bearer authentication required
|
|
349
364
|
_a.sent();
|
|
350
|
-
|
|
351
|
-
|
|
365
|
+
authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
366
|
+
if (authorizationValue) {
|
|
367
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
352
368
|
}
|
|
353
369
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
354
370
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -374,7 +390,8 @@ var LayoutsApiFp = function (configuration) {
|
|
|
374
390
|
var localVarAxiosParamCreator = (0, exports.LayoutsApiAxiosParamCreator)(configuration);
|
|
375
391
|
return {
|
|
376
392
|
/**
|
|
377
|
-
*
|
|
393
|
+
* Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
|
|
394
|
+
* @summary Create the layout
|
|
378
395
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
379
396
|
* @param {string} [authorization] Bearer Token
|
|
380
397
|
* @param {*} [options] Override http request option.
|
|
@@ -394,7 +411,8 @@ var LayoutsApiFp = function (configuration) {
|
|
|
394
411
|
});
|
|
395
412
|
},
|
|
396
413
|
/**
|
|
397
|
-
*
|
|
414
|
+
* Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
415
|
+
* @summary Delete the layout
|
|
398
416
|
* @param {number} id
|
|
399
417
|
* @param {string} [authorization] Bearer Token
|
|
400
418
|
* @param {*} [options] Override http request option.
|
|
@@ -414,7 +432,8 @@ var LayoutsApiFp = function (configuration) {
|
|
|
414
432
|
});
|
|
415
433
|
},
|
|
416
434
|
/**
|
|
417
|
-
*
|
|
435
|
+
* Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
436
|
+
* @summary Retrieve the layout
|
|
418
437
|
* @param {number} id
|
|
419
438
|
* @param {number} id2 Layout id
|
|
420
439
|
* @param {string} [authorization] Bearer Token
|
|
@@ -435,15 +454,16 @@ var LayoutsApiFp = function (configuration) {
|
|
|
435
454
|
});
|
|
436
455
|
},
|
|
437
456
|
/**
|
|
438
|
-
*
|
|
457
|
+
* Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
458
|
+
* @summary List layouts
|
|
439
459
|
* @param {string} [authorization] Bearer Token
|
|
440
460
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
441
461
|
* @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.
|
|
442
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
462
|
+
* @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, name, slug</i>
|
|
443
463
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
444
|
-
* @param {string} [order]
|
|
445
|
-
* @param {string} [expand]
|
|
446
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
464
|
+
* @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, createdAt</i>
|
|
465
|
+
* @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: headerTemplate, footerTemplate<i>
|
|
466
|
+
* @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, name, slug</i>
|
|
447
467
|
* @param {*} [options] Override http request option.
|
|
448
468
|
* @throws {RequiredError}
|
|
449
469
|
*/
|
|
@@ -461,7 +481,8 @@ var LayoutsApiFp = function (configuration) {
|
|
|
461
481
|
});
|
|
462
482
|
},
|
|
463
483
|
/**
|
|
464
|
-
*
|
|
484
|
+
* Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
|
|
485
|
+
* @summary Update the layout
|
|
465
486
|
* @param {number} id
|
|
466
487
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
467
488
|
* @param {string} [authorization] Bearer Token
|
|
@@ -492,7 +513,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
|
|
|
492
513
|
var localVarFp = (0, exports.LayoutsApiFp)(configuration);
|
|
493
514
|
return {
|
|
494
515
|
/**
|
|
495
|
-
*
|
|
516
|
+
* Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
|
|
517
|
+
* @summary Create the layout
|
|
496
518
|
* @param {CreateLayoutRequestDto} createLayoutRequestDto
|
|
497
519
|
* @param {string} [authorization] Bearer Token
|
|
498
520
|
* @param {*} [options] Override http request option.
|
|
@@ -502,7 +524,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
|
|
|
502
524
|
return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
503
525
|
},
|
|
504
526
|
/**
|
|
505
|
-
*
|
|
527
|
+
* Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
528
|
+
* @summary Delete the layout
|
|
506
529
|
* @param {number} id
|
|
507
530
|
* @param {string} [authorization] Bearer Token
|
|
508
531
|
* @param {*} [options] Override http request option.
|
|
@@ -512,7 +535,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
|
|
|
512
535
|
return localVarFp.deleteLayout(id, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
513
536
|
},
|
|
514
537
|
/**
|
|
515
|
-
*
|
|
538
|
+
* Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
539
|
+
* @summary Retrieve the layout
|
|
516
540
|
* @param {number} id
|
|
517
541
|
* @param {number} id2 Layout id
|
|
518
542
|
* @param {string} [authorization] Bearer Token
|
|
@@ -523,15 +547,16 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
|
|
|
523
547
|
return localVarFp.getLayout(id, id2, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
524
548
|
},
|
|
525
549
|
/**
|
|
526
|
-
*
|
|
550
|
+
* Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
551
|
+
* @summary List layouts
|
|
527
552
|
* @param {string} [authorization] Bearer Token
|
|
528
553
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
529
554
|
* @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.
|
|
530
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
555
|
+
* @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, name, slug</i>
|
|
531
556
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
532
|
-
* @param {string} [order]
|
|
533
|
-
* @param {string} [expand]
|
|
534
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
557
|
+
* @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, createdAt</i>
|
|
558
|
+
* @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: headerTemplate, footerTemplate<i>
|
|
559
|
+
* @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, name, slug</i>
|
|
535
560
|
* @param {*} [options] Override http request option.
|
|
536
561
|
* @throws {RequiredError}
|
|
537
562
|
*/
|
|
@@ -539,7 +564,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
|
|
|
539
564
|
return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
540
565
|
},
|
|
541
566
|
/**
|
|
542
|
-
*
|
|
567
|
+
* Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
|
|
568
|
+
* @summary Update the layout
|
|
543
569
|
* @param {number} id
|
|
544
570
|
* @param {UpdateLayoutRequestDto} updateLayoutRequestDto
|
|
545
571
|
* @param {string} [authorization] Bearer Token
|
|
@@ -564,7 +590,8 @@ var LayoutsApi = /** @class */ (function (_super) {
|
|
|
564
590
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
565
591
|
}
|
|
566
592
|
/**
|
|
567
|
-
*
|
|
593
|
+
* Creates a layout that defines the header and footer wrapped around notification template bodies. **Required Permissions** \"notification-management.email-templates.create\"
|
|
594
|
+
* @summary Create the layout
|
|
568
595
|
* @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
|
|
569
596
|
* @param {*} [options] Override http request option.
|
|
570
597
|
* @throws {RequiredError}
|
|
@@ -575,7 +602,8 @@ var LayoutsApi = /** @class */ (function (_super) {
|
|
|
575
602
|
return (0, exports.LayoutsApiFp)(this.configuration).createLayout(requestParameters.createLayoutRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
576
603
|
};
|
|
577
604
|
/**
|
|
578
|
-
*
|
|
605
|
+
* Permanently deletes the layout with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
606
|
+
* @summary Delete the layout
|
|
579
607
|
* @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
|
|
580
608
|
* @param {*} [options] Override http request option.
|
|
581
609
|
* @throws {RequiredError}
|
|
@@ -586,7 +614,8 @@ var LayoutsApi = /** @class */ (function (_super) {
|
|
|
586
614
|
return (0, exports.LayoutsApiFp)(this.configuration).deleteLayout(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
587
615
|
};
|
|
588
616
|
/**
|
|
589
|
-
*
|
|
617
|
+
* Retrieves the details of the layout with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
618
|
+
* @summary Retrieve the layout
|
|
590
619
|
* @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
|
|
591
620
|
* @param {*} [options] Override http request option.
|
|
592
621
|
* @throws {RequiredError}
|
|
@@ -597,7 +626,8 @@ var LayoutsApi = /** @class */ (function (_super) {
|
|
|
597
626
|
return (0, exports.LayoutsApiFp)(this.configuration).getLayout(requestParameters.id, requestParameters.id2, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
598
627
|
};
|
|
599
628
|
/**
|
|
600
|
-
*
|
|
629
|
+
* Returns a list of layouts. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
630
|
+
* @summary List layouts
|
|
601
631
|
* @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
|
|
602
632
|
* @param {*} [options] Override http request option.
|
|
603
633
|
* @throws {RequiredError}
|
|
@@ -609,7 +639,8 @@ var LayoutsApi = /** @class */ (function (_super) {
|
|
|
609
639
|
return (0, exports.LayoutsApiFp)(this.configuration).listLayouts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
610
640
|
};
|
|
611
641
|
/**
|
|
612
|
-
*
|
|
642
|
+
* Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"notification-management.email-templates.update\"
|
|
643
|
+
* @summary Update the layout
|
|
613
644
|
* @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
|
|
614
645
|
* @param {*} [options] Override http request option.
|
|
615
646
|
* @throws {RequiredError}
|
|
@@ -0,0 +1,168 @@
|
|
|
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
|
+
/**
|
|
16
|
+
* MSGraphWebhooksApi - axios parameter creator
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export declare const MSGraphWebhooksApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20
|
+
/**
|
|
21
|
+
* 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
|
|
22
|
+
* @summary Receive Microsoft Graph subscription lifecycle notifications
|
|
23
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
24
|
+
* @param {string} [validationToken] Echoed back as text/plain when present.
|
|
25
|
+
* @param {object} [body] Graph lifecycle collection `{ \"value\": [...] }`.
|
|
26
|
+
* @param {*} [options] Override http request option.
|
|
27
|
+
* @throws {RequiredError}
|
|
28
|
+
*/
|
|
29
|
+
receiveLifecycle: (tenantSlug: string, validationToken?: string, body?: object, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30
|
+
/**
|
|
31
|
+
* 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
|
|
32
|
+
* @summary Receive Microsoft Graph change notifications
|
|
33
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
34
|
+
* @param {string} [validationToken] Echoed back as text/plain when present.
|
|
35
|
+
* @param {object} [body] Graph change-notification collection: `{ \"value\": [ ... ] }`.
|
|
36
|
+
* @param {*} [options] Override http request option.
|
|
37
|
+
* @throws {RequiredError}
|
|
38
|
+
*/
|
|
39
|
+
receiveNotifications: (tenantSlug: string, validationToken?: string, body?: object, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
|
+
};
|
|
41
|
+
/**
|
|
42
|
+
* MSGraphWebhooksApi - functional programming interface
|
|
43
|
+
* @export
|
|
44
|
+
*/
|
|
45
|
+
export declare const MSGraphWebhooksApiFp: (configuration?: Configuration) => {
|
|
46
|
+
/**
|
|
47
|
+
* 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
|
|
48
|
+
* @summary Receive Microsoft Graph subscription lifecycle notifications
|
|
49
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
50
|
+
* @param {string} [validationToken] Echoed back as text/plain when present.
|
|
51
|
+
* @param {object} [body] Graph lifecycle collection `{ \"value\": [...] }`.
|
|
52
|
+
* @param {*} [options] Override http request option.
|
|
53
|
+
* @throws {RequiredError}
|
|
54
|
+
*/
|
|
55
|
+
receiveLifecycle(tenantSlug: string, validationToken?: string, body?: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
56
|
+
/**
|
|
57
|
+
* 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
|
|
58
|
+
* @summary Receive Microsoft Graph change notifications
|
|
59
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
60
|
+
* @param {string} [validationToken] Echoed back as text/plain when present.
|
|
61
|
+
* @param {object} [body] Graph change-notification collection: `{ \"value\": [ ... ] }`.
|
|
62
|
+
* @param {*} [options] Override http request option.
|
|
63
|
+
* @throws {RequiredError}
|
|
64
|
+
*/
|
|
65
|
+
receiveNotifications(tenantSlug: string, validationToken?: string, body?: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
66
|
+
};
|
|
67
|
+
/**
|
|
68
|
+
* MSGraphWebhooksApi - factory interface
|
|
69
|
+
* @export
|
|
70
|
+
*/
|
|
71
|
+
export declare const MSGraphWebhooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
72
|
+
/**
|
|
73
|
+
* 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
|
|
74
|
+
* @summary Receive Microsoft Graph subscription lifecycle notifications
|
|
75
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
76
|
+
* @param {string} [validationToken] Echoed back as text/plain when present.
|
|
77
|
+
* @param {object} [body] Graph lifecycle collection `{ \"value\": [...] }`.
|
|
78
|
+
* @param {*} [options] Override http request option.
|
|
79
|
+
* @throws {RequiredError}
|
|
80
|
+
*/
|
|
81
|
+
receiveLifecycle(tenantSlug: string, validationToken?: string, body?: object, options?: any): AxiosPromise<void>;
|
|
82
|
+
/**
|
|
83
|
+
* 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
|
|
84
|
+
* @summary Receive Microsoft Graph change notifications
|
|
85
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
86
|
+
* @param {string} [validationToken] Echoed back as text/plain when present.
|
|
87
|
+
* @param {object} [body] Graph change-notification collection: `{ \"value\": [ ... ] }`.
|
|
88
|
+
* @param {*} [options] Override http request option.
|
|
89
|
+
* @throws {RequiredError}
|
|
90
|
+
*/
|
|
91
|
+
receiveNotifications(tenantSlug: string, validationToken?: string, body?: object, options?: any): AxiosPromise<void>;
|
|
92
|
+
};
|
|
93
|
+
/**
|
|
94
|
+
* Request parameters for receiveLifecycle operation in MSGraphWebhooksApi.
|
|
95
|
+
* @export
|
|
96
|
+
* @interface MSGraphWebhooksApiReceiveLifecycleRequest
|
|
97
|
+
*/
|
|
98
|
+
export interface MSGraphWebhooksApiReceiveLifecycleRequest {
|
|
99
|
+
/**
|
|
100
|
+
* Unique slug identifier representing a tenant.
|
|
101
|
+
* @type {string}
|
|
102
|
+
* @memberof MSGraphWebhooksApiReceiveLifecycle
|
|
103
|
+
*/
|
|
104
|
+
readonly tenantSlug: string;
|
|
105
|
+
/**
|
|
106
|
+
* Echoed back as text/plain when present.
|
|
107
|
+
* @type {string}
|
|
108
|
+
* @memberof MSGraphWebhooksApiReceiveLifecycle
|
|
109
|
+
*/
|
|
110
|
+
readonly validationToken?: string;
|
|
111
|
+
/**
|
|
112
|
+
* Graph lifecycle collection `{ \"value\": [...] }`.
|
|
113
|
+
* @type {object}
|
|
114
|
+
* @memberof MSGraphWebhooksApiReceiveLifecycle
|
|
115
|
+
*/
|
|
116
|
+
readonly body?: object;
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* Request parameters for receiveNotifications operation in MSGraphWebhooksApi.
|
|
120
|
+
* @export
|
|
121
|
+
* @interface MSGraphWebhooksApiReceiveNotificationsRequest
|
|
122
|
+
*/
|
|
123
|
+
export interface MSGraphWebhooksApiReceiveNotificationsRequest {
|
|
124
|
+
/**
|
|
125
|
+
* Unique slug identifier representing a tenant.
|
|
126
|
+
* @type {string}
|
|
127
|
+
* @memberof MSGraphWebhooksApiReceiveNotifications
|
|
128
|
+
*/
|
|
129
|
+
readonly tenantSlug: string;
|
|
130
|
+
/**
|
|
131
|
+
* Echoed back as text/plain when present.
|
|
132
|
+
* @type {string}
|
|
133
|
+
* @memberof MSGraphWebhooksApiReceiveNotifications
|
|
134
|
+
*/
|
|
135
|
+
readonly validationToken?: string;
|
|
136
|
+
/**
|
|
137
|
+
* Graph change-notification collection: `{ \"value\": [ ... ] }`.
|
|
138
|
+
* @type {object}
|
|
139
|
+
* @memberof MSGraphWebhooksApiReceiveNotifications
|
|
140
|
+
*/
|
|
141
|
+
readonly body?: object;
|
|
142
|
+
}
|
|
143
|
+
/**
|
|
144
|
+
* MSGraphWebhooksApi - object-oriented interface
|
|
145
|
+
* @export
|
|
146
|
+
* @class MSGraphWebhooksApi
|
|
147
|
+
* @extends {BaseAPI}
|
|
148
|
+
*/
|
|
149
|
+
export declare class MSGraphWebhooksApi extends BaseAPI {
|
|
150
|
+
/**
|
|
151
|
+
* 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
|
|
152
|
+
* @summary Receive Microsoft Graph subscription lifecycle notifications
|
|
153
|
+
* @param {MSGraphWebhooksApiReceiveLifecycleRequest} requestParameters Request parameters.
|
|
154
|
+
* @param {*} [options] Override http request option.
|
|
155
|
+
* @throws {RequiredError}
|
|
156
|
+
* @memberof MSGraphWebhooksApi
|
|
157
|
+
*/
|
|
158
|
+
receiveLifecycle(requestParameters: MSGraphWebhooksApiReceiveLifecycleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
|
|
159
|
+
/**
|
|
160
|
+
* 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
|
|
161
|
+
* @summary Receive Microsoft Graph change notifications
|
|
162
|
+
* @param {MSGraphWebhooksApiReceiveNotificationsRequest} requestParameters Request parameters.
|
|
163
|
+
* @param {*} [options] Override http request option.
|
|
164
|
+
* @throws {RequiredError}
|
|
165
|
+
* @memberof MSGraphWebhooksApi
|
|
166
|
+
*/
|
|
167
|
+
receiveNotifications(requestParameters: MSGraphWebhooksApiReceiveNotificationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
|
|
168
|
+
}
|