@emilgroup/notification-sdk 0.8.1-beta.48 → 0.8.1-beta.5
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 -20
- package/README.md +2 -2
- package/api/email-messages-api.ts +28 -40
- package/api/email-tracking-api.ts +40 -271
- package/api/email-verifications-api.ts +8 -16
- package/api/layouts-api.ts +36 -56
- package/api/notification-templates-api.ts +36 -56
- package/api/notifications-api.ts +4 -115
- package/api.ts +0 -6
- package/base.ts +15 -36
- package/configuration.ts +0 -11
- package/dist/api/email-messages-api.d.ts +28 -40
- package/dist/api/email-messages-api.js +25 -37
- package/dist/api/email-tracking-api.d.ts +40 -170
- package/dist/api/email-tracking-api.js +34 -233
- package/dist/api/email-verifications-api.d.ts +8 -16
- package/dist/api/email-verifications-api.js +8 -16
- package/dist/api/layouts-api.d.ts +36 -56
- package/dist/api/layouts-api.js +32 -52
- package/dist/api/notification-templates-api.d.ts +36 -56
- package/dist/api/notification-templates-api.js +32 -52
- package/dist/api/notifications-api.d.ts +4 -65
- package/dist/api/notifications-api.js +4 -101
- package/dist/api.d.ts +0 -3
- package/dist/api.js +0 -3
- package/dist/base.d.ts +0 -1
- package/dist/base.js +16 -36
- package/dist/configuration.d.ts +0 -9
- package/dist/configuration.js +0 -1
- 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 -17
- package/dist/models/index.js +0 -17
- 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 -17
- package/models/send-notification-request-dto.ts +2 -9
- package/package.json +1 -1
- package/api/email-mailboxes-api.ts +0 -148
- package/api/email-subscriptions-api.ts +0 -559
- 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 -218
- package/dist/api/email-subscriptions-api.d.ts +0 -319
- package/dist/api/email-subscriptions-api.js +0 -537
- 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/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 -104
- 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/email-mailbox-class.ts +0 -56
- package/models/email-message-summary-class.ts +0 -109
- package/models/email-subscription-class.ts +0 -113
- 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
package/.openapi-generator/FILES
CHANGED
|
@@ -3,14 +3,11 @@
|
|
|
3
3
|
.openapi-generator-ignore
|
|
4
4
|
README.md
|
|
5
5
|
api.ts
|
|
6
|
-
api/email-mailboxes-api.ts
|
|
7
6
|
api/email-messages-api.ts
|
|
8
|
-
api/email-subscriptions-api.ts
|
|
9
7
|
api/email-tracking-api.ts
|
|
10
8
|
api/email-verifications-api.ts
|
|
11
9
|
api/health-api.ts
|
|
12
10
|
api/layouts-api.ts
|
|
13
|
-
api/msgraph-webhooks-api.ts
|
|
14
11
|
api/notification-templates-api.ts
|
|
15
12
|
api/notifications-api.ts
|
|
16
13
|
base.ts
|
|
@@ -18,8 +15,6 @@ common.ts
|
|
|
18
15
|
configuration.ts
|
|
19
16
|
git_push.sh
|
|
20
17
|
index.ts
|
|
21
|
-
models/assign-email-thread-entity-body-dto.ts
|
|
22
|
-
models/assign-email-thread-entity-response-class.ts
|
|
23
18
|
models/complete-email-verification-dto.ts
|
|
24
19
|
models/complete-email-verification-response-class.ts
|
|
25
20
|
models/create-layout-request-dto.ts
|
|
@@ -30,45 +25,30 @@ models/delete-layout-request-dto.ts
|
|
|
30
25
|
models/delete-notification-template-request-dto.ts
|
|
31
26
|
models/download-attachment-response-class.ts
|
|
32
27
|
models/email-attachment-class.ts
|
|
33
|
-
models/email-mailbox-class.ts
|
|
34
28
|
models/email-message-class.ts
|
|
35
|
-
models/email-message-summary-class.ts
|
|
36
|
-
models/email-subscription-class.ts
|
|
37
29
|
models/email-thread-class.ts
|
|
38
|
-
models/entity-ref-class.ts
|
|
39
30
|
models/get-email-message-response-class.ts
|
|
40
|
-
models/get-email-subscription-response-class.ts
|
|
41
31
|
models/get-email-thread-response-class.ts
|
|
42
32
|
models/get-layout-request-dto.ts
|
|
43
33
|
models/get-layout-response-class.ts
|
|
44
34
|
models/get-notification-template-request-dto.ts
|
|
45
35
|
models/get-notification-template-response-class.ts
|
|
46
|
-
models/grpc-send-email-request-dto.ts
|
|
47
36
|
models/html-template-class.ts
|
|
48
37
|
models/index.ts
|
|
49
38
|
models/initiate-email-verification-dto.ts
|
|
50
39
|
models/initiate-email-verification-response-class.ts
|
|
51
|
-
models/inline-attachment-dto.ts
|
|
52
40
|
models/inline-response200.ts
|
|
53
41
|
models/inline-response503.ts
|
|
54
42
|
models/layout-class.ts
|
|
55
43
|
models/list-email-attachments-response-class.ts
|
|
56
|
-
models/list-email-mailboxes-response-class.ts
|
|
57
44
|
models/list-email-messages-response-class.ts
|
|
58
|
-
models/list-email-subscriptions-response-class.ts
|
|
59
45
|
models/list-email-threads-response-class.ts
|
|
60
46
|
models/list-layouts-response-class.ts
|
|
61
47
|
models/list-notification-templates-response-class.ts
|
|
62
48
|
models/notification-template-class.ts
|
|
63
|
-
models/reconcile-email-subscriptions-request-dto.ts
|
|
64
|
-
models/reconcile-email-subscriptions-response-class.ts
|
|
65
|
-
models/renew-email-subscription-response-class.ts
|
|
66
49
|
models/s3-document-dto.ts
|
|
67
|
-
models/send-email-request-dto.ts
|
|
68
|
-
models/send-email-response-class.ts
|
|
69
50
|
models/send-notification-request-dto.ts
|
|
70
51
|
models/send-notification-response-class.ts
|
|
71
|
-
models/unassign-email-thread-entity-response-class.ts
|
|
72
52
|
models/update-html-template-request-dto.ts
|
|
73
53
|
models/update-layout-request-dto.ts
|
|
74
54
|
models/update-layout-response-class.ts
|
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/notification-sdk@0.8.1-beta.
|
|
20
|
+
npm install @emilgroup/notification-sdk@0.8.1-beta.5 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/notification-sdk@0.8.1-beta.
|
|
24
|
+
yarn add @emilgroup/notification-sdk@0.8.1-beta.5
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import ``.
|
|
@@ -35,8 +35,7 @@ import { ListEmailMessagesResponseClass } from '../models';
|
|
|
35
35
|
export const EmailMessagesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
39
|
-
* @summary Download the email message attachment
|
|
38
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
40
39
|
* @param {string} code
|
|
41
40
|
* @param {number} attachmentId
|
|
42
41
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -84,8 +83,7 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
84
83
|
};
|
|
85
84
|
},
|
|
86
85
|
/**
|
|
87
|
-
*
|
|
88
|
-
* @summary Retrieve the email message
|
|
86
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
89
87
|
* @param {string} code
|
|
90
88
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
91
89
|
* @param {*} [options] Override http request option.
|
|
@@ -129,8 +127,7 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
129
127
|
};
|
|
130
128
|
},
|
|
131
129
|
/**
|
|
132
|
-
*
|
|
133
|
-
* @summary List the email message attachments
|
|
130
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
134
131
|
* @param {string} code
|
|
135
132
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
136
133
|
* @param {*} [options] Override http request option.
|
|
@@ -174,16 +171,16 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
174
171
|
};
|
|
175
172
|
},
|
|
176
173
|
/**
|
|
177
|
-
*
|
|
174
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
178
175
|
* @summary List email messages
|
|
179
176
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
180
177
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
181
178
|
* @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.
|
|
182
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
179
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
183
180
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
184
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus,
|
|
181
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
185
182
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
186
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
183
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
187
184
|
* @param {*} [options] Override http request option.
|
|
188
185
|
* @throws {RequiredError}
|
|
189
186
|
*/
|
|
@@ -260,8 +257,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
260
257
|
const localVarAxiosParamCreator = EmailMessagesApiAxiosParamCreator(configuration)
|
|
261
258
|
return {
|
|
262
259
|
/**
|
|
263
|
-
*
|
|
264
|
-
* @summary Download the email message attachment
|
|
260
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
265
261
|
* @param {string} code
|
|
266
262
|
* @param {number} attachmentId
|
|
267
263
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -273,8 +269,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
273
269
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
274
270
|
},
|
|
275
271
|
/**
|
|
276
|
-
*
|
|
277
|
-
* @summary Retrieve the email message
|
|
272
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
278
273
|
* @param {string} code
|
|
279
274
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
280
275
|
* @param {*} [options] Override http request option.
|
|
@@ -285,8 +280,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
285
280
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
286
281
|
},
|
|
287
282
|
/**
|
|
288
|
-
*
|
|
289
|
-
* @summary List the email message attachments
|
|
283
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
290
284
|
* @param {string} code
|
|
291
285
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
292
286
|
* @param {*} [options] Override http request option.
|
|
@@ -297,16 +291,16 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
297
291
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
298
292
|
},
|
|
299
293
|
/**
|
|
300
|
-
*
|
|
294
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
301
295
|
* @summary List email messages
|
|
302
296
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
303
297
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
304
298
|
* @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.
|
|
305
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
299
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
306
300
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
307
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus,
|
|
301
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
308
302
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
309
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
303
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
310
304
|
* @param {*} [options] Override http request option.
|
|
311
305
|
* @throws {RequiredError}
|
|
312
306
|
*/
|
|
@@ -325,8 +319,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
325
319
|
const localVarFp = EmailMessagesApiFp(configuration)
|
|
326
320
|
return {
|
|
327
321
|
/**
|
|
328
|
-
*
|
|
329
|
-
* @summary Download the email message attachment
|
|
322
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
330
323
|
* @param {string} code
|
|
331
324
|
* @param {number} attachmentId
|
|
332
325
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -337,8 +330,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
337
330
|
return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then((request) => request(axios, basePath));
|
|
338
331
|
},
|
|
339
332
|
/**
|
|
340
|
-
*
|
|
341
|
-
* @summary Retrieve the email message
|
|
333
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
342
334
|
* @param {string} code
|
|
343
335
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
344
336
|
* @param {*} [options] Override http request option.
|
|
@@ -348,8 +340,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
348
340
|
return localVarFp.getMessage(code, authorization, options).then((request) => request(axios, basePath));
|
|
349
341
|
},
|
|
350
342
|
/**
|
|
351
|
-
*
|
|
352
|
-
* @summary List the email message attachments
|
|
343
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
353
344
|
* @param {string} code
|
|
354
345
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
355
346
|
* @param {*} [options] Override http request option.
|
|
@@ -359,16 +350,16 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
359
350
|
return localVarFp.listAttachments(code, authorization, options).then((request) => request(axios, basePath));
|
|
360
351
|
},
|
|
361
352
|
/**
|
|
362
|
-
*
|
|
353
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
363
354
|
* @summary List email messages
|
|
364
355
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
365
356
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
366
357
|
* @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.
|
|
367
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
358
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
368
359
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
369
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus,
|
|
360
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
370
361
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: attachments<i>
|
|
371
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
362
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
372
363
|
* @param {*} [options] Override http request option.
|
|
373
364
|
* @throws {RequiredError}
|
|
374
365
|
*/
|
|
@@ -476,7 +467,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
476
467
|
readonly pageToken?: string
|
|
477
468
|
|
|
478
469
|
/**
|
|
479
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
470
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
480
471
|
* @type {string}
|
|
481
472
|
* @memberof EmailMessagesApiListEmailMessages
|
|
482
473
|
*/
|
|
@@ -490,7 +481,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
490
481
|
readonly search?: string
|
|
491
482
|
|
|
492
483
|
/**
|
|
493
|
-
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus,
|
|
484
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
494
485
|
* @type {string}
|
|
495
486
|
* @memberof EmailMessagesApiListEmailMessages
|
|
496
487
|
*/
|
|
@@ -504,7 +495,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
504
495
|
readonly expand?: string
|
|
505
496
|
|
|
506
497
|
/**
|
|
507
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode,
|
|
498
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
508
499
|
* @type {string}
|
|
509
500
|
* @memberof EmailMessagesApiListEmailMessages
|
|
510
501
|
*/
|
|
@@ -519,8 +510,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
519
510
|
*/
|
|
520
511
|
export class EmailMessagesApi extends BaseAPI {
|
|
521
512
|
/**
|
|
522
|
-
*
|
|
523
|
-
* @summary Download the email message attachment
|
|
513
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
524
514
|
* @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
|
|
525
515
|
* @param {*} [options] Override http request option.
|
|
526
516
|
* @throws {RequiredError}
|
|
@@ -531,8 +521,7 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
531
521
|
}
|
|
532
522
|
|
|
533
523
|
/**
|
|
534
|
-
*
|
|
535
|
-
* @summary Retrieve the email message
|
|
524
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
536
525
|
* @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
|
|
537
526
|
* @param {*} [options] Override http request option.
|
|
538
527
|
* @throws {RequiredError}
|
|
@@ -543,8 +532,7 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
543
532
|
}
|
|
544
533
|
|
|
545
534
|
/**
|
|
546
|
-
*
|
|
547
|
-
* @summary List the email message attachments
|
|
535
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
548
536
|
* @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
|
|
549
537
|
* @param {*} [options] Override http request option.
|
|
550
538
|
* @throws {RequiredError}
|
|
@@ -555,7 +543,7 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
555
543
|
}
|
|
556
544
|
|
|
557
545
|
/**
|
|
558
|
-
*
|
|
546
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
559
547
|
* @summary List email messages
|
|
560
548
|
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
561
549
|
* @param {*} [options] Override http request option.
|