@emilgroup/notification-sdk 0.8.1-beta.59 → 0.8.1-beta.6
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
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,11 +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
|
-
models/catch-up-email-subscription-response-class.ts
|
|
24
|
-
models/catch-up-email-subscriptions-request-dto.ts
|
|
25
|
-
models/catch-up-email-subscriptions-response-class.ts
|
|
26
18
|
models/complete-email-verification-dto.ts
|
|
27
19
|
models/complete-email-verification-response-class.ts
|
|
28
20
|
models/create-layout-request-dto.ts
|
|
@@ -33,45 +25,30 @@ models/delete-layout-request-dto.ts
|
|
|
33
25
|
models/delete-notification-template-request-dto.ts
|
|
34
26
|
models/download-attachment-response-class.ts
|
|
35
27
|
models/email-attachment-class.ts
|
|
36
|
-
models/email-mailbox-class.ts
|
|
37
28
|
models/email-message-class.ts
|
|
38
|
-
models/email-message-summary-class.ts
|
|
39
|
-
models/email-subscription-class.ts
|
|
40
29
|
models/email-thread-class.ts
|
|
41
|
-
models/entity-ref-class.ts
|
|
42
30
|
models/get-email-message-response-class.ts
|
|
43
|
-
models/get-email-subscription-response-class.ts
|
|
44
31
|
models/get-email-thread-response-class.ts
|
|
45
32
|
models/get-layout-request-dto.ts
|
|
46
33
|
models/get-layout-response-class.ts
|
|
47
34
|
models/get-notification-template-request-dto.ts
|
|
48
35
|
models/get-notification-template-response-class.ts
|
|
49
|
-
models/grpc-send-email-request-dto.ts
|
|
50
36
|
models/html-template-class.ts
|
|
51
37
|
models/index.ts
|
|
52
38
|
models/initiate-email-verification-dto.ts
|
|
53
39
|
models/initiate-email-verification-response-class.ts
|
|
54
|
-
models/inline-attachment-dto.ts
|
|
55
40
|
models/inline-response200.ts
|
|
56
41
|
models/inline-response503.ts
|
|
57
42
|
models/layout-class.ts
|
|
58
43
|
models/list-email-attachments-response-class.ts
|
|
59
|
-
models/list-email-mailboxes-response-class.ts
|
|
60
44
|
models/list-email-messages-response-class.ts
|
|
61
|
-
models/list-email-subscriptions-response-class.ts
|
|
62
45
|
models/list-email-threads-response-class.ts
|
|
63
46
|
models/list-layouts-response-class.ts
|
|
64
47
|
models/list-notification-templates-response-class.ts
|
|
65
48
|
models/notification-template-class.ts
|
|
66
|
-
models/reconcile-email-subscriptions-request-dto.ts
|
|
67
|
-
models/reconcile-email-subscriptions-response-class.ts
|
|
68
|
-
models/renew-email-subscription-response-class.ts
|
|
69
49
|
models/s3-document-dto.ts
|
|
70
|
-
models/send-email-request-dto.ts
|
|
71
|
-
models/send-email-response-class.ts
|
|
72
50
|
models/send-notification-request-dto.ts
|
|
73
51
|
models/send-notification-response-class.ts
|
|
74
|
-
models/unassign-email-thread-entity-response-class.ts
|
|
75
52
|
models/update-html-template-request-dto.ts
|
|
76
53
|
models/update-layout-request-dto.ts
|
|
77
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.6 --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.6
|
|
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.
|
|
@@ -68,10 +67,8 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
68
67
|
// http bearer authentication required
|
|
69
68
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
70
69
|
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
if (authorizationValue) {
|
|
74
|
-
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
70
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
71
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
75
72
|
}
|
|
76
73
|
|
|
77
74
|
|
|
@@ -86,8 +83,7 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
86
83
|
};
|
|
87
84
|
},
|
|
88
85
|
/**
|
|
89
|
-
*
|
|
90
|
-
* @summary Retrieve the email message
|
|
86
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
91
87
|
* @param {string} code
|
|
92
88
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
93
89
|
* @param {*} [options] Override http request option.
|
|
@@ -115,10 +111,8 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
115
111
|
// http bearer authentication required
|
|
116
112
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
117
113
|
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
if (authorizationValue) {
|
|
121
|
-
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
114
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
115
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
122
116
|
}
|
|
123
117
|
|
|
124
118
|
|
|
@@ -133,8 +127,7 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
133
127
|
};
|
|
134
128
|
},
|
|
135
129
|
/**
|
|
136
|
-
*
|
|
137
|
-
* @summary List the email message attachments
|
|
130
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
138
131
|
* @param {string} code
|
|
139
132
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
140
133
|
* @param {*} [options] Override http request option.
|
|
@@ -162,10 +155,8 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
162
155
|
// http bearer authentication required
|
|
163
156
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
164
157
|
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
if (authorizationValue) {
|
|
168
|
-
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
158
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
159
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
169
160
|
}
|
|
170
161
|
|
|
171
162
|
|
|
@@ -180,16 +171,16 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
180
171
|
};
|
|
181
172
|
},
|
|
182
173
|
/**
|
|
183
|
-
*
|
|
174
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
184
175
|
* @summary List email messages
|
|
185
176
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
186
177
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
187
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.
|
|
188
|
-
* @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>
|
|
189
180
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
190
|
-
* @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>
|
|
191
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>
|
|
192
|
-
* @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>
|
|
193
184
|
* @param {*} [options] Override http request option.
|
|
194
185
|
* @throws {RequiredError}
|
|
195
186
|
*/
|
|
@@ -240,10 +231,8 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
240
231
|
localVarQueryParameter['filters'] = filters;
|
|
241
232
|
}
|
|
242
233
|
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
if (authorizationValue) {
|
|
246
|
-
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
234
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
235
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
247
236
|
}
|
|
248
237
|
|
|
249
238
|
|
|
@@ -268,8 +257,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
268
257
|
const localVarAxiosParamCreator = EmailMessagesApiAxiosParamCreator(configuration)
|
|
269
258
|
return {
|
|
270
259
|
/**
|
|
271
|
-
*
|
|
272
|
-
* @summary Download the email message attachment
|
|
260
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
273
261
|
* @param {string} code
|
|
274
262
|
* @param {number} attachmentId
|
|
275
263
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -281,8 +269,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
281
269
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
282
270
|
},
|
|
283
271
|
/**
|
|
284
|
-
*
|
|
285
|
-
* @summary Retrieve the email message
|
|
272
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
286
273
|
* @param {string} code
|
|
287
274
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
288
275
|
* @param {*} [options] Override http request option.
|
|
@@ -293,8 +280,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
293
280
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
294
281
|
},
|
|
295
282
|
/**
|
|
296
|
-
*
|
|
297
|
-
* @summary List the email message attachments
|
|
283
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
298
284
|
* @param {string} code
|
|
299
285
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
300
286
|
* @param {*} [options] Override http request option.
|
|
@@ -305,16 +291,16 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
305
291
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
306
292
|
},
|
|
307
293
|
/**
|
|
308
|
-
*
|
|
294
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
309
295
|
* @summary List email messages
|
|
310
296
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
311
297
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
312
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.
|
|
313
|
-
* @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>
|
|
314
300
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
315
|
-
* @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>
|
|
316
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>
|
|
317
|
-
* @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>
|
|
318
304
|
* @param {*} [options] Override http request option.
|
|
319
305
|
* @throws {RequiredError}
|
|
320
306
|
*/
|
|
@@ -333,8 +319,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
333
319
|
const localVarFp = EmailMessagesApiFp(configuration)
|
|
334
320
|
return {
|
|
335
321
|
/**
|
|
336
|
-
*
|
|
337
|
-
* @summary Download the email message attachment
|
|
322
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
338
323
|
* @param {string} code
|
|
339
324
|
* @param {number} attachmentId
|
|
340
325
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -345,8 +330,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
345
330
|
return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then((request) => request(axios, basePath));
|
|
346
331
|
},
|
|
347
332
|
/**
|
|
348
|
-
*
|
|
349
|
-
* @summary Retrieve the email message
|
|
333
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
350
334
|
* @param {string} code
|
|
351
335
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
352
336
|
* @param {*} [options] Override http request option.
|
|
@@ -356,8 +340,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
356
340
|
return localVarFp.getMessage(code, authorization, options).then((request) => request(axios, basePath));
|
|
357
341
|
},
|
|
358
342
|
/**
|
|
359
|
-
*
|
|
360
|
-
* @summary List the email message attachments
|
|
343
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
361
344
|
* @param {string} code
|
|
362
345
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
363
346
|
* @param {*} [options] Override http request option.
|
|
@@ -367,16 +350,16 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
367
350
|
return localVarFp.listAttachments(code, authorization, options).then((request) => request(axios, basePath));
|
|
368
351
|
},
|
|
369
352
|
/**
|
|
370
|
-
*
|
|
353
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
371
354
|
* @summary List email messages
|
|
372
355
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
373
356
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
374
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.
|
|
375
|
-
* @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>
|
|
376
359
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
377
|
-
* @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>
|
|
378
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>
|
|
379
|
-
* @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>
|
|
380
363
|
* @param {*} [options] Override http request option.
|
|
381
364
|
* @throws {RequiredError}
|
|
382
365
|
*/
|
|
@@ -484,7 +467,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
484
467
|
readonly pageToken?: string
|
|
485
468
|
|
|
486
469
|
/**
|
|
487
|
-
* 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>
|
|
488
471
|
* @type {string}
|
|
489
472
|
* @memberof EmailMessagesApiListEmailMessages
|
|
490
473
|
*/
|
|
@@ -498,7 +481,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
498
481
|
readonly search?: string
|
|
499
482
|
|
|
500
483
|
/**
|
|
501
|
-
* 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>
|
|
502
485
|
* @type {string}
|
|
503
486
|
* @memberof EmailMessagesApiListEmailMessages
|
|
504
487
|
*/
|
|
@@ -512,7 +495,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
512
495
|
readonly expand?: string
|
|
513
496
|
|
|
514
497
|
/**
|
|
515
|
-
* 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>
|
|
516
499
|
* @type {string}
|
|
517
500
|
* @memberof EmailMessagesApiListEmailMessages
|
|
518
501
|
*/
|
|
@@ -527,8 +510,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
527
510
|
*/
|
|
528
511
|
export class EmailMessagesApi extends BaseAPI {
|
|
529
512
|
/**
|
|
530
|
-
*
|
|
531
|
-
* @summary Download the email message attachment
|
|
513
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
532
514
|
* @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
|
|
533
515
|
* @param {*} [options] Override http request option.
|
|
534
516
|
* @throws {RequiredError}
|
|
@@ -539,8 +521,7 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
539
521
|
}
|
|
540
522
|
|
|
541
523
|
/**
|
|
542
|
-
*
|
|
543
|
-
* @summary Retrieve the email message
|
|
524
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
544
525
|
* @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
|
|
545
526
|
* @param {*} [options] Override http request option.
|
|
546
527
|
* @throws {RequiredError}
|
|
@@ -551,8 +532,7 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
551
532
|
}
|
|
552
533
|
|
|
553
534
|
/**
|
|
554
|
-
*
|
|
555
|
-
* @summary List the email message attachments
|
|
535
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
556
536
|
* @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
|
|
557
537
|
* @param {*} [options] Override http request option.
|
|
558
538
|
* @throws {RequiredError}
|
|
@@ -563,7 +543,7 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
563
543
|
}
|
|
564
544
|
|
|
565
545
|
/**
|
|
566
|
-
*
|
|
546
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
567
547
|
* @summary List email messages
|
|
568
548
|
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
569
549
|
* @param {*} [options] Override http request option.
|