@emilgroup/notification-sdk 0.8.1-beta.59 → 0.8.1-beta.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +0 -23
- package/README.md +2 -2
- package/api/email-messages-api.ts +36 -56
- package/api/email-tracking-api.ts +48 -291
- package/api/email-verifications-api.ts +12 -24
- package/api/layouts-api.ts +46 -76
- package/api/notification-templates-api.ts +46 -76
- package/api/notifications-api.ts +6 -121
- package/api.ts +0 -6
- package/base.ts +41 -174
- package/configuration.ts +0 -20
- package/dist/api/email-messages-api.d.ts +28 -40
- package/dist/api/email-messages-api.js +40 -62
- package/dist/api/email-tracking-api.d.ts +40 -170
- package/dist/api/email-tracking-api.js +48 -261
- package/dist/api/email-verifications-api.d.ts +8 -16
- package/dist/api/email-verifications-api.js +16 -30
- package/dist/api/layouts-api.d.ts +36 -56
- package/dist/api/layouts-api.js +50 -81
- package/dist/api/notification-templates-api.d.ts +36 -56
- package/dist/api/notification-templates-api.js +50 -81
- package/dist/api/notifications-api.d.ts +4 -65
- package/dist/api/notifications-api.js +8 -111
- package/dist/api.d.ts +0 -3
- package/dist/api.js +0 -3
- package/dist/base.d.ts +0 -24
- package/dist/base.js +59 -178
- package/dist/configuration.d.ts +0 -17
- package/dist/configuration.js +0 -2
- package/dist/models/email-message-class.d.ts +7 -73
- package/dist/models/email-message-class.js +3 -22
- package/dist/models/email-thread-class.d.ts +5 -37
- package/dist/models/index.d.ts +0 -20
- package/dist/models/index.js +0 -20
- package/dist/models/send-notification-request-dto.d.ts +1 -10
- package/dist/models/send-notification-request-dto.js +1 -2
- package/models/email-message-class.ts +8 -78
- package/models/email-thread-class.ts +5 -37
- package/models/index.ts +0 -20
- package/models/send-notification-request-dto.ts +2 -9
- package/package.json +1 -1
- package/api/email-mailboxes-api.ts +0 -150
- package/api/email-subscriptions-api.ts +0 -781
- package/api/msgraph-webhooks-api.ts +0 -278
- package/dist/api/email-mailboxes-api.d.ts +0 -87
- package/dist/api/email-mailboxes-api.js +0 -221
- package/dist/api/email-subscriptions-api.d.ts +0 -432
- package/dist/api/email-subscriptions-api.js +0 -738
- package/dist/api/msgraph-webhooks-api.d.ts +0 -168
- package/dist/api/msgraph-webhooks-api.js +0 -305
- package/dist/models/assign-email-thread-entity-body-dto.d.ts +0 -43
- package/dist/models/assign-email-thread-entity-body-dto.js +0 -22
- package/dist/models/assign-email-thread-entity-response-class.d.ts +0 -25
- package/dist/models/assign-email-thread-entity-response-class.js +0 -15
- package/dist/models/catch-up-email-subscription-response-class.d.ts +0 -24
- package/dist/models/catch-up-email-subscription-response-class.js +0 -15
- package/dist/models/catch-up-email-subscriptions-request-dto.d.ts +0 -24
- package/dist/models/catch-up-email-subscriptions-request-dto.js +0 -15
- package/dist/models/catch-up-email-subscriptions-response-class.d.ts +0 -30
- package/dist/models/catch-up-email-subscriptions-response-class.js +0 -15
- package/dist/models/email-mailbox-class.d.ts +0 -47
- package/dist/models/email-mailbox-class.js +0 -20
- package/dist/models/email-message-summary-class.d.ts +0 -98
- package/dist/models/email-message-summary-class.js +0 -33
- package/dist/models/email-subscription-class.d.ts +0 -110
- package/dist/models/email-subscription-class.js +0 -23
- package/dist/models/entity-ref-class.d.ts +0 -37
- package/dist/models/entity-ref-class.js +0 -22
- package/dist/models/get-email-subscription-response-class.d.ts +0 -25
- package/dist/models/get-email-subscription-response-class.js +0 -15
- package/dist/models/grpc-send-email-request-dto.d.ts +0 -137
- package/dist/models/grpc-send-email-request-dto.js +0 -22
- package/dist/models/inline-attachment-dto.d.ts +0 -36
- package/dist/models/inline-attachment-dto.js +0 -15
- package/dist/models/list-email-mailboxes-response-class.d.ts +0 -43
- package/dist/models/list-email-mailboxes-response-class.js +0 -15
- package/dist/models/list-email-subscriptions-response-class.d.ts +0 -43
- package/dist/models/list-email-subscriptions-response-class.js +0 -15
- package/dist/models/reconcile-email-subscriptions-request-dto.d.ts +0 -24
- package/dist/models/reconcile-email-subscriptions-request-dto.js +0 -15
- package/dist/models/reconcile-email-subscriptions-response-class.d.ts +0 -48
- package/dist/models/reconcile-email-subscriptions-response-class.js +0 -15
- package/dist/models/renew-email-subscription-response-class.d.ts +0 -25
- package/dist/models/renew-email-subscription-response-class.js +0 -15
- package/dist/models/send-email-request-dto.d.ts +0 -131
- package/dist/models/send-email-request-dto.js +0 -22
- package/dist/models/send-email-response-class.d.ts +0 -24
- package/dist/models/send-email-response-class.js +0 -15
- package/dist/models/unassign-email-thread-entity-response-class.d.ts +0 -25
- package/dist/models/unassign-email-thread-entity-response-class.js +0 -15
- package/models/assign-email-thread-entity-body-dto.ts +0 -52
- package/models/assign-email-thread-entity-response-class.ts +0 -31
- package/models/catch-up-email-subscription-response-class.ts +0 -30
- package/models/catch-up-email-subscriptions-request-dto.ts +0 -30
- package/models/catch-up-email-subscriptions-response-class.ts +0 -36
- package/models/email-mailbox-class.ts +0 -56
- package/models/email-message-summary-class.ts +0 -109
- package/models/email-subscription-class.ts +0 -119
- package/models/entity-ref-class.ts +0 -46
- package/models/get-email-subscription-response-class.ts +0 -31
- package/models/grpc-send-email-request-dto.ts +0 -144
- package/models/inline-attachment-dto.ts +0 -42
- package/models/list-email-mailboxes-response-class.ts +0 -49
- package/models/list-email-subscriptions-response-class.ts +0 -49
- package/models/reconcile-email-subscriptions-request-dto.ts +0 -30
- package/models/reconcile-email-subscriptions-response-class.ts +0 -54
- package/models/renew-email-subscription-response-class.ts +0 -31
- package/models/send-email-request-dto.ts +0 -138
- package/models/send-email-response-class.ts +0 -30
- package/models/unassign-email-thread-entity-response-class.ts +0 -31
|
@@ -93,8 +93,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
*
|
|
97
|
-
* @summary Create the notification template
|
|
96
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
98
97
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
99
98
|
* @param {string} [authorization] Bearer Token
|
|
100
99
|
* @param {*} [options] Override http request option.
|
|
@@ -103,7 +102,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
103
102
|
createNotificationTemplate: function (createNotificationTemplateRequestDto, authorization, options) {
|
|
104
103
|
if (options === void 0) { options = {}; }
|
|
105
104
|
return __awaiter(_this, void 0, void 0, function () {
|
|
106
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter,
|
|
105
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
107
106
|
return __generator(this, function (_a) {
|
|
108
107
|
switch (_a.label) {
|
|
109
108
|
case 0:
|
|
@@ -120,16 +119,13 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
120
119
|
localVarQueryParameter = {};
|
|
121
120
|
// authentication bearer required
|
|
122
121
|
// http bearer authentication required
|
|
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
|
-
];
|
|
122
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
126
123
|
case 1:
|
|
127
124
|
// authentication bearer required
|
|
128
125
|
// http bearer authentication required
|
|
129
126
|
_a.sent();
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
127
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
128
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
133
129
|
}
|
|
134
130
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
135
131
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -145,8 +141,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
145
141
|
});
|
|
146
142
|
},
|
|
147
143
|
/**
|
|
148
|
-
*
|
|
149
|
-
* @summary Delete the notification template
|
|
144
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
150
145
|
* @param {number} id
|
|
151
146
|
* @param {string} [authorization] Bearer Token
|
|
152
147
|
* @param {*} [options] Override http request option.
|
|
@@ -155,7 +150,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
155
150
|
deleteNotificationTemplate: function (id, authorization, options) {
|
|
156
151
|
if (options === void 0) { options = {}; }
|
|
157
152
|
return __awaiter(_this, void 0, void 0, function () {
|
|
158
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter,
|
|
153
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
159
154
|
return __generator(this, function (_a) {
|
|
160
155
|
switch (_a.label) {
|
|
161
156
|
case 0:
|
|
@@ -173,16 +168,13 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
173
168
|
localVarQueryParameter = {};
|
|
174
169
|
// authentication bearer required
|
|
175
170
|
// http bearer authentication required
|
|
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
|
-
];
|
|
171
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
179
172
|
case 1:
|
|
180
173
|
// authentication bearer required
|
|
181
174
|
// http bearer authentication required
|
|
182
175
|
_a.sent();
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
176
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
177
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
186
178
|
}
|
|
187
179
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
188
180
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -196,8 +188,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
196
188
|
});
|
|
197
189
|
},
|
|
198
190
|
/**
|
|
199
|
-
*
|
|
200
|
-
* @summary Retrieve the notification template
|
|
191
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
201
192
|
* @param {number} id
|
|
202
193
|
* @param {number} id2
|
|
203
194
|
* @param {string} [authorization] Bearer Token
|
|
@@ -208,7 +199,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
208
199
|
getNotificationTemplate: function (id, id2, authorization, expand, options) {
|
|
209
200
|
if (options === void 0) { options = {}; }
|
|
210
201
|
return __awaiter(_this, void 0, void 0, function () {
|
|
211
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter,
|
|
202
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
212
203
|
return __generator(this, function (_a) {
|
|
213
204
|
switch (_a.label) {
|
|
214
205
|
case 0:
|
|
@@ -239,9 +230,8 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
239
230
|
if (expand !== undefined) {
|
|
240
231
|
localVarQueryParameter['expand'] = expand;
|
|
241
232
|
}
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
233
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
234
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
245
235
|
}
|
|
246
236
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
247
237
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -255,23 +245,22 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
255
245
|
});
|
|
256
246
|
},
|
|
257
247
|
/**
|
|
258
|
-
*
|
|
259
|
-
* @summary List notification templates
|
|
248
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
260
249
|
* @param {string} [authorization] Bearer Token
|
|
261
250
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
262
251
|
* @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.
|
|
263
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
252
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
264
253
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
265
|
-
* @param {string} [order]
|
|
266
|
-
* @param {string} [expand]
|
|
267
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
254
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
255
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
256
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
268
257
|
* @param {*} [options] Override http request option.
|
|
269
258
|
* @throws {RequiredError}
|
|
270
259
|
*/
|
|
271
260
|
listNotificationTemplates: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
272
261
|
if (options === void 0) { options = {}; }
|
|
273
262
|
return __awaiter(_this, void 0, void 0, function () {
|
|
274
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter,
|
|
263
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
275
264
|
return __generator(this, function (_a) {
|
|
276
265
|
switch (_a.label) {
|
|
277
266
|
case 0:
|
|
@@ -312,9 +301,8 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
312
301
|
if (filters !== undefined) {
|
|
313
302
|
localVarQueryParameter['filters'] = filters;
|
|
314
303
|
}
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
304
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
305
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
318
306
|
}
|
|
319
307
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
320
308
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -328,8 +316,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
328
316
|
});
|
|
329
317
|
},
|
|
330
318
|
/**
|
|
331
|
-
*
|
|
332
|
-
* @summary Update the notification template
|
|
319
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
333
320
|
* @param {number} id
|
|
334
321
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
335
322
|
* @param {string} [authorization] Bearer Token
|
|
@@ -339,7 +326,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
339
326
|
updateNotificationTemplate: function (id, updateNotificationTemplateRequestDto, authorization, options) {
|
|
340
327
|
if (options === void 0) { options = {}; }
|
|
341
328
|
return __awaiter(_this, void 0, void 0, function () {
|
|
342
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter,
|
|
329
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
343
330
|
return __generator(this, function (_a) {
|
|
344
331
|
switch (_a.label) {
|
|
345
332
|
case 0:
|
|
@@ -359,16 +346,13 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
359
346
|
localVarQueryParameter = {};
|
|
360
347
|
// authentication bearer required
|
|
361
348
|
// http bearer authentication required
|
|
362
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
363
|
-
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
364
|
-
];
|
|
349
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
365
350
|
case 1:
|
|
366
351
|
// authentication bearer required
|
|
367
352
|
// http bearer authentication required
|
|
368
353
|
_a.sent();
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
354
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
355
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
372
356
|
}
|
|
373
357
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
374
358
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -394,8 +378,7 @@ var NotificationTemplatesApiFp = function (configuration) {
|
|
|
394
378
|
var localVarAxiosParamCreator = (0, exports.NotificationTemplatesApiAxiosParamCreator)(configuration);
|
|
395
379
|
return {
|
|
396
380
|
/**
|
|
397
|
-
*
|
|
398
|
-
* @summary Create the notification template
|
|
381
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
399
382
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
400
383
|
* @param {string} [authorization] Bearer Token
|
|
401
384
|
* @param {*} [options] Override http request option.
|
|
@@ -415,8 +398,7 @@ var NotificationTemplatesApiFp = function (configuration) {
|
|
|
415
398
|
});
|
|
416
399
|
},
|
|
417
400
|
/**
|
|
418
|
-
*
|
|
419
|
-
* @summary Delete the notification template
|
|
401
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
420
402
|
* @param {number} id
|
|
421
403
|
* @param {string} [authorization] Bearer Token
|
|
422
404
|
* @param {*} [options] Override http request option.
|
|
@@ -436,8 +418,7 @@ var NotificationTemplatesApiFp = function (configuration) {
|
|
|
436
418
|
});
|
|
437
419
|
},
|
|
438
420
|
/**
|
|
439
|
-
*
|
|
440
|
-
* @summary Retrieve the notification template
|
|
421
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
441
422
|
* @param {number} id
|
|
442
423
|
* @param {number} id2
|
|
443
424
|
* @param {string} [authorization] Bearer Token
|
|
@@ -459,16 +440,15 @@ var NotificationTemplatesApiFp = function (configuration) {
|
|
|
459
440
|
});
|
|
460
441
|
},
|
|
461
442
|
/**
|
|
462
|
-
*
|
|
463
|
-
* @summary List notification templates
|
|
443
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
464
444
|
* @param {string} [authorization] Bearer Token
|
|
465
445
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
466
446
|
* @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.
|
|
467
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
447
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
468
448
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
469
|
-
* @param {string} [order]
|
|
470
|
-
* @param {string} [expand]
|
|
471
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
449
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
450
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
451
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
472
452
|
* @param {*} [options] Override http request option.
|
|
473
453
|
* @throws {RequiredError}
|
|
474
454
|
*/
|
|
@@ -486,8 +466,7 @@ var NotificationTemplatesApiFp = function (configuration) {
|
|
|
486
466
|
});
|
|
487
467
|
},
|
|
488
468
|
/**
|
|
489
|
-
*
|
|
490
|
-
* @summary Update the notification template
|
|
469
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
491
470
|
* @param {number} id
|
|
492
471
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
493
472
|
* @param {string} [authorization] Bearer Token
|
|
@@ -518,8 +497,7 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
|
|
|
518
497
|
var localVarFp = (0, exports.NotificationTemplatesApiFp)(configuration);
|
|
519
498
|
return {
|
|
520
499
|
/**
|
|
521
|
-
*
|
|
522
|
-
* @summary Create the notification template
|
|
500
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
523
501
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
524
502
|
* @param {string} [authorization] Bearer Token
|
|
525
503
|
* @param {*} [options] Override http request option.
|
|
@@ -529,8 +507,7 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
|
|
|
529
507
|
return localVarFp.createNotificationTemplate(createNotificationTemplateRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
530
508
|
},
|
|
531
509
|
/**
|
|
532
|
-
*
|
|
533
|
-
* @summary Delete the notification template
|
|
510
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
534
511
|
* @param {number} id
|
|
535
512
|
* @param {string} [authorization] Bearer Token
|
|
536
513
|
* @param {*} [options] Override http request option.
|
|
@@ -540,8 +517,7 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
|
|
|
540
517
|
return localVarFp.deleteNotificationTemplate(id, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
541
518
|
},
|
|
542
519
|
/**
|
|
543
|
-
*
|
|
544
|
-
* @summary Retrieve the notification template
|
|
520
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
545
521
|
* @param {number} id
|
|
546
522
|
* @param {number} id2
|
|
547
523
|
* @param {string} [authorization] Bearer Token
|
|
@@ -553,16 +529,15 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
|
|
|
553
529
|
return localVarFp.getNotificationTemplate(id, id2, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
554
530
|
},
|
|
555
531
|
/**
|
|
556
|
-
*
|
|
557
|
-
* @summary List notification templates
|
|
532
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
558
533
|
* @param {string} [authorization] Bearer Token
|
|
559
534
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
560
535
|
* @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.
|
|
561
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
536
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
562
537
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
563
|
-
* @param {string} [order]
|
|
564
|
-
* @param {string} [expand]
|
|
565
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
538
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
539
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
540
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
566
541
|
* @param {*} [options] Override http request option.
|
|
567
542
|
* @throws {RequiredError}
|
|
568
543
|
*/
|
|
@@ -570,8 +545,7 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
|
|
|
570
545
|
return localVarFp.listNotificationTemplates(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
571
546
|
},
|
|
572
547
|
/**
|
|
573
|
-
*
|
|
574
|
-
* @summary Update the notification template
|
|
548
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
575
549
|
* @param {number} id
|
|
576
550
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
577
551
|
* @param {string} [authorization] Bearer Token
|
|
@@ -596,8 +570,7 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
|
|
|
596
570
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
597
571
|
}
|
|
598
572
|
/**
|
|
599
|
-
*
|
|
600
|
-
* @summary Create the notification template
|
|
573
|
+
* undefined **Required Permissions** \"notification-management.email-templates.create\"
|
|
601
574
|
* @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
|
|
602
575
|
* @param {*} [options] Override http request option.
|
|
603
576
|
* @throws {RequiredError}
|
|
@@ -608,8 +581,7 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
|
|
|
608
581
|
return (0, exports.NotificationTemplatesApiFp)(this.configuration).createNotificationTemplate(requestParameters.createNotificationTemplateRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
609
582
|
};
|
|
610
583
|
/**
|
|
611
|
-
*
|
|
612
|
-
* @summary Delete the notification template
|
|
584
|
+
* undefined **Required Permissions** \"notification-management.email-templates.delete\"
|
|
613
585
|
* @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
|
|
614
586
|
* @param {*} [options] Override http request option.
|
|
615
587
|
* @throws {RequiredError}
|
|
@@ -620,8 +592,7 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
|
|
|
620
592
|
return (0, exports.NotificationTemplatesApiFp)(this.configuration).deleteNotificationTemplate(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
621
593
|
};
|
|
622
594
|
/**
|
|
623
|
-
*
|
|
624
|
-
* @summary Retrieve the notification template
|
|
595
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
625
596
|
* @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
|
|
626
597
|
* @param {*} [options] Override http request option.
|
|
627
598
|
* @throws {RequiredError}
|
|
@@ -632,8 +603,7 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
|
|
|
632
603
|
return (0, exports.NotificationTemplatesApiFp)(this.configuration).getNotificationTemplate(requestParameters.id, requestParameters.id2, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
633
604
|
};
|
|
634
605
|
/**
|
|
635
|
-
*
|
|
636
|
-
* @summary List notification templates
|
|
606
|
+
* undefined **Required Permissions** \"notification-management.email-templates.view\"
|
|
637
607
|
* @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
|
|
638
608
|
* @param {*} [options] Override http request option.
|
|
639
609
|
* @throws {RequiredError}
|
|
@@ -645,8 +615,7 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
|
|
|
645
615
|
return (0, exports.NotificationTemplatesApiFp)(this.configuration).listNotificationTemplates(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); });
|
|
646
616
|
};
|
|
647
617
|
/**
|
|
648
|
-
*
|
|
649
|
-
* @summary Update the notification template
|
|
618
|
+
* undefined **Required Permissions** \"notification-management.email-templates.update\"
|
|
650
619
|
* @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
|
|
651
620
|
* @param {*} [options] Override http request option.
|
|
652
621
|
* @throws {RequiredError}
|
|
@@ -12,8 +12,6 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
-
import { SendEmailRequestDto } from '../models';
|
|
16
|
-
import { SendEmailResponseClass } from '../models';
|
|
17
15
|
import { SendNotificationRequestDto } from '../models';
|
|
18
16
|
import { SendNotificationResponseClass } from '../models';
|
|
19
17
|
/**
|
|
@@ -22,17 +20,7 @@ import { SendNotificationResponseClass } from '../models';
|
|
|
22
20
|
*/
|
|
23
21
|
export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
22
|
/**
|
|
25
|
-
*
|
|
26
|
-
* @summary Send an email without a template
|
|
27
|
-
* @param {SendEmailRequestDto} sendEmailRequestDto
|
|
28
|
-
* @param {string} [authorization] Bearer Token
|
|
29
|
-
* @param {*} [options] Override http request option.
|
|
30
|
-
* @throws {RequiredError}
|
|
31
|
-
*/
|
|
32
|
-
sendEmail: (sendEmailRequestDto: SendEmailRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
|
-
/**
|
|
34
|
-
* Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
|
|
35
|
-
* @summary Send a notification
|
|
23
|
+
* undefined **Required Permissions** none
|
|
36
24
|
* @param {SendNotificationRequestDto} sendNotificationRequestDto
|
|
37
25
|
* @param {string} [authorization] Bearer Token
|
|
38
26
|
* @param {*} [options] Override http request option.
|
|
@@ -46,17 +34,7 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
46
34
|
*/
|
|
47
35
|
export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
48
36
|
/**
|
|
49
|
-
*
|
|
50
|
-
* @summary Send an email without a template
|
|
51
|
-
* @param {SendEmailRequestDto} sendEmailRequestDto
|
|
52
|
-
* @param {string} [authorization] Bearer Token
|
|
53
|
-
* @param {*} [options] Override http request option.
|
|
54
|
-
* @throws {RequiredError}
|
|
55
|
-
*/
|
|
56
|
-
sendEmail(sendEmailRequestDto: SendEmailRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SendEmailResponseClass>>;
|
|
57
|
-
/**
|
|
58
|
-
* Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
|
|
59
|
-
* @summary Send a notification
|
|
37
|
+
* undefined **Required Permissions** none
|
|
60
38
|
* @param {SendNotificationRequestDto} sendNotificationRequestDto
|
|
61
39
|
* @param {string} [authorization] Bearer Token
|
|
62
40
|
* @param {*} [options] Override http request option.
|
|
@@ -70,17 +48,7 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
70
48
|
*/
|
|
71
49
|
export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
72
50
|
/**
|
|
73
|
-
*
|
|
74
|
-
* @summary Send an email without a template
|
|
75
|
-
* @param {SendEmailRequestDto} sendEmailRequestDto
|
|
76
|
-
* @param {string} [authorization] Bearer Token
|
|
77
|
-
* @param {*} [options] Override http request option.
|
|
78
|
-
* @throws {RequiredError}
|
|
79
|
-
*/
|
|
80
|
-
sendEmail(sendEmailRequestDto: SendEmailRequestDto, authorization?: string, options?: any): AxiosPromise<SendEmailResponseClass>;
|
|
81
|
-
/**
|
|
82
|
-
* Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
|
|
83
|
-
* @summary Send a notification
|
|
51
|
+
* undefined **Required Permissions** none
|
|
84
52
|
* @param {SendNotificationRequestDto} sendNotificationRequestDto
|
|
85
53
|
* @param {string} [authorization] Bearer Token
|
|
86
54
|
* @param {*} [options] Override http request option.
|
|
@@ -88,25 +56,6 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
|
|
|
88
56
|
*/
|
|
89
57
|
sendNotification(sendNotificationRequestDto: SendNotificationRequestDto, authorization?: string, options?: any): AxiosPromise<SendNotificationResponseClass>;
|
|
90
58
|
};
|
|
91
|
-
/**
|
|
92
|
-
* Request parameters for sendEmail operation in NotificationsApi.
|
|
93
|
-
* @export
|
|
94
|
-
* @interface NotificationsApiSendEmailRequest
|
|
95
|
-
*/
|
|
96
|
-
export interface NotificationsApiSendEmailRequest {
|
|
97
|
-
/**
|
|
98
|
-
*
|
|
99
|
-
* @type {SendEmailRequestDto}
|
|
100
|
-
* @memberof NotificationsApiSendEmail
|
|
101
|
-
*/
|
|
102
|
-
readonly sendEmailRequestDto: SendEmailRequestDto;
|
|
103
|
-
/**
|
|
104
|
-
* Bearer Token
|
|
105
|
-
* @type {string}
|
|
106
|
-
* @memberof NotificationsApiSendEmail
|
|
107
|
-
*/
|
|
108
|
-
readonly authorization?: string;
|
|
109
|
-
}
|
|
110
59
|
/**
|
|
111
60
|
* Request parameters for sendNotification operation in NotificationsApi.
|
|
112
61
|
* @export
|
|
@@ -134,17 +83,7 @@ export interface NotificationsApiSendNotificationRequest {
|
|
|
134
83
|
*/
|
|
135
84
|
export declare class NotificationsApi extends BaseAPI {
|
|
136
85
|
/**
|
|
137
|
-
*
|
|
138
|
-
* @summary Send an email without a template
|
|
139
|
-
* @param {NotificationsApiSendEmailRequest} requestParameters Request parameters.
|
|
140
|
-
* @param {*} [options] Override http request option.
|
|
141
|
-
* @throws {RequiredError}
|
|
142
|
-
* @memberof NotificationsApi
|
|
143
|
-
*/
|
|
144
|
-
sendEmail(requestParameters: NotificationsApiSendEmailRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SendEmailResponseClass, any, {}>>;
|
|
145
|
-
/**
|
|
146
|
-
* Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
|
|
147
|
-
* @summary Send a notification
|
|
86
|
+
* undefined **Required Permissions** none
|
|
148
87
|
* @param {NotificationsApiSendNotificationRequest} requestParameters Request parameters.
|
|
149
88
|
* @param {*} [options] Override http request option.
|
|
150
89
|
* @throws {RequiredError}
|