@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
|
@@ -93,7 +93,8 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
*
|
|
96
|
+
* 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\"
|
|
97
|
+
* @summary Create the notification template
|
|
97
98
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
98
99
|
* @param {string} [authorization] Bearer Token
|
|
99
100
|
* @param {*} [options] Override http request option.
|
|
@@ -102,9 +103,10 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
102
103
|
createNotificationTemplate: function (createNotificationTemplateRequestDto, 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
|
-
|
|
107
|
-
|
|
106
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationIsAuth, authorizationValue, authorizationKeepEmpty, headersFromBaseOptions;
|
|
107
|
+
var _a;
|
|
108
|
+
return __generator(this, function (_b) {
|
|
109
|
+
switch (_b.label) {
|
|
108
110
|
case 0:
|
|
109
111
|
// verify required parameter 'createNotificationTemplateRequestDto' is not null or undefined
|
|
110
112
|
(0, common_1.assertParamExists)('createNotificationTemplate', 'createNotificationTemplateRequestDto', createNotificationTemplateRequestDto);
|
|
@@ -119,13 +121,19 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
119
121
|
localVarQueryParameter = {};
|
|
120
122
|
// authentication bearer required
|
|
121
123
|
// http bearer authentication required
|
|
122
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
124
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
125
|
+
// Only Authorization falls back to the configured token. Without a session it is sent as before, empty when
|
|
126
|
+
// no token is stored, so a refused call still refreshes; a session call (account header) sends none.
|
|
127
|
+
];
|
|
123
128
|
case 1:
|
|
124
129
|
// authentication bearer required
|
|
125
130
|
// http bearer authentication required
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
131
|
+
_b.sent();
|
|
132
|
+
authorizationIsAuth = 'Authorization'.toLowerCase() === 'authorization';
|
|
133
|
+
authorizationValue = authorizationIsAuth ? (authorization || baseAccessToken) : authorization;
|
|
134
|
+
authorizationKeepEmpty = authorizationIsAuth && authorizationValue === '' && !((_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) === null || _a === void 0 ? void 0 : _a['X-Emil-Account']);
|
|
135
|
+
if (authorizationValue || authorizationKeepEmpty) {
|
|
136
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
129
137
|
}
|
|
130
138
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
131
139
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -141,7 +149,8 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
141
149
|
});
|
|
142
150
|
},
|
|
143
151
|
/**
|
|
144
|
-
*
|
|
152
|
+
* Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
153
|
+
* @summary Delete the notification template
|
|
145
154
|
* @param {number} id
|
|
146
155
|
* @param {string} [authorization] Bearer Token
|
|
147
156
|
* @param {*} [options] Override http request option.
|
|
@@ -150,9 +159,10 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
150
159
|
deleteNotificationTemplate: function (id, authorization, options) {
|
|
151
160
|
if (options === void 0) { options = {}; }
|
|
152
161
|
return __awaiter(_this, void 0, void 0, function () {
|
|
153
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
154
|
-
|
|
155
|
-
|
|
162
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationIsAuth, authorizationValue, authorizationKeepEmpty, headersFromBaseOptions;
|
|
163
|
+
var _a;
|
|
164
|
+
return __generator(this, function (_b) {
|
|
165
|
+
switch (_b.label) {
|
|
156
166
|
case 0:
|
|
157
167
|
// verify required parameter 'id' is not null or undefined
|
|
158
168
|
(0, common_1.assertParamExists)('deleteNotificationTemplate', 'id', id);
|
|
@@ -168,13 +178,19 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
168
178
|
localVarQueryParameter = {};
|
|
169
179
|
// authentication bearer required
|
|
170
180
|
// http bearer authentication required
|
|
171
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
181
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
182
|
+
// Only Authorization falls back to the configured token. Without a session it is sent as before, empty when
|
|
183
|
+
// no token is stored, so a refused call still refreshes; a session call (account header) sends none.
|
|
184
|
+
];
|
|
172
185
|
case 1:
|
|
173
186
|
// authentication bearer required
|
|
174
187
|
// http bearer authentication required
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
188
|
+
_b.sent();
|
|
189
|
+
authorizationIsAuth = 'Authorization'.toLowerCase() === 'authorization';
|
|
190
|
+
authorizationValue = authorizationIsAuth ? (authorization || baseAccessToken) : authorization;
|
|
191
|
+
authorizationKeepEmpty = authorizationIsAuth && authorizationValue === '' && !((_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) === null || _a === void 0 ? void 0 : _a['X-Emil-Account']);
|
|
192
|
+
if (authorizationValue || authorizationKeepEmpty) {
|
|
193
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
178
194
|
}
|
|
179
195
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
180
196
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -188,7 +204,8 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
188
204
|
});
|
|
189
205
|
},
|
|
190
206
|
/**
|
|
191
|
-
*
|
|
207
|
+
* Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
208
|
+
* @summary Retrieve the notification template
|
|
192
209
|
* @param {number} id
|
|
193
210
|
* @param {number} id2
|
|
194
211
|
* @param {string} [authorization] Bearer Token
|
|
@@ -199,9 +216,10 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
199
216
|
getNotificationTemplate: function (id, id2, authorization, expand, options) {
|
|
200
217
|
if (options === void 0) { options = {}; }
|
|
201
218
|
return __awaiter(_this, void 0, void 0, function () {
|
|
202
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
203
|
-
|
|
204
|
-
|
|
219
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationIsAuth, authorizationValue, authorizationKeepEmpty, headersFromBaseOptions;
|
|
220
|
+
var _a;
|
|
221
|
+
return __generator(this, function (_b) {
|
|
222
|
+
switch (_b.label) {
|
|
205
223
|
case 0:
|
|
206
224
|
// verify required parameter 'id' is not null or undefined
|
|
207
225
|
(0, common_1.assertParamExists)('getNotificationTemplate', 'id', id);
|
|
@@ -223,15 +241,18 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
223
241
|
case 1:
|
|
224
242
|
// authentication bearer required
|
|
225
243
|
// http bearer authentication required
|
|
226
|
-
|
|
244
|
+
_b.sent();
|
|
227
245
|
if (id2 !== undefined) {
|
|
228
246
|
localVarQueryParameter['id'] = id2;
|
|
229
247
|
}
|
|
230
248
|
if (expand !== undefined) {
|
|
231
249
|
localVarQueryParameter['expand'] = expand;
|
|
232
250
|
}
|
|
233
|
-
|
|
234
|
-
|
|
251
|
+
authorizationIsAuth = 'Authorization'.toLowerCase() === 'authorization';
|
|
252
|
+
authorizationValue = authorizationIsAuth ? (authorization || baseAccessToken) : authorization;
|
|
253
|
+
authorizationKeepEmpty = authorizationIsAuth && authorizationValue === '' && !((_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) === null || _a === void 0 ? void 0 : _a['X-Emil-Account']);
|
|
254
|
+
if (authorizationValue || authorizationKeepEmpty) {
|
|
255
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
235
256
|
}
|
|
236
257
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
237
258
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -245,24 +266,26 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
245
266
|
});
|
|
246
267
|
},
|
|
247
268
|
/**
|
|
248
|
-
*
|
|
269
|
+
* Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
270
|
+
* @summary List notification templates
|
|
249
271
|
* @param {string} [authorization] Bearer Token
|
|
250
272
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
251
273
|
* @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.
|
|
252
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
274
|
+
* @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>
|
|
253
275
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
254
|
-
* @param {string} [order]
|
|
255
|
-
* @param {string} [expand]
|
|
256
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
276
|
+
* @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>
|
|
277
|
+
* @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>
|
|
278
|
+
* @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>
|
|
257
279
|
* @param {*} [options] Override http request option.
|
|
258
280
|
* @throws {RequiredError}
|
|
259
281
|
*/
|
|
260
282
|
listNotificationTemplates: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
261
283
|
if (options === void 0) { options = {}; }
|
|
262
284
|
return __awaiter(_this, void 0, void 0, function () {
|
|
263
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
264
|
-
|
|
265
|
-
|
|
285
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationIsAuth, authorizationValue, authorizationKeepEmpty, headersFromBaseOptions;
|
|
286
|
+
var _a;
|
|
287
|
+
return __generator(this, function (_b) {
|
|
288
|
+
switch (_b.label) {
|
|
266
289
|
case 0:
|
|
267
290
|
localVarPath = "/notificationservice/v1/notification-templates";
|
|
268
291
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -279,7 +302,7 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
279
302
|
case 1:
|
|
280
303
|
// authentication bearer required
|
|
281
304
|
// http bearer authentication required
|
|
282
|
-
|
|
305
|
+
_b.sent();
|
|
283
306
|
if (pageSize !== undefined) {
|
|
284
307
|
localVarQueryParameter['pageSize'] = pageSize;
|
|
285
308
|
}
|
|
@@ -301,8 +324,11 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
301
324
|
if (filters !== undefined) {
|
|
302
325
|
localVarQueryParameter['filters'] = filters;
|
|
303
326
|
}
|
|
304
|
-
|
|
305
|
-
|
|
327
|
+
authorizationIsAuth = 'Authorization'.toLowerCase() === 'authorization';
|
|
328
|
+
authorizationValue = authorizationIsAuth ? (authorization || baseAccessToken) : authorization;
|
|
329
|
+
authorizationKeepEmpty = authorizationIsAuth && authorizationValue === '' && !((_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) === null || _a === void 0 ? void 0 : _a['X-Emil-Account']);
|
|
330
|
+
if (authorizationValue || authorizationKeepEmpty) {
|
|
331
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
306
332
|
}
|
|
307
333
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
308
334
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -316,7 +342,8 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
316
342
|
});
|
|
317
343
|
},
|
|
318
344
|
/**
|
|
319
|
-
*
|
|
345
|
+
* 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\"
|
|
346
|
+
* @summary Update the notification template
|
|
320
347
|
* @param {number} id
|
|
321
348
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
322
349
|
* @param {string} [authorization] Bearer Token
|
|
@@ -326,9 +353,10 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
326
353
|
updateNotificationTemplate: function (id, updateNotificationTemplateRequestDto, authorization, options) {
|
|
327
354
|
if (options === void 0) { options = {}; }
|
|
328
355
|
return __awaiter(_this, void 0, void 0, function () {
|
|
329
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
330
|
-
|
|
331
|
-
|
|
356
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationIsAuth, authorizationValue, authorizationKeepEmpty, headersFromBaseOptions;
|
|
357
|
+
var _a;
|
|
358
|
+
return __generator(this, function (_b) {
|
|
359
|
+
switch (_b.label) {
|
|
332
360
|
case 0:
|
|
333
361
|
// verify required parameter 'id' is not null or undefined
|
|
334
362
|
(0, common_1.assertParamExists)('updateNotificationTemplate', 'id', id);
|
|
@@ -346,13 +374,19 @@ var NotificationTemplatesApiAxiosParamCreator = function (configuration) {
|
|
|
346
374
|
localVarQueryParameter = {};
|
|
347
375
|
// authentication bearer required
|
|
348
376
|
// http bearer authentication required
|
|
349
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
377
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
|
|
378
|
+
// Only Authorization falls back to the configured token. Without a session it is sent as before, empty when
|
|
379
|
+
// no token is stored, so a refused call still refreshes; a session call (account header) sends none.
|
|
380
|
+
];
|
|
350
381
|
case 1:
|
|
351
382
|
// authentication bearer required
|
|
352
383
|
// http bearer authentication required
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
384
|
+
_b.sent();
|
|
385
|
+
authorizationIsAuth = 'Authorization'.toLowerCase() === 'authorization';
|
|
386
|
+
authorizationValue = authorizationIsAuth ? (authorization || baseAccessToken) : authorization;
|
|
387
|
+
authorizationKeepEmpty = authorizationIsAuth && authorizationValue === '' && !((_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) === null || _a === void 0 ? void 0 : _a['X-Emil-Account']);
|
|
388
|
+
if (authorizationValue || authorizationKeepEmpty) {
|
|
389
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
356
390
|
}
|
|
357
391
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
358
392
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
@@ -378,7 +412,8 @@ var NotificationTemplatesApiFp = function (configuration) {
|
|
|
378
412
|
var localVarAxiosParamCreator = (0, exports.NotificationTemplatesApiAxiosParamCreator)(configuration);
|
|
379
413
|
return {
|
|
380
414
|
/**
|
|
381
|
-
*
|
|
415
|
+
* 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\"
|
|
416
|
+
* @summary Create the notification template
|
|
382
417
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
383
418
|
* @param {string} [authorization] Bearer Token
|
|
384
419
|
* @param {*} [options] Override http request option.
|
|
@@ -398,7 +433,8 @@ var NotificationTemplatesApiFp = function (configuration) {
|
|
|
398
433
|
});
|
|
399
434
|
},
|
|
400
435
|
/**
|
|
401
|
-
*
|
|
436
|
+
* Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
437
|
+
* @summary Delete the notification template
|
|
402
438
|
* @param {number} id
|
|
403
439
|
* @param {string} [authorization] Bearer Token
|
|
404
440
|
* @param {*} [options] Override http request option.
|
|
@@ -418,7 +454,8 @@ var NotificationTemplatesApiFp = function (configuration) {
|
|
|
418
454
|
});
|
|
419
455
|
},
|
|
420
456
|
/**
|
|
421
|
-
*
|
|
457
|
+
* Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
458
|
+
* @summary Retrieve the notification template
|
|
422
459
|
* @param {number} id
|
|
423
460
|
* @param {number} id2
|
|
424
461
|
* @param {string} [authorization] Bearer Token
|
|
@@ -440,15 +477,16 @@ var NotificationTemplatesApiFp = function (configuration) {
|
|
|
440
477
|
});
|
|
441
478
|
},
|
|
442
479
|
/**
|
|
443
|
-
*
|
|
480
|
+
* Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
481
|
+
* @summary List notification templates
|
|
444
482
|
* @param {string} [authorization] Bearer Token
|
|
445
483
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
446
484
|
* @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.
|
|
447
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
485
|
+
* @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>
|
|
448
486
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
449
|
-
* @param {string} [order]
|
|
450
|
-
* @param {string} [expand]
|
|
451
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
487
|
+
* @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>
|
|
488
|
+
* @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>
|
|
489
|
+
* @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>
|
|
452
490
|
* @param {*} [options] Override http request option.
|
|
453
491
|
* @throws {RequiredError}
|
|
454
492
|
*/
|
|
@@ -466,7 +504,8 @@ var NotificationTemplatesApiFp = function (configuration) {
|
|
|
466
504
|
});
|
|
467
505
|
},
|
|
468
506
|
/**
|
|
469
|
-
*
|
|
507
|
+
* 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\"
|
|
508
|
+
* @summary Update the notification template
|
|
470
509
|
* @param {number} id
|
|
471
510
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
472
511
|
* @param {string} [authorization] Bearer Token
|
|
@@ -497,7 +536,8 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
|
|
|
497
536
|
var localVarFp = (0, exports.NotificationTemplatesApiFp)(configuration);
|
|
498
537
|
return {
|
|
499
538
|
/**
|
|
500
|
-
*
|
|
539
|
+
* 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\"
|
|
540
|
+
* @summary Create the notification template
|
|
501
541
|
* @param {CreateNotificationTemplateRequestDto} createNotificationTemplateRequestDto
|
|
502
542
|
* @param {string} [authorization] Bearer Token
|
|
503
543
|
* @param {*} [options] Override http request option.
|
|
@@ -507,7 +547,8 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
|
|
|
507
547
|
return localVarFp.createNotificationTemplate(createNotificationTemplateRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
508
548
|
},
|
|
509
549
|
/**
|
|
510
|
-
*
|
|
550
|
+
* Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
551
|
+
* @summary Delete the notification template
|
|
511
552
|
* @param {number} id
|
|
512
553
|
* @param {string} [authorization] Bearer Token
|
|
513
554
|
* @param {*} [options] Override http request option.
|
|
@@ -517,7 +558,8 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
|
|
|
517
558
|
return localVarFp.deleteNotificationTemplate(id, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
518
559
|
},
|
|
519
560
|
/**
|
|
520
|
-
*
|
|
561
|
+
* Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
562
|
+
* @summary Retrieve the notification template
|
|
521
563
|
* @param {number} id
|
|
522
564
|
* @param {number} id2
|
|
523
565
|
* @param {string} [authorization] Bearer Token
|
|
@@ -529,15 +571,16 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
|
|
|
529
571
|
return localVarFp.getNotificationTemplate(id, id2, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
530
572
|
},
|
|
531
573
|
/**
|
|
532
|
-
*
|
|
574
|
+
* Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
575
|
+
* @summary List notification templates
|
|
533
576
|
* @param {string} [authorization] Bearer Token
|
|
534
577
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
535
578
|
* @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.
|
|
536
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
579
|
+
* @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>
|
|
537
580
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
538
|
-
* @param {string} [order]
|
|
539
|
-
* @param {string} [expand]
|
|
540
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
581
|
+
* @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>
|
|
582
|
+
* @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>
|
|
583
|
+
* @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>
|
|
541
584
|
* @param {*} [options] Override http request option.
|
|
542
585
|
* @throws {RequiredError}
|
|
543
586
|
*/
|
|
@@ -545,7 +588,8 @@ var NotificationTemplatesApiFactory = function (configuration, basePath, axios)
|
|
|
545
588
|
return localVarFp.listNotificationTemplates(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
546
589
|
},
|
|
547
590
|
/**
|
|
548
|
-
*
|
|
591
|
+
* 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\"
|
|
592
|
+
* @summary Update the notification template
|
|
549
593
|
* @param {number} id
|
|
550
594
|
* @param {UpdateNotificationTemplateRequestDto} updateNotificationTemplateRequestDto
|
|
551
595
|
* @param {string} [authorization] Bearer Token
|
|
@@ -570,7 +614,8 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
|
|
|
570
614
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
571
615
|
}
|
|
572
616
|
/**
|
|
573
|
-
*
|
|
617
|
+
* 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\"
|
|
618
|
+
* @summary Create the notification template
|
|
574
619
|
* @param {NotificationTemplatesApiCreateNotificationTemplateRequest} requestParameters Request parameters.
|
|
575
620
|
* @param {*} [options] Override http request option.
|
|
576
621
|
* @throws {RequiredError}
|
|
@@ -578,10 +623,11 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
|
|
|
578
623
|
*/
|
|
579
624
|
NotificationTemplatesApi.prototype.createNotificationTemplate = function (requestParameters, options) {
|
|
580
625
|
var _this = this;
|
|
581
|
-
return (0, exports.NotificationTemplatesApiFp)(this.configuration).createNotificationTemplate(requestParameters.createNotificationTemplateRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
626
|
+
return (0, exports.NotificationTemplatesApiFp)(this.configuration).createNotificationTemplate(requestParameters.createNotificationTemplateRequestDto, requestParameters.authorization, this.withOwner(options)).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
582
627
|
};
|
|
583
628
|
/**
|
|
584
|
-
*
|
|
629
|
+
* Permanently deletes the notification template with the given id. **Required Permissions** \"notification-management.email-templates.delete\"
|
|
630
|
+
* @summary Delete the notification template
|
|
585
631
|
* @param {NotificationTemplatesApiDeleteNotificationTemplateRequest} requestParameters Request parameters.
|
|
586
632
|
* @param {*} [options] Override http request option.
|
|
587
633
|
* @throws {RequiredError}
|
|
@@ -589,10 +635,11 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
|
|
|
589
635
|
*/
|
|
590
636
|
NotificationTemplatesApi.prototype.deleteNotificationTemplate = function (requestParameters, options) {
|
|
591
637
|
var _this = this;
|
|
592
|
-
return (0, exports.NotificationTemplatesApiFp)(this.configuration).deleteNotificationTemplate(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
638
|
+
return (0, exports.NotificationTemplatesApiFp)(this.configuration).deleteNotificationTemplate(requestParameters.id, requestParameters.authorization, this.withOwner(options)).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
593
639
|
};
|
|
594
640
|
/**
|
|
595
|
-
*
|
|
641
|
+
* Retrieves the details of the notification template with the given id. **Required Permissions** \"notification-management.email-templates.view\"
|
|
642
|
+
* @summary Retrieve the notification template
|
|
596
643
|
* @param {NotificationTemplatesApiGetNotificationTemplateRequest} requestParameters Request parameters.
|
|
597
644
|
* @param {*} [options] Override http request option.
|
|
598
645
|
* @throws {RequiredError}
|
|
@@ -600,10 +647,11 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
|
|
|
600
647
|
*/
|
|
601
648
|
NotificationTemplatesApi.prototype.getNotificationTemplate = function (requestParameters, options) {
|
|
602
649
|
var _this = this;
|
|
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); });
|
|
650
|
+
return (0, exports.NotificationTemplatesApiFp)(this.configuration).getNotificationTemplate(requestParameters.id, requestParameters.id2, requestParameters.authorization, requestParameters.expand, this.withOwner(options)).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
604
651
|
};
|
|
605
652
|
/**
|
|
606
|
-
*
|
|
653
|
+
* Returns a list of notification templates. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-templates.view\"
|
|
654
|
+
* @summary List notification templates
|
|
607
655
|
* @param {NotificationTemplatesApiListNotificationTemplatesRequest} requestParameters Request parameters.
|
|
608
656
|
* @param {*} [options] Override http request option.
|
|
609
657
|
* @throws {RequiredError}
|
|
@@ -612,10 +660,11 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
|
|
|
612
660
|
NotificationTemplatesApi.prototype.listNotificationTemplates = function (requestParameters, options) {
|
|
613
661
|
var _this = this;
|
|
614
662
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
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); });
|
|
663
|
+
return (0, exports.NotificationTemplatesApiFp)(this.configuration).listNotificationTemplates(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, this.withOwner(options)).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
616
664
|
};
|
|
617
665
|
/**
|
|
618
|
-
*
|
|
666
|
+
* 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\"
|
|
667
|
+
* @summary Update the notification template
|
|
619
668
|
* @param {NotificationTemplatesApiUpdateNotificationTemplateRequest} requestParameters Request parameters.
|
|
620
669
|
* @param {*} [options] Override http request option.
|
|
621
670
|
* @throws {RequiredError}
|
|
@@ -623,7 +672,7 @@ var NotificationTemplatesApi = /** @class */ (function (_super) {
|
|
|
623
672
|
*/
|
|
624
673
|
NotificationTemplatesApi.prototype.updateNotificationTemplate = function (requestParameters, options) {
|
|
625
674
|
var _this = this;
|
|
626
|
-
return (0, exports.NotificationTemplatesApiFp)(this.configuration).updateNotificationTemplate(requestParameters.id, requestParameters.updateNotificationTemplateRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
675
|
+
return (0, exports.NotificationTemplatesApiFp)(this.configuration).updateNotificationTemplate(requestParameters.id, requestParameters.updateNotificationTemplateRequestDto, requestParameters.authorization, this.withOwner(options)).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
627
676
|
};
|
|
628
677
|
return NotificationTemplatesApi;
|
|
629
678
|
}(base_1.BaseAPI));
|
|
@@ -12,6 +12,8 @@
|
|
|
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';
|
|
15
17
|
import { SendNotificationRequestDto } from '../models';
|
|
16
18
|
import { SendNotificationResponseClass } from '../models';
|
|
17
19
|
/**
|
|
@@ -20,7 +22,17 @@ import { SendNotificationResponseClass } from '../models';
|
|
|
20
22
|
*/
|
|
21
23
|
export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
24
|
/**
|
|
23
|
-
*
|
|
25
|
+
* Sends an email with a caller-supplied HTML and/or text body, delivered as given. Attachments can reference documents already in S3 or be sent inline as base64. **Required Permissions** none
|
|
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
|
|
24
36
|
* @param {SendNotificationRequestDto} sendNotificationRequestDto
|
|
25
37
|
* @param {string} [authorization] Bearer Token
|
|
26
38
|
* @param {*} [options] Override http request option.
|
|
@@ -34,7 +46,17 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
34
46
|
*/
|
|
35
47
|
export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
36
48
|
/**
|
|
37
|
-
*
|
|
49
|
+
* Sends an email with a caller-supplied HTML and/or text body, delivered as given. Attachments can reference documents already in S3 or be sent inline as base64. **Required Permissions** none
|
|
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
|
|
38
60
|
* @param {SendNotificationRequestDto} sendNotificationRequestDto
|
|
39
61
|
* @param {string} [authorization] Bearer Token
|
|
40
62
|
* @param {*} [options] Override http request option.
|
|
@@ -48,7 +70,17 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
48
70
|
*/
|
|
49
71
|
export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
50
72
|
/**
|
|
51
|
-
*
|
|
73
|
+
* Sends an email with a caller-supplied HTML and/or text body, delivered as given. Attachments can reference documents already in S3 or be sent inline as base64. **Required Permissions** none
|
|
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
|
|
52
84
|
* @param {SendNotificationRequestDto} sendNotificationRequestDto
|
|
53
85
|
* @param {string} [authorization] Bearer Token
|
|
54
86
|
* @param {*} [options] Override http request option.
|
|
@@ -56,6 +88,25 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
|
|
|
56
88
|
*/
|
|
57
89
|
sendNotification(sendNotificationRequestDto: SendNotificationRequestDto, authorization?: string, options?: any): AxiosPromise<SendNotificationResponseClass>;
|
|
58
90
|
};
|
|
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
|
+
}
|
|
59
110
|
/**
|
|
60
111
|
* Request parameters for sendNotification operation in NotificationsApi.
|
|
61
112
|
* @export
|
|
@@ -83,11 +134,21 @@ export interface NotificationsApiSendNotificationRequest {
|
|
|
83
134
|
*/
|
|
84
135
|
export declare class NotificationsApi extends BaseAPI {
|
|
85
136
|
/**
|
|
86
|
-
*
|
|
137
|
+
* Sends an email with a caller-supplied HTML and/or text body, delivered as given. Attachments can reference documents already in S3 or be sent inline as base64. **Required Permissions** none
|
|
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, {}, 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
|
|
87
148
|
* @param {NotificationsApiSendNotificationRequest} requestParameters Request parameters.
|
|
88
149
|
* @param {*} [options] Override http request option.
|
|
89
150
|
* @throws {RequiredError}
|
|
90
151
|
* @memberof NotificationsApi
|
|
91
152
|
*/
|
|
92
|
-
sendNotification(requestParameters: NotificationsApiSendNotificationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SendNotificationResponseClass, any, {}>>;
|
|
153
|
+
sendNotification(requestParameters: NotificationsApiSendNotificationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SendNotificationResponseClass, any, {}, any>>;
|
|
93
154
|
}
|