@emilgroup/notification-sdk 0.8.1-beta.41 → 0.8.1-beta.42
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 +1 -0
- package/README.md +2 -2
- package/api/email-tracking-api.ts +16 -16
- package/base.ts +36 -15
- package/configuration.ts +11 -0
- package/dist/api/email-tracking-api.d.ts +16 -16
- package/dist/api/email-tracking-api.js +13 -13
- package/dist/base.d.ts +1 -0
- package/dist/base.js +36 -16
- package/dist/configuration.d.ts +9 -0
- package/dist/configuration.js +1 -0
- package/dist/models/email-message-class.d.ts +1 -2
- package/dist/models/email-message-class.js +0 -1
- package/dist/models/email-message-summary-class.d.ts +85 -0
- package/dist/models/email-message-summary-class.js +27 -0
- package/dist/models/email-thread-class.d.ts +25 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/models/email-message-class.ts +1 -2
- package/models/email-message-summary-class.ts +95 -0
- package/models/email-thread-class.ts +25 -0
- package/models/index.ts +1 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -30,6 +30,7 @@ models/delete-notification-template-request-dto.ts
|
|
|
30
30
|
models/download-attachment-response-class.ts
|
|
31
31
|
models/email-attachment-class.ts
|
|
32
32
|
models/email-message-class.ts
|
|
33
|
+
models/email-message-summary-class.ts
|
|
33
34
|
models/email-subscription-class.ts
|
|
34
35
|
models/email-thread-class.ts
|
|
35
36
|
models/entity-ref-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.42 --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.42
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import ``.
|
|
@@ -245,16 +245,16 @@ export const EmailTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
245
245
|
};
|
|
246
246
|
},
|
|
247
247
|
/**
|
|
248
|
-
* Returns a list of email threads. A thread groups an email
|
|
248
|
+
* Returns a list of email threads, newest first. A thread groups an email with its replies; each item carries the newest message of the thread in latestMessage and the number of messages in messageCount. Threads without a message yet are not listed. Filter on the newest message with latestDirection (inbox tabs) or latestDeliveryStatus. Add expand=messages to get every message of each thread, without bodies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
249
249
|
* @summary List email threads
|
|
250
250
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
251
251
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
252
252
|
* @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.
|
|
253
|
-
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
253
|
+
* @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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
254
254
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
255
|
-
* @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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
255
|
+
* @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, entityType, entityCode, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, createdAt, updatedAt</i>
|
|
256
256
|
* @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: messages<i>
|
|
257
|
-
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
257
|
+
* @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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
258
258
|
* @param {*} [options] Override http request option.
|
|
259
259
|
* @throws {RequiredError}
|
|
260
260
|
*/
|
|
@@ -429,16 +429,16 @@ export const EmailTrackingApiFp = function(configuration?: Configuration) {
|
|
|
429
429
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
430
430
|
},
|
|
431
431
|
/**
|
|
432
|
-
* Returns a list of email threads. A thread groups an email
|
|
432
|
+
* Returns a list of email threads, newest first. A thread groups an email with its replies; each item carries the newest message of the thread in latestMessage and the number of messages in messageCount. Threads without a message yet are not listed. Filter on the newest message with latestDirection (inbox tabs) or latestDeliveryStatus. Add expand=messages to get every message of each thread, without bodies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
433
433
|
* @summary List email threads
|
|
434
434
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
435
435
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
436
436
|
* @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.
|
|
437
|
-
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
437
|
+
* @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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
438
438
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
439
|
-
* @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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
439
|
+
* @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, entityType, entityCode, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, createdAt, updatedAt</i>
|
|
440
440
|
* @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: messages<i>
|
|
441
|
-
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
441
|
+
* @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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
442
442
|
* @param {*} [options] Override http request option.
|
|
443
443
|
* @throws {RequiredError}
|
|
444
444
|
*/
|
|
@@ -518,16 +518,16 @@ export const EmailTrackingApiFactory = function (configuration?: Configuration,
|
|
|
518
518
|
return localVarFp.listMessages(code, authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
|
|
519
519
|
},
|
|
520
520
|
/**
|
|
521
|
-
* Returns a list of email threads. A thread groups an email
|
|
521
|
+
* Returns a list of email threads, newest first. A thread groups an email with its replies; each item carries the newest message of the thread in latestMessage and the number of messages in messageCount. Threads without a message yet are not listed. Filter on the newest message with latestDirection (inbox tabs) or latestDeliveryStatus. Add expand=messages to get every message of each thread, without bodies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
522
522
|
* @summary List email threads
|
|
523
523
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
524
524
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
525
525
|
* @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.
|
|
526
|
-
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
526
|
+
* @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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
527
527
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
528
|
-
* @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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
528
|
+
* @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, entityType, entityCode, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, createdAt, updatedAt</i>
|
|
529
529
|
* @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: messages<i>
|
|
530
|
-
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
530
|
+
* @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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
531
531
|
* @param {*} [options] Override http request option.
|
|
532
532
|
* @throws {RequiredError}
|
|
533
533
|
*/
|
|
@@ -695,7 +695,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
695
695
|
readonly pageToken?: string
|
|
696
696
|
|
|
697
697
|
/**
|
|
698
|
-
* 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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
698
|
+
* 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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
699
699
|
* @type {string}
|
|
700
700
|
* @memberof EmailTrackingApiListThreads
|
|
701
701
|
*/
|
|
@@ -709,7 +709,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
709
709
|
readonly search?: string
|
|
710
710
|
|
|
711
711
|
/**
|
|
712
|
-
* 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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
712
|
+
* 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, entityType, entityCode, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, createdAt, updatedAt</i>
|
|
713
713
|
* @type {string}
|
|
714
714
|
* @memberof EmailTrackingApiListThreads
|
|
715
715
|
*/
|
|
@@ -723,7 +723,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
723
723
|
readonly expand?: string
|
|
724
724
|
|
|
725
725
|
/**
|
|
726
|
-
* 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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
726
|
+
* 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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
727
727
|
* @type {string}
|
|
728
728
|
* @memberof EmailTrackingApiListThreads
|
|
729
729
|
*/
|
|
@@ -807,7 +807,7 @@ export class EmailTrackingApi extends BaseAPI {
|
|
|
807
807
|
}
|
|
808
808
|
|
|
809
809
|
/**
|
|
810
|
-
* Returns a list of email threads. A thread groups an email
|
|
810
|
+
* Returns a list of email threads, newest first. A thread groups an email with its replies; each item carries the newest message of the thread in latestMessage and the number of messages in messageCount. Threads without a message yet are not listed. Filter on the newest message with latestDirection (inbox tabs) or latestDeliveryStatus. Add expand=messages to get every message of each thread, without bodies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
811
811
|
* @summary List email threads
|
|
812
812
|
* @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
|
|
813
813
|
* @param {*} [options] Override http request option.
|
package/base.ts
CHANGED
|
@@ -102,10 +102,14 @@ export class BaseAPI {
|
|
|
102
102
|
this.configuration = configuration;
|
|
103
103
|
this.basePath = configuration.basePath || this.basePath;
|
|
104
104
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
105
|
+
if (configuration.cookieAuth) {
|
|
106
|
+
this.useCookieAuth();
|
|
107
|
+
} else {
|
|
108
|
+
// Use config token if provided, otherwise use tokenData token
|
|
109
|
+
const configToken = this.configuration.accessToken;
|
|
110
|
+
const storedToken = accessToken ? `Bearer ${accessToken}` : '';
|
|
111
|
+
this.configuration.accessToken = configToken || storedToken;
|
|
112
|
+
}
|
|
109
113
|
} else {
|
|
110
114
|
const { accessToken, username } = this.tokenData;
|
|
111
115
|
|
|
@@ -119,6 +123,12 @@ export class BaseAPI {
|
|
|
119
123
|
this.attachInterceptor(axios);
|
|
120
124
|
}
|
|
121
125
|
|
|
126
|
+
// Cookie mode: the browser sends the HttpOnly access cookie, so no token is read from storage.
|
|
127
|
+
private useCookieAuth() {
|
|
128
|
+
this.configuration.username = this.configuration.username || this.tokenData.username;
|
|
129
|
+
this.configuration.baseOptions = { ...this.configuration.baseOptions, withCredentials: true };
|
|
130
|
+
}
|
|
131
|
+
|
|
122
132
|
selectEnvironment(env: Environment) {
|
|
123
133
|
this.selectBasePath(env);
|
|
124
134
|
}
|
|
@@ -152,10 +162,12 @@ export class BaseAPI {
|
|
|
152
162
|
const { data: { accessToken, permissions } } = response;
|
|
153
163
|
|
|
154
164
|
this.configuration.username = username;
|
|
155
|
-
this.configuration.accessToken = `Bearer ${accessToken}`;
|
|
156
165
|
this.tokenData.username = username;
|
|
157
|
-
this.tokenData.accessToken = accessToken;
|
|
158
166
|
this.tokenData.permissions = permissions;
|
|
167
|
+
if (!this.configuration.cookieAuth) {
|
|
168
|
+
this.configuration.accessToken = `Bearer ${accessToken}`;
|
|
169
|
+
this.tokenData.accessToken = accessToken;
|
|
170
|
+
}
|
|
159
171
|
|
|
160
172
|
// Switch workspace if provided
|
|
161
173
|
if (targetWorkspace) {
|
|
@@ -178,7 +190,7 @@ export class BaseAPI {
|
|
|
178
190
|
url: `${this.configuration.basePath}/authservice/v1/workspaces/switch`,
|
|
179
191
|
headers: {
|
|
180
192
|
'Content-Type': 'application/json',
|
|
181
|
-
'Authorization': `Bearer ${this.configuration.accessToken}
|
|
193
|
+
...(this.configuration.cookieAuth ? {} : { 'Authorization': `Bearer ${this.configuration.accessToken}` }),
|
|
182
194
|
},
|
|
183
195
|
data: {
|
|
184
196
|
username: this.configuration.username,
|
|
@@ -190,10 +202,12 @@ export class BaseAPI {
|
|
|
190
202
|
const response = await globalAxios.request<SwitchWorkspaceResponseClass>(options);
|
|
191
203
|
|
|
192
204
|
const { data: { accessToken, permissions } } = response;
|
|
193
|
-
|
|
194
|
-
this.configuration.accessToken = `Bearer ${accessToken}`;
|
|
195
|
-
this.tokenData.accessToken = accessToken;
|
|
205
|
+
|
|
196
206
|
this.tokenData.permissions = permissions;
|
|
207
|
+
if (!this.configuration.cookieAuth) {
|
|
208
|
+
this.configuration.accessToken = `Bearer ${accessToken}`;
|
|
209
|
+
this.tokenData.accessToken = accessToken;
|
|
210
|
+
}
|
|
197
211
|
|
|
198
212
|
this.storeTokenData({
|
|
199
213
|
...this.tokenData
|
|
@@ -233,6 +247,11 @@ export class BaseAPI {
|
|
|
233
247
|
|
|
234
248
|
private storeTokenData(tokenData?: TokenData) {
|
|
235
249
|
if (typeof window !== 'undefined') {
|
|
250
|
+
if (tokenData && this.configuration?.cookieAuth) {
|
|
251
|
+
// Cookie mode saves who is logged in, never the token; a token saved by apps not yet migrated stays.
|
|
252
|
+
const { username, permissions } = tokenData;
|
|
253
|
+
tokenData = { ...(defaultStorage().get<TokenData>(TOKEN_DATA) || {}), username, permissions };
|
|
254
|
+
}
|
|
236
255
|
defaultStorage().set<TokenData>(TOKEN_DATA, tokenData);
|
|
237
256
|
}
|
|
238
257
|
}
|
|
@@ -263,15 +282,17 @@ export class BaseAPI {
|
|
|
263
282
|
originalConfig._retry = true;
|
|
264
283
|
try {
|
|
265
284
|
const { accessToken: tokenString, permissions } = await this.refreshTokenInternal();
|
|
266
|
-
const accessToken = `Bearer ${tokenString}`;
|
|
267
285
|
this.tokenData.permissions = permissions;
|
|
268
286
|
|
|
269
287
|
delete originalConfig.headers['Authorization']
|
|
270
288
|
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
289
|
+
// In cookie mode the refresh reply renewed the access cookie, so retry without a header.
|
|
290
|
+
if (!this.configuration.cookieAuth) {
|
|
291
|
+
const accessToken = `Bearer ${tokenString}`;
|
|
292
|
+
originalConfig.headers['Authorization'] = accessToken;
|
|
293
|
+
this.configuration.accessToken = accessToken;
|
|
294
|
+
this.tokenData.accessToken = tokenString;
|
|
295
|
+
}
|
|
275
296
|
|
|
276
297
|
this.storeTokenData(this.tokenData);
|
|
277
298
|
|
package/configuration.ts
CHANGED
|
@@ -21,6 +21,7 @@ export interface ConfigurationParameters {
|
|
|
21
21
|
basePath?: string;
|
|
22
22
|
baseOptions?: any;
|
|
23
23
|
formDataCtor?: new () => any;
|
|
24
|
+
cookieAuth?: boolean;
|
|
24
25
|
}
|
|
25
26
|
|
|
26
27
|
export class Configuration {
|
|
@@ -74,6 +75,15 @@ export class Configuration {
|
|
|
74
75
|
*/
|
|
75
76
|
formDataCtor?: new () => any;
|
|
76
77
|
|
|
78
|
+
/**
|
|
79
|
+
* Authenticate with the HttpOnly access cookie instead of a stored token: every call sends credentials.
|
|
80
|
+
* The browser holds one cookie, so use it with one logged-in account; log out through the auth service.
|
|
81
|
+
*
|
|
82
|
+
* @type {boolean}
|
|
83
|
+
* @memberof Configuration
|
|
84
|
+
*/
|
|
85
|
+
cookieAuth?: boolean;
|
|
86
|
+
|
|
77
87
|
constructor(param: ConfigurationParameters = {}) {
|
|
78
88
|
this.apiKey = param.apiKey;
|
|
79
89
|
this.username = param.username;
|
|
@@ -82,6 +92,7 @@ export class Configuration {
|
|
|
82
92
|
this.basePath = param.basePath;
|
|
83
93
|
this.baseOptions = param.baseOptions;
|
|
84
94
|
this.formDataCtor = param.formDataCtor;
|
|
95
|
+
this.cookieAuth = param.cookieAuth;
|
|
85
96
|
}
|
|
86
97
|
|
|
87
98
|
/**
|
|
@@ -65,16 +65,16 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
65
65
|
*/
|
|
66
66
|
listMessages: (code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
67
|
/**
|
|
68
|
-
* Returns a list of email threads. A thread groups an email
|
|
68
|
+
* Returns a list of email threads, newest first. A thread groups an email with its replies; each item carries the newest message of the thread in latestMessage and the number of messages in messageCount. Threads without a message yet are not listed. Filter on the newest message with latestDirection (inbox tabs) or latestDeliveryStatus. Add expand=messages to get every message of each thread, without bodies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
69
69
|
* @summary List email threads
|
|
70
70
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
71
71
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
72
72
|
* @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.
|
|
73
|
-
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
73
|
+
* @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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
74
74
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
75
|
-
* @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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
75
|
+
* @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, entityType, entityCode, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, createdAt, updatedAt</i>
|
|
76
76
|
* @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: messages<i>
|
|
77
|
-
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
77
|
+
* @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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
78
78
|
* @param {*} [options] Override http request option.
|
|
79
79
|
* @throws {RequiredError}
|
|
80
80
|
*/
|
|
@@ -136,16 +136,16 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
|
|
|
136
136
|
*/
|
|
137
137
|
listMessages(code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>>;
|
|
138
138
|
/**
|
|
139
|
-
* Returns a list of email threads. A thread groups an email
|
|
139
|
+
* Returns a list of email threads, newest first. A thread groups an email with its replies; each item carries the newest message of the thread in latestMessage and the number of messages in messageCount. Threads without a message yet are not listed. Filter on the newest message with latestDirection (inbox tabs) or latestDeliveryStatus. Add expand=messages to get every message of each thread, without bodies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
140
140
|
* @summary List email threads
|
|
141
141
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
142
142
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
143
143
|
* @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.
|
|
144
|
-
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
144
|
+
* @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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
145
145
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
146
|
-
* @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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
146
|
+
* @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, entityType, entityCode, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, createdAt, updatedAt</i>
|
|
147
147
|
* @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: messages<i>
|
|
148
|
-
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
148
|
+
* @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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
149
149
|
* @param {*} [options] Override http request option.
|
|
150
150
|
* @throws {RequiredError}
|
|
151
151
|
*/
|
|
@@ -207,16 +207,16 @@ export declare const EmailTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
207
207
|
*/
|
|
208
208
|
listMessages(code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass>;
|
|
209
209
|
/**
|
|
210
|
-
* Returns a list of email threads. A thread groups an email
|
|
210
|
+
* Returns a list of email threads, newest first. A thread groups an email with its replies; each item carries the newest message of the thread in latestMessage and the number of messages in messageCount. Threads without a message yet are not listed. Filter on the newest message with latestDirection (inbox tabs) or latestDeliveryStatus. Add expand=messages to get every message of each thread, without bodies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
211
211
|
* @summary List email threads
|
|
212
212
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
213
213
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
214
214
|
* @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.
|
|
215
|
-
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
215
|
+
* @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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
216
216
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
217
|
-
* @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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
217
|
+
* @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, entityType, entityCode, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, createdAt, updatedAt</i>
|
|
218
218
|
* @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: messages<i>
|
|
219
|
-
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
219
|
+
* @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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
220
220
|
* @param {*} [options] Override http request option.
|
|
221
221
|
* @throws {RequiredError}
|
|
222
222
|
*/
|
|
@@ -362,7 +362,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
362
362
|
*/
|
|
363
363
|
readonly pageToken?: string;
|
|
364
364
|
/**
|
|
365
|
-
* 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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
365
|
+
* 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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
366
366
|
* @type {string}
|
|
367
367
|
* @memberof EmailTrackingApiListThreads
|
|
368
368
|
*/
|
|
@@ -374,7 +374,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
374
374
|
*/
|
|
375
375
|
readonly search?: string;
|
|
376
376
|
/**
|
|
377
|
-
* 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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
377
|
+
* 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, entityType, entityCode, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, createdAt, updatedAt</i>
|
|
378
378
|
* @type {string}
|
|
379
379
|
* @memberof EmailTrackingApiListThreads
|
|
380
380
|
*/
|
|
@@ -386,7 +386,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
386
386
|
*/
|
|
387
387
|
readonly expand?: string;
|
|
388
388
|
/**
|
|
389
|
-
* 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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
389
|
+
* 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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
390
390
|
* @type {string}
|
|
391
391
|
* @memberof EmailTrackingApiListThreads
|
|
392
392
|
*/
|
|
@@ -455,7 +455,7 @@ export declare class EmailTrackingApi extends BaseAPI {
|
|
|
455
455
|
*/
|
|
456
456
|
listMessages(requestParameters: EmailTrackingApiListMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailMessagesResponseClass, any, {}>>;
|
|
457
457
|
/**
|
|
458
|
-
* Returns a list of email threads. A thread groups an email
|
|
458
|
+
* Returns a list of email threads, newest first. A thread groups an email with its replies; each item carries the newest message of the thread in latestMessage and the number of messages in messageCount. Threads without a message yet are not listed. Filter on the newest message with latestDirection (inbox tabs) or latestDeliveryStatus. Add expand=messages to get every message of each thread, without bodies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
459
459
|
* @summary List email threads
|
|
460
460
|
* @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
|
|
461
461
|
* @param {*} [options] Override http request option.
|
|
@@ -306,16 +306,16 @@ var EmailTrackingApiAxiosParamCreator = function (configuration) {
|
|
|
306
306
|
});
|
|
307
307
|
},
|
|
308
308
|
/**
|
|
309
|
-
* Returns a list of email threads. A thread groups an email
|
|
309
|
+
* Returns a list of email threads, newest first. A thread groups an email with its replies; each item carries the newest message of the thread in latestMessage and the number of messages in messageCount. Threads without a message yet are not listed. Filter on the newest message with latestDirection (inbox tabs) or latestDeliveryStatus. Add expand=messages to get every message of each thread, without bodies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
310
310
|
* @summary List email threads
|
|
311
311
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
312
312
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
313
313
|
* @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.
|
|
314
|
-
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
314
|
+
* @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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
315
315
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
316
|
-
* @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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
316
|
+
* @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, entityType, entityCode, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, createdAt, updatedAt</i>
|
|
317
317
|
* @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: messages<i>
|
|
318
|
-
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
318
|
+
* @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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
319
319
|
* @param {*} [options] Override http request option.
|
|
320
320
|
* @throws {RequiredError}
|
|
321
321
|
*/
|
|
@@ -525,16 +525,16 @@ var EmailTrackingApiFp = function (configuration) {
|
|
|
525
525
|
});
|
|
526
526
|
},
|
|
527
527
|
/**
|
|
528
|
-
* Returns a list of email threads. A thread groups an email
|
|
528
|
+
* Returns a list of email threads, newest first. A thread groups an email with its replies; each item carries the newest message of the thread in latestMessage and the number of messages in messageCount. Threads without a message yet are not listed. Filter on the newest message with latestDirection (inbox tabs) or latestDeliveryStatus. Add expand=messages to get every message of each thread, without bodies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
529
529
|
* @summary List email threads
|
|
530
530
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
531
531
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
532
532
|
* @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.
|
|
533
|
-
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
533
|
+
* @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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
534
534
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
535
|
-
* @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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
535
|
+
* @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, entityType, entityCode, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, createdAt, updatedAt</i>
|
|
536
536
|
* @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: messages<i>
|
|
537
|
-
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
537
|
+
* @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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
538
538
|
* @param {*} [options] Override http request option.
|
|
539
539
|
* @throws {RequiredError}
|
|
540
540
|
*/
|
|
@@ -632,16 +632,16 @@ var EmailTrackingApiFactory = function (configuration, basePath, axios) {
|
|
|
632
632
|
return localVarFp.listMessages(code, authorization, filter, filters, order, expand, options).then(function (request) { return request(axios, basePath); });
|
|
633
633
|
},
|
|
634
634
|
/**
|
|
635
|
-
* Returns a list of email threads. A thread groups an email
|
|
635
|
+
* Returns a list of email threads, newest first. A thread groups an email with its replies; each item carries the newest message of the thread in latestMessage and the number of messages in messageCount. Threads without a message yet are not listed. Filter on the newest message with latestDirection (inbox tabs) or latestDeliveryStatus. Add expand=messages to get every message of each thread, without bodies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
636
636
|
* @summary List email threads
|
|
637
637
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
638
638
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
639
639
|
* @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.
|
|
640
|
-
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
640
|
+
* @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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
641
641
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
642
|
-
* @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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
642
|
+
* @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, entityType, entityCode, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, createdAt, updatedAt</i>
|
|
643
643
|
* @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: messages<i>
|
|
644
|
-
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
644
|
+
* @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, entityType, entityCode, entityNumber, subject, status, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
645
645
|
* @param {*} [options] Override http request option.
|
|
646
646
|
* @throws {RequiredError}
|
|
647
647
|
*/
|
|
@@ -722,7 +722,7 @@ var EmailTrackingApi = /** @class */ (function (_super) {
|
|
|
722
722
|
return (0, exports.EmailTrackingApiFp)(this.configuration).listMessages(requestParameters.code, requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
723
723
|
};
|
|
724
724
|
/**
|
|
725
|
-
* Returns a list of email threads. A thread groups an email
|
|
725
|
+
* Returns a list of email threads, newest first. A thread groups an email with its replies; each item carries the newest message of the thread in latestMessage and the number of messages in messageCount. Threads without a message yet are not listed. Filter on the newest message with latestDirection (inbox tabs) or latestDeliveryStatus. Add expand=messages to get every message of each thread, without bodies. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
726
726
|
* @summary List email threads
|
|
727
727
|
* @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
|
|
728
728
|
* @param {*} [options] Override http request option.
|
package/dist/base.d.ts
CHANGED
|
@@ -63,6 +63,7 @@ export declare class BaseAPI {
|
|
|
63
63
|
protected configuration: Configuration | undefined;
|
|
64
64
|
private tokenData?;
|
|
65
65
|
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
66
|
+
private useCookieAuth;
|
|
66
67
|
selectEnvironment(env: Environment): void;
|
|
67
68
|
selectBasePath(path: string): void;
|
|
68
69
|
getPermissions(): Array<string>;
|
package/dist/base.js
CHANGED
|
@@ -128,10 +128,15 @@ var BaseAPI = /** @class */ (function () {
|
|
|
128
128
|
var accessToken = this.tokenData.accessToken;
|
|
129
129
|
this.configuration = configuration;
|
|
130
130
|
this.basePath = configuration.basePath || this.basePath;
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
131
|
+
if (configuration.cookieAuth) {
|
|
132
|
+
this.useCookieAuth();
|
|
133
|
+
}
|
|
134
|
+
else {
|
|
135
|
+
// Use config token if provided, otherwise use tokenData token
|
|
136
|
+
var configToken = this.configuration.accessToken;
|
|
137
|
+
var storedToken = accessToken ? "Bearer ".concat(accessToken) : '';
|
|
138
|
+
this.configuration.accessToken = configToken || storedToken;
|
|
139
|
+
}
|
|
135
140
|
}
|
|
136
141
|
else {
|
|
137
142
|
var _a = this.tokenData, accessToken = _a.accessToken, username = _a.username;
|
|
@@ -143,6 +148,11 @@ var BaseAPI = /** @class */ (function () {
|
|
|
143
148
|
}
|
|
144
149
|
this.attachInterceptor(axios);
|
|
145
150
|
}
|
|
151
|
+
// Cookie mode: the browser sends the HttpOnly access cookie, so no token is read from storage.
|
|
152
|
+
BaseAPI.prototype.useCookieAuth = function () {
|
|
153
|
+
this.configuration.username = this.configuration.username || this.tokenData.username;
|
|
154
|
+
this.configuration.baseOptions = __assign(__assign({}, this.configuration.baseOptions), { withCredentials: true });
|
|
155
|
+
};
|
|
146
156
|
BaseAPI.prototype.selectEnvironment = function (env) {
|
|
147
157
|
this.selectBasePath(env);
|
|
148
158
|
};
|
|
@@ -177,10 +187,12 @@ var BaseAPI = /** @class */ (function () {
|
|
|
177
187
|
response = _b.sent();
|
|
178
188
|
_a = response.data, accessToken = _a.accessToken, permissions = _a.permissions;
|
|
179
189
|
this.configuration.username = username;
|
|
180
|
-
this.configuration.accessToken = "Bearer ".concat(accessToken);
|
|
181
190
|
this.tokenData.username = username;
|
|
182
|
-
this.tokenData.accessToken = accessToken;
|
|
183
191
|
this.tokenData.permissions = permissions;
|
|
192
|
+
if (!this.configuration.cookieAuth) {
|
|
193
|
+
this.configuration.accessToken = "Bearer ".concat(accessToken);
|
|
194
|
+
this.tokenData.accessToken = accessToken;
|
|
195
|
+
}
|
|
184
196
|
if (!targetWorkspace) return [3 /*break*/, 3];
|
|
185
197
|
return [4 /*yield*/, this.switchWorkspace(targetWorkspace)];
|
|
186
198
|
case 2:
|
|
@@ -206,10 +218,7 @@ var BaseAPI = /** @class */ (function () {
|
|
|
206
218
|
options = {
|
|
207
219
|
method: 'POST',
|
|
208
220
|
url: "".concat(this.configuration.basePath, "/authservice/v1/workspaces/switch"),
|
|
209
|
-
headers: {
|
|
210
|
-
'Content-Type': 'application/json',
|
|
211
|
-
'Authorization': "Bearer ".concat(this.configuration.accessToken),
|
|
212
|
-
},
|
|
221
|
+
headers: __assign({ 'Content-Type': 'application/json' }, (this.configuration.cookieAuth ? {} : { 'Authorization': "Bearer ".concat(this.configuration.accessToken) })),
|
|
213
222
|
data: {
|
|
214
223
|
username: this.configuration.username,
|
|
215
224
|
targetWorkspace: targetWorkspace,
|
|
@@ -220,9 +229,11 @@ var BaseAPI = /** @class */ (function () {
|
|
|
220
229
|
case 1:
|
|
221
230
|
response = _b.sent();
|
|
222
231
|
_a = response.data, accessToken = _a.accessToken, permissions = _a.permissions;
|
|
223
|
-
this.configuration.accessToken = "Bearer ".concat(accessToken);
|
|
224
|
-
this.tokenData.accessToken = accessToken;
|
|
225
232
|
this.tokenData.permissions = permissions;
|
|
233
|
+
if (!this.configuration.cookieAuth) {
|
|
234
|
+
this.configuration.accessToken = "Bearer ".concat(accessToken);
|
|
235
|
+
this.tokenData.accessToken = accessToken;
|
|
236
|
+
}
|
|
226
237
|
this.storeTokenData(__assign({}, this.tokenData));
|
|
227
238
|
return [2 /*return*/];
|
|
228
239
|
}
|
|
@@ -265,7 +276,13 @@ var BaseAPI = /** @class */ (function () {
|
|
|
265
276
|
});
|
|
266
277
|
};
|
|
267
278
|
BaseAPI.prototype.storeTokenData = function (tokenData) {
|
|
279
|
+
var _a;
|
|
268
280
|
if (typeof window !== 'undefined') {
|
|
281
|
+
if (tokenData && ((_a = this.configuration) === null || _a === void 0 ? void 0 : _a.cookieAuth)) {
|
|
282
|
+
// Cookie mode saves who is logged in, never the token; a token saved by apps not yet migrated stays.
|
|
283
|
+
var username = tokenData.username, permissions = tokenData.permissions;
|
|
284
|
+
tokenData = __assign(__assign({}, ((0, common_1.defaultStorage)().get(TOKEN_DATA) || {})), { username: username, permissions: permissions });
|
|
285
|
+
}
|
|
269
286
|
(0, common_1.defaultStorage)().set(TOKEN_DATA, tokenData);
|
|
270
287
|
}
|
|
271
288
|
};
|
|
@@ -300,12 +317,15 @@ var BaseAPI = /** @class */ (function () {
|
|
|
300
317
|
return [4 /*yield*/, this.refreshTokenInternal()];
|
|
301
318
|
case 2:
|
|
302
319
|
_a = _c.sent(), tokenString = _a.accessToken, permissions = _a.permissions;
|
|
303
|
-
accessToken = "Bearer ".concat(tokenString);
|
|
304
320
|
this.tokenData.permissions = permissions;
|
|
305
321
|
delete originalConfig.headers['Authorization'];
|
|
306
|
-
|
|
307
|
-
this.configuration.
|
|
308
|
-
|
|
322
|
+
// In cookie mode the refresh reply renewed the access cookie, so retry without a header.
|
|
323
|
+
if (!this.configuration.cookieAuth) {
|
|
324
|
+
accessToken = "Bearer ".concat(tokenString);
|
|
325
|
+
originalConfig.headers['Authorization'] = accessToken;
|
|
326
|
+
this.configuration.accessToken = accessToken;
|
|
327
|
+
this.tokenData.accessToken = tokenString;
|
|
328
|
+
}
|
|
309
329
|
this.storeTokenData(this.tokenData);
|
|
310
330
|
return [2 /*return*/, axios(originalConfig)];
|
|
311
331
|
case 3:
|
package/dist/configuration.d.ts
CHANGED
|
@@ -17,6 +17,7 @@ export interface ConfigurationParameters {
|
|
|
17
17
|
basePath?: string;
|
|
18
18
|
baseOptions?: any;
|
|
19
19
|
formDataCtor?: new () => any;
|
|
20
|
+
cookieAuth?: boolean;
|
|
20
21
|
}
|
|
21
22
|
export declare class Configuration {
|
|
22
23
|
/**
|
|
@@ -68,6 +69,14 @@ export declare class Configuration {
|
|
|
68
69
|
* @type {new () => FormData}
|
|
69
70
|
*/
|
|
70
71
|
formDataCtor?: new () => any;
|
|
72
|
+
/**
|
|
73
|
+
* Authenticate with the HttpOnly access cookie instead of a stored token: every call sends credentials.
|
|
74
|
+
* The browser holds one cookie, so use it with one logged-in account; log out through the auth service.
|
|
75
|
+
*
|
|
76
|
+
* @type {boolean}
|
|
77
|
+
* @memberof Configuration
|
|
78
|
+
*/
|
|
79
|
+
cookieAuth?: boolean;
|
|
71
80
|
constructor(param?: ConfigurationParameters);
|
|
72
81
|
/**
|
|
73
82
|
* Check if the given MIME is a JSON MIME.
|
package/dist/configuration.js
CHANGED
|
@@ -24,6 +24,7 @@ var Configuration = /** @class */ (function () {
|
|
|
24
24
|
this.basePath = param.basePath;
|
|
25
25
|
this.baseOptions = param.baseOptions;
|
|
26
26
|
this.formDataCtor = param.formDataCtor;
|
|
27
|
+
this.cookieAuth = param.cookieAuth;
|
|
27
28
|
}
|
|
28
29
|
/**
|
|
29
30
|
* Check if the given MIME is a JSON MIME.
|
|
@@ -102,7 +102,7 @@ export interface EmailMessageClass {
|
|
|
102
102
|
*/
|
|
103
103
|
'bodyHtml'?: string;
|
|
104
104
|
/**
|
|
105
|
-
* Delivery status of the email. Outbound emails move through pending → sent
|
|
105
|
+
* Delivery status of the email. Outbound emails move through pending → sent, then bounced if a bounce arrives; failed marks a system-level send failure; inbound emails are always received.
|
|
106
106
|
* @type {string}
|
|
107
107
|
* @memberof EmailMessageClass
|
|
108
108
|
*/
|
|
@@ -198,7 +198,6 @@ export type EmailMessageClassDirectionEnum = typeof EmailMessageClassDirectionEn
|
|
|
198
198
|
export declare const EmailMessageClassDeliveryStatusEnum: {
|
|
199
199
|
readonly Pending: "pending";
|
|
200
200
|
readonly Sent: "sent";
|
|
201
|
-
readonly Delivered: "delivered";
|
|
202
201
|
readonly Bounced: "bounced";
|
|
203
202
|
readonly Failed: "failed";
|
|
204
203
|
readonly Received: "received";
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL NotificationService
|
|
3
|
+
* The EMIL NotificationService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface EmailMessageSummaryClass
|
|
16
|
+
*/
|
|
17
|
+
export interface EmailMessageSummaryClass {
|
|
18
|
+
/**
|
|
19
|
+
* Unique identifier code for the email message. Use it to fetch the full message.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof EmailMessageSummaryClass
|
|
22
|
+
*/
|
|
23
|
+
'code': string;
|
|
24
|
+
/**
|
|
25
|
+
* Whether the message was received or sent
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof EmailMessageSummaryClass
|
|
28
|
+
*/
|
|
29
|
+
'direction': EmailMessageSummaryClassDirectionEnum;
|
|
30
|
+
/**
|
|
31
|
+
* Sender email address
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof EmailMessageSummaryClass
|
|
34
|
+
*/
|
|
35
|
+
'fromAddress': string;
|
|
36
|
+
/**
|
|
37
|
+
* Recipient email addresses, comma-separated
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof EmailMessageSummaryClass
|
|
40
|
+
*/
|
|
41
|
+
'toAddresses': string;
|
|
42
|
+
/**
|
|
43
|
+
* Email subject
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof EmailMessageSummaryClass
|
|
46
|
+
*/
|
|
47
|
+
'subject'?: string;
|
|
48
|
+
/**
|
|
49
|
+
* Delivery status of the message
|
|
50
|
+
* @type {string}
|
|
51
|
+
* @memberof EmailMessageSummaryClass
|
|
52
|
+
*/
|
|
53
|
+
'deliveryStatus': EmailMessageSummaryClassDeliveryStatusEnum;
|
|
54
|
+
/**
|
|
55
|
+
* Timestamp when the email was sent
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof EmailMessageSummaryClass
|
|
58
|
+
*/
|
|
59
|
+
'sentAt'?: string;
|
|
60
|
+
/**
|
|
61
|
+
* Timestamp when the email was received
|
|
62
|
+
* @type {string}
|
|
63
|
+
* @memberof EmailMessageSummaryClass
|
|
64
|
+
*/
|
|
65
|
+
'receivedAt'?: string;
|
|
66
|
+
/**
|
|
67
|
+
* Created at timestamp
|
|
68
|
+
* @type {string}
|
|
69
|
+
* @memberof EmailMessageSummaryClass
|
|
70
|
+
*/
|
|
71
|
+
'createdAt': string;
|
|
72
|
+
}
|
|
73
|
+
export declare const EmailMessageSummaryClassDirectionEnum: {
|
|
74
|
+
readonly Outbound: "outbound";
|
|
75
|
+
readonly Inbound: "inbound";
|
|
76
|
+
};
|
|
77
|
+
export type EmailMessageSummaryClassDirectionEnum = typeof EmailMessageSummaryClassDirectionEnum[keyof typeof EmailMessageSummaryClassDirectionEnum];
|
|
78
|
+
export declare const EmailMessageSummaryClassDeliveryStatusEnum: {
|
|
79
|
+
readonly Pending: "pending";
|
|
80
|
+
readonly Sent: "sent";
|
|
81
|
+
readonly Bounced: "bounced";
|
|
82
|
+
readonly Failed: "failed";
|
|
83
|
+
readonly Received: "received";
|
|
84
|
+
};
|
|
85
|
+
export type EmailMessageSummaryClassDeliveryStatusEnum = typeof EmailMessageSummaryClassDeliveryStatusEnum[keyof typeof EmailMessageSummaryClassDeliveryStatusEnum];
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* EMIL NotificationService
|
|
6
|
+
* The EMIL NotificationService API description
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
* Contact: kontakt@emil.de
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.EmailMessageSummaryClassDeliveryStatusEnum = exports.EmailMessageSummaryClassDirectionEnum = void 0;
|
|
17
|
+
exports.EmailMessageSummaryClassDirectionEnum = {
|
|
18
|
+
Outbound: 'outbound',
|
|
19
|
+
Inbound: 'inbound'
|
|
20
|
+
};
|
|
21
|
+
exports.EmailMessageSummaryClassDeliveryStatusEnum = {
|
|
22
|
+
Pending: 'pending',
|
|
23
|
+
Sent: 'sent',
|
|
24
|
+
Bounced: 'bounced',
|
|
25
|
+
Failed: 'failed',
|
|
26
|
+
Received: 'received'
|
|
27
|
+
};
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import { EmailMessageSummaryClass } from './email-message-summary-class';
|
|
12
13
|
import { EntityRefClass } from './entity-ref-class';
|
|
13
14
|
/**
|
|
14
15
|
*
|
|
@@ -76,6 +77,30 @@ export interface EmailThreadClass {
|
|
|
76
77
|
* @memberof EmailThreadClass
|
|
77
78
|
*/
|
|
78
79
|
'updatedAt': string;
|
|
80
|
+
/**
|
|
81
|
+
* Number of messages in the thread. Delivery reports (bounces) are not counted.
|
|
82
|
+
* @type {number}
|
|
83
|
+
* @memberof EmailThreadClass
|
|
84
|
+
*/
|
|
85
|
+
'messageCount': number;
|
|
86
|
+
/**
|
|
87
|
+
* When the newest message of the thread was received, or sent for an outbound message
|
|
88
|
+
* @type {string}
|
|
89
|
+
* @memberof EmailThreadClass
|
|
90
|
+
*/
|
|
91
|
+
'lastMessageAt'?: string;
|
|
92
|
+
/**
|
|
93
|
+
* Newest message of the thread, the one a thread row in a list shows. Set when listing threads.
|
|
94
|
+
* @type {EmailMessageSummaryClass}
|
|
95
|
+
* @memberof EmailThreadClass
|
|
96
|
+
*/
|
|
97
|
+
'latestMessage'?: EmailMessageSummaryClass;
|
|
98
|
+
/**
|
|
99
|
+
* Every message of the thread, newest first. Only filled when listing with expand=messages; bodies are fetched per message.
|
|
100
|
+
* @type {Array<EmailMessageSummaryClass>}
|
|
101
|
+
* @memberof EmailThreadClass
|
|
102
|
+
*/
|
|
103
|
+
'messages': Array<EmailMessageSummaryClass>;
|
|
79
104
|
}
|
|
80
105
|
export declare const EmailThreadClassStatusEnum: {
|
|
81
106
|
readonly Open: "open";
|
package/dist/models/index.d.ts
CHANGED
|
@@ -11,6 +11,7 @@ export * from './delete-notification-template-request-dto';
|
|
|
11
11
|
export * from './download-attachment-response-class';
|
|
12
12
|
export * from './email-attachment-class';
|
|
13
13
|
export * from './email-message-class';
|
|
14
|
+
export * from './email-message-summary-class';
|
|
14
15
|
export * from './email-subscription-class';
|
|
15
16
|
export * from './email-thread-class';
|
|
16
17
|
export * from './entity-ref-class';
|
package/dist/models/index.js
CHANGED
|
@@ -27,6 +27,7 @@ __exportStar(require("./delete-notification-template-request-dto"), exports);
|
|
|
27
27
|
__exportStar(require("./download-attachment-response-class"), exports);
|
|
28
28
|
__exportStar(require("./email-attachment-class"), exports);
|
|
29
29
|
__exportStar(require("./email-message-class"), exports);
|
|
30
|
+
__exportStar(require("./email-message-summary-class"), exports);
|
|
30
31
|
__exportStar(require("./email-subscription-class"), exports);
|
|
31
32
|
__exportStar(require("./email-thread-class"), exports);
|
|
32
33
|
__exportStar(require("./entity-ref-class"), exports);
|
|
@@ -107,7 +107,7 @@ export interface EmailMessageClass {
|
|
|
107
107
|
*/
|
|
108
108
|
'bodyHtml'?: string;
|
|
109
109
|
/**
|
|
110
|
-
* Delivery status of the email. Outbound emails move through pending → sent
|
|
110
|
+
* Delivery status of the email. Outbound emails move through pending → sent, then bounced if a bounce arrives; failed marks a system-level send failure; inbound emails are always received.
|
|
111
111
|
* @type {string}
|
|
112
112
|
* @memberof EmailMessageClass
|
|
113
113
|
*/
|
|
@@ -208,7 +208,6 @@ export type EmailMessageClassDirectionEnum = typeof EmailMessageClassDirectionEn
|
|
|
208
208
|
export const EmailMessageClassDeliveryStatusEnum = {
|
|
209
209
|
Pending: 'pending',
|
|
210
210
|
Sent: 'sent',
|
|
211
|
-
Delivered: 'delivered',
|
|
212
211
|
Bounced: 'bounced',
|
|
213
212
|
Failed: 'failed',
|
|
214
213
|
Received: 'received'
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL NotificationService
|
|
5
|
+
* The EMIL NotificationService API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @interface EmailMessageSummaryClass
|
|
21
|
+
*/
|
|
22
|
+
export interface EmailMessageSummaryClass {
|
|
23
|
+
/**
|
|
24
|
+
* Unique identifier code for the email message. Use it to fetch the full message.
|
|
25
|
+
* @type {string}
|
|
26
|
+
* @memberof EmailMessageSummaryClass
|
|
27
|
+
*/
|
|
28
|
+
'code': string;
|
|
29
|
+
/**
|
|
30
|
+
* Whether the message was received or sent
|
|
31
|
+
* @type {string}
|
|
32
|
+
* @memberof EmailMessageSummaryClass
|
|
33
|
+
*/
|
|
34
|
+
'direction': EmailMessageSummaryClassDirectionEnum;
|
|
35
|
+
/**
|
|
36
|
+
* Sender email address
|
|
37
|
+
* @type {string}
|
|
38
|
+
* @memberof EmailMessageSummaryClass
|
|
39
|
+
*/
|
|
40
|
+
'fromAddress': string;
|
|
41
|
+
/**
|
|
42
|
+
* Recipient email addresses, comma-separated
|
|
43
|
+
* @type {string}
|
|
44
|
+
* @memberof EmailMessageSummaryClass
|
|
45
|
+
*/
|
|
46
|
+
'toAddresses': string;
|
|
47
|
+
/**
|
|
48
|
+
* Email subject
|
|
49
|
+
* @type {string}
|
|
50
|
+
* @memberof EmailMessageSummaryClass
|
|
51
|
+
*/
|
|
52
|
+
'subject'?: string;
|
|
53
|
+
/**
|
|
54
|
+
* Delivery status of the message
|
|
55
|
+
* @type {string}
|
|
56
|
+
* @memberof EmailMessageSummaryClass
|
|
57
|
+
*/
|
|
58
|
+
'deliveryStatus': EmailMessageSummaryClassDeliveryStatusEnum;
|
|
59
|
+
/**
|
|
60
|
+
* Timestamp when the email was sent
|
|
61
|
+
* @type {string}
|
|
62
|
+
* @memberof EmailMessageSummaryClass
|
|
63
|
+
*/
|
|
64
|
+
'sentAt'?: string;
|
|
65
|
+
/**
|
|
66
|
+
* Timestamp when the email was received
|
|
67
|
+
* @type {string}
|
|
68
|
+
* @memberof EmailMessageSummaryClass
|
|
69
|
+
*/
|
|
70
|
+
'receivedAt'?: string;
|
|
71
|
+
/**
|
|
72
|
+
* Created at timestamp
|
|
73
|
+
* @type {string}
|
|
74
|
+
* @memberof EmailMessageSummaryClass
|
|
75
|
+
*/
|
|
76
|
+
'createdAt': string;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export const EmailMessageSummaryClassDirectionEnum = {
|
|
80
|
+
Outbound: 'outbound',
|
|
81
|
+
Inbound: 'inbound'
|
|
82
|
+
} as const;
|
|
83
|
+
|
|
84
|
+
export type EmailMessageSummaryClassDirectionEnum = typeof EmailMessageSummaryClassDirectionEnum[keyof typeof EmailMessageSummaryClassDirectionEnum];
|
|
85
|
+
export const EmailMessageSummaryClassDeliveryStatusEnum = {
|
|
86
|
+
Pending: 'pending',
|
|
87
|
+
Sent: 'sent',
|
|
88
|
+
Bounced: 'bounced',
|
|
89
|
+
Failed: 'failed',
|
|
90
|
+
Received: 'received'
|
|
91
|
+
} as const;
|
|
92
|
+
|
|
93
|
+
export type EmailMessageSummaryClassDeliveryStatusEnum = typeof EmailMessageSummaryClassDeliveryStatusEnum[keyof typeof EmailMessageSummaryClassDeliveryStatusEnum];
|
|
94
|
+
|
|
95
|
+
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
|
|
16
|
+
import { EmailMessageSummaryClass } from './email-message-summary-class';
|
|
16
17
|
import { EntityRefClass } from './entity-ref-class';
|
|
17
18
|
|
|
18
19
|
/**
|
|
@@ -81,6 +82,30 @@ export interface EmailThreadClass {
|
|
|
81
82
|
* @memberof EmailThreadClass
|
|
82
83
|
*/
|
|
83
84
|
'updatedAt': string;
|
|
85
|
+
/**
|
|
86
|
+
* Number of messages in the thread. Delivery reports (bounces) are not counted.
|
|
87
|
+
* @type {number}
|
|
88
|
+
* @memberof EmailThreadClass
|
|
89
|
+
*/
|
|
90
|
+
'messageCount': number;
|
|
91
|
+
/**
|
|
92
|
+
* When the newest message of the thread was received, or sent for an outbound message
|
|
93
|
+
* @type {string}
|
|
94
|
+
* @memberof EmailThreadClass
|
|
95
|
+
*/
|
|
96
|
+
'lastMessageAt'?: string;
|
|
97
|
+
/**
|
|
98
|
+
* Newest message of the thread, the one a thread row in a list shows. Set when listing threads.
|
|
99
|
+
* @type {EmailMessageSummaryClass}
|
|
100
|
+
* @memberof EmailThreadClass
|
|
101
|
+
*/
|
|
102
|
+
'latestMessage'?: EmailMessageSummaryClass;
|
|
103
|
+
/**
|
|
104
|
+
* Every message of the thread, newest first. Only filled when listing with expand=messages; bodies are fetched per message.
|
|
105
|
+
* @type {Array<EmailMessageSummaryClass>}
|
|
106
|
+
* @memberof EmailThreadClass
|
|
107
|
+
*/
|
|
108
|
+
'messages': Array<EmailMessageSummaryClass>;
|
|
84
109
|
}
|
|
85
110
|
|
|
86
111
|
export const EmailThreadClassStatusEnum = {
|
package/models/index.ts
CHANGED
|
@@ -11,6 +11,7 @@ export * from './delete-notification-template-request-dto';
|
|
|
11
11
|
export * from './download-attachment-response-class';
|
|
12
12
|
export * from './email-attachment-class';
|
|
13
13
|
export * from './email-message-class';
|
|
14
|
+
export * from './email-message-summary-class';
|
|
14
15
|
export * from './email-subscription-class';
|
|
15
16
|
export * from './email-thread-class';
|
|
16
17
|
export * from './entity-ref-class';
|