@emilgroup/notification-sdk 0.8.1-beta.42 → 0.8.1-beta.44

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.
@@ -246,9 +246,9 @@ var EmailTrackingApiAxiosParamCreator = function (configuration) {
246
246
  * @summary List email messages
247
247
  * @param {string} code
248
248
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
249
- * @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, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
250
- * @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, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
251
- * @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>
249
+ * @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
250
+ * @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
251
+ * @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
252
252
  * @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>
253
253
  * @param {*} [options] Override http request option.
254
254
  * @throws {RequiredError}
@@ -306,16 +306,16 @@ var EmailTrackingApiAxiosParamCreator = function (configuration) {
306
306
  });
307
307
  },
308
308
  /**
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\"
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), latestDeliveryStatus or latestWorkflowStatus (use latestWorkflowStatus==$null for threads whose newest message has no workflow). 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, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, 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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, 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, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, 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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, 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, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, 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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
319
319
  * @param {*} [options] Override http request option.
320
320
  * @throws {RequiredError}
321
321
  */
@@ -504,9 +504,9 @@ var EmailTrackingApiFp = function (configuration) {
504
504
  * @summary List email messages
505
505
  * @param {string} code
506
506
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
507
- * @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, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
508
- * @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, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
509
- * @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>
507
+ * @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
508
+ * @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
509
+ * @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
510
510
  * @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>
511
511
  * @param {*} [options] Override http request option.
512
512
  * @throws {RequiredError}
@@ -525,16 +525,16 @@ var EmailTrackingApiFp = function (configuration) {
525
525
  });
526
526
  },
527
527
  /**
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\"
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), latestDeliveryStatus or latestWorkflowStatus (use latestWorkflowStatus==$null for threads whose newest message has no workflow). 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, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, 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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, 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, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, 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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, 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, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, 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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
538
538
  * @param {*} [options] Override http request option.
539
539
  * @throws {RequiredError}
540
540
  */
@@ -621,9 +621,9 @@ var EmailTrackingApiFactory = function (configuration, basePath, axios) {
621
621
  * @summary List email messages
622
622
  * @param {string} code
623
623
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
624
- * @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, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
625
- * @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, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
626
- * @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>
624
+ * @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
625
+ * @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, entityNumber, direction, deliveryStatus, provider, mailbox, workflowStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
626
+ * @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, workflowStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
627
627
  * @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>
628
628
  * @param {*} [options] Override http request option.
629
629
  * @throws {RequiredError}
@@ -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, 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\"
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), latestDeliveryStatus or latestWorkflowStatus (use latestWorkflowStatus==$null for threads whose newest message has no workflow). 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, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, 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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, 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, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, 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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, 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, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestFromAddress, latestToAddresses, 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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, 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, 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\"
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), latestDeliveryStatus or latestWorkflowStatus (use latestWorkflowStatus==$null for threads whose newest message has no workflow). 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/api.d.ts CHANGED
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ export * from './api/email-mailboxes-api';
12
13
  export * from './api/email-messages-api';
13
14
  export * from './api/email-subscriptions-api';
14
15
  export * from './api/email-tracking-api';
package/dist/api.js CHANGED
@@ -27,6 +27,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
27
27
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
28
28
  };
29
29
  Object.defineProperty(exports, "__esModule", { value: true });
30
+ __exportStar(require("./api/email-mailboxes-api"), exports);
30
31
  __exportStar(require("./api/email-messages-api"), exports);
31
32
  __exportStar(require("./api/email-subscriptions-api"), exports);
32
33
  __exportStar(require("./api/email-tracking-api"), exports);
@@ -0,0 +1,47 @@
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 EmailMailboxClass
16
+ */
17
+ export interface EmailMailboxClass {
18
+ /**
19
+ * Email address of the mailbox, lower-cased. Use it as the `mailbox` filter when listing email threads or messages.
20
+ * @type {string}
21
+ * @memberof EmailMailboxClass
22
+ */
23
+ 'address': string;
24
+ /**
25
+ * Transport the mailbox belongs to: a Microsoft 365 mailbox reached through Graph, or the sender address of an SES tenant
26
+ * @type {string}
27
+ * @memberof EmailMailboxClass
28
+ */
29
+ 'provider': EmailMailboxClassProviderEnum;
30
+ /**
31
+ * Number of inbound messages in this mailbox. Delivery reports (bounces) are not counted.
32
+ * @type {number}
33
+ * @memberof EmailMailboxClass
34
+ */
35
+ 'inboundCount': number;
36
+ /**
37
+ * Number of outbound messages sent from this mailbox
38
+ * @type {number}
39
+ * @memberof EmailMailboxClass
40
+ */
41
+ 'outboundCount': number;
42
+ }
43
+ export declare const EmailMailboxClassProviderEnum: {
44
+ readonly Ses: "ses";
45
+ readonly Msgraph: "msgraph";
46
+ };
47
+ export type EmailMailboxClassProviderEnum = typeof EmailMailboxClassProviderEnum[keyof typeof EmailMailboxClassProviderEnum];
@@ -0,0 +1,20 @@
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.EmailMailboxClassProviderEnum = void 0;
17
+ exports.EmailMailboxClassProviderEnum = {
18
+ Ses: 'ses',
19
+ Msgraph: 'msgraph'
20
+ };
@@ -54,11 +54,17 @@ export interface EmailMessageClass {
54
54
  */
55
55
  'reportedMessageCode'?: string;
56
56
  /**
57
- * Provider that received an inbound message
57
+ * Provider the message was sent or received through
58
58
  * @type {string}
59
59
  * @memberof EmailMessageClass
60
60
  */
61
61
  'provider'?: EmailMessageClassProviderEnum;
62
+ /**
63
+ * Mailbox the message belongs to: the Microsoft 365 mailbox it was sent from or arrived in, or the sender address for SES. Empty for an inbound email that matched nothing yet.
64
+ * @type {string}
65
+ * @memberof EmailMessageClass
66
+ */
67
+ 'mailbox'?: string;
62
68
  /**
63
69
  * Direction of the email
64
70
  * @type {string}
@@ -173,6 +179,12 @@ export interface EmailMessageClass {
173
179
  * @memberof EmailMessageClass
174
180
  */
175
181
  'entityNumber'?: string;
182
+ /**
183
+ * Latest workflow status of the email: the status of whichever workflow it triggered changed most recently. Counts EMAIL_RECEIVED workflows for an incoming email and EMAIL_BOUNCED workflows for an outgoing one. Not set when the email triggered no workflow.
184
+ * @type {string}
185
+ * @memberof EmailMessageClass
186
+ */
187
+ 'workflowStatus'?: EmailMessageClassWorkflowStatusEnum;
176
188
  }
177
189
  export declare const EmailMessageClassMatchStatusEnum: {
178
190
  readonly Pending: "pending";
@@ -203,3 +215,10 @@ export declare const EmailMessageClassDeliveryStatusEnum: {
203
215
  readonly Received: "received";
204
216
  };
205
217
  export type EmailMessageClassDeliveryStatusEnum = typeof EmailMessageClassDeliveryStatusEnum[keyof typeof EmailMessageClassDeliveryStatusEnum];
218
+ export declare const EmailMessageClassWorkflowStatusEnum: {
219
+ readonly InProgress: "in_progress";
220
+ readonly Done: "done";
221
+ readonly Failed: "failed";
222
+ readonly Cancelled: "cancelled";
223
+ };
224
+ export type EmailMessageClassWorkflowStatusEnum = typeof EmailMessageClassWorkflowStatusEnum[keyof typeof EmailMessageClassWorkflowStatusEnum];
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.EmailMessageClassDeliveryStatusEnum = exports.EmailMessageClassDirectionEnum = exports.EmailMessageClassProviderEnum = exports.EmailMessageClassKindEnum = exports.EmailMessageClassMatchStatusEnum = void 0;
16
+ exports.EmailMessageClassWorkflowStatusEnum = exports.EmailMessageClassDeliveryStatusEnum = exports.EmailMessageClassDirectionEnum = exports.EmailMessageClassProviderEnum = exports.EmailMessageClassKindEnum = exports.EmailMessageClassMatchStatusEnum = void 0;
17
17
  exports.EmailMessageClassMatchStatusEnum = {
18
18
  Pending: 'pending',
19
19
  Matched: 'matched',
@@ -38,3 +38,9 @@ exports.EmailMessageClassDeliveryStatusEnum = {
38
38
  Failed: 'failed',
39
39
  Received: 'received'
40
40
  };
41
+ exports.EmailMessageClassWorkflowStatusEnum = {
42
+ InProgress: 'in_progress',
43
+ Done: 'done',
44
+ Failed: 'failed',
45
+ Cancelled: 'cancelled'
46
+ };
@@ -69,6 +69,12 @@ export interface EmailMessageSummaryClass {
69
69
  * @memberof EmailMessageSummaryClass
70
70
  */
71
71
  'createdAt': string;
72
+ /**
73
+ * Latest workflow status of the email: the status of whichever workflow it triggered changed most recently. Counts EMAIL_RECEIVED workflows for an incoming email and EMAIL_BOUNCED workflows for an outgoing one. Not set when the email triggered no workflow.
74
+ * @type {string}
75
+ * @memberof EmailMessageSummaryClass
76
+ */
77
+ 'workflowStatus'?: EmailMessageSummaryClassWorkflowStatusEnum;
72
78
  }
73
79
  export declare const EmailMessageSummaryClassDirectionEnum: {
74
80
  readonly Outbound: "outbound";
@@ -83,3 +89,10 @@ export declare const EmailMessageSummaryClassDeliveryStatusEnum: {
83
89
  readonly Received: "received";
84
90
  };
85
91
  export type EmailMessageSummaryClassDeliveryStatusEnum = typeof EmailMessageSummaryClassDeliveryStatusEnum[keyof typeof EmailMessageSummaryClassDeliveryStatusEnum];
92
+ export declare const EmailMessageSummaryClassWorkflowStatusEnum: {
93
+ readonly InProgress: "in_progress";
94
+ readonly Done: "done";
95
+ readonly Failed: "failed";
96
+ readonly Cancelled: "cancelled";
97
+ };
98
+ export type EmailMessageSummaryClassWorkflowStatusEnum = typeof EmailMessageSummaryClassWorkflowStatusEnum[keyof typeof EmailMessageSummaryClassWorkflowStatusEnum];
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.EmailMessageSummaryClassDeliveryStatusEnum = exports.EmailMessageSummaryClassDirectionEnum = void 0;
16
+ exports.EmailMessageSummaryClassWorkflowStatusEnum = exports.EmailMessageSummaryClassDeliveryStatusEnum = exports.EmailMessageSummaryClassDirectionEnum = void 0;
17
17
  exports.EmailMessageSummaryClassDirectionEnum = {
18
18
  Outbound: 'outbound',
19
19
  Inbound: 'inbound'
@@ -25,3 +25,9 @@ exports.EmailMessageSummaryClassDeliveryStatusEnum = {
25
25
  Failed: 'failed',
26
26
  Received: 'received'
27
27
  };
28
+ exports.EmailMessageSummaryClassWorkflowStatusEnum = {
29
+ InProgress: 'in_progress',
30
+ Done: 'done',
31
+ Failed: 'failed',
32
+ Cancelled: 'cancelled'
33
+ };
@@ -53,6 +53,12 @@ export interface EmailThreadClass {
53
53
  * @memberof EmailThreadClass
54
54
  */
55
55
  'status': EmailThreadClassStatusEnum;
56
+ /**
57
+ * Mailbox the thread belongs to: the Microsoft 365 mailbox the conversation lives in, or the sender address for SES. Empty for a thread opened by an inbound email that matched nothing.
58
+ * @type {string}
59
+ * @memberof EmailThreadClass
60
+ */
61
+ 'mailbox'?: string;
56
62
  /**
57
63
  * User who created this thread
58
64
  * @type {string}
@@ -10,6 +10,7 @@ export * from './delete-layout-request-dto';
10
10
  export * from './delete-notification-template-request-dto';
11
11
  export * from './download-attachment-response-class';
12
12
  export * from './email-attachment-class';
13
+ export * from './email-mailbox-class';
13
14
  export * from './email-message-class';
14
15
  export * from './email-message-summary-class';
15
16
  export * from './email-subscription-class';
@@ -31,6 +32,7 @@ export * from './inline-response200';
31
32
  export * from './inline-response503';
32
33
  export * from './layout-class';
33
34
  export * from './list-email-attachments-response-class';
35
+ export * from './list-email-mailboxes-response-class';
34
36
  export * from './list-email-messages-response-class';
35
37
  export * from './list-email-subscriptions-response-class';
36
38
  export * from './list-email-threads-response-class';
@@ -26,6 +26,7 @@ __exportStar(require("./delete-layout-request-dto"), exports);
26
26
  __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
+ __exportStar(require("./email-mailbox-class"), exports);
29
30
  __exportStar(require("./email-message-class"), exports);
30
31
  __exportStar(require("./email-message-summary-class"), exports);
31
32
  __exportStar(require("./email-subscription-class"), exports);
@@ -47,6 +48,7 @@ __exportStar(require("./inline-response200"), exports);
47
48
  __exportStar(require("./inline-response503"), exports);
48
49
  __exportStar(require("./layout-class"), exports);
49
50
  __exportStar(require("./list-email-attachments-response-class"), exports);
51
+ __exportStar(require("./list-email-mailboxes-response-class"), exports);
50
52
  __exportStar(require("./list-email-messages-response-class"), exports);
51
53
  __exportStar(require("./list-email-subscriptions-response-class"), exports);
52
54
  __exportStar(require("./list-email-threads-response-class"), exports);
@@ -0,0 +1,43 @@
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
+ import { EmailMailboxClass } from './email-mailbox-class';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface ListEmailMailboxesResponseClass
17
+ */
18
+ export interface ListEmailMailboxesResponseClass {
19
+ /**
20
+ * Next page token.
21
+ * @type {string}
22
+ * @memberof ListEmailMailboxesResponseClass
23
+ */
24
+ 'nextPageToken': string;
25
+ /**
26
+ * Total amount of items.
27
+ * @type {number}
28
+ * @memberof ListEmailMailboxesResponseClass
29
+ */
30
+ 'totalItems': number;
31
+ /**
32
+ * Items per page.
33
+ * @type {number}
34
+ * @memberof ListEmailMailboxesResponseClass
35
+ */
36
+ 'itemsPerPage': number;
37
+ /**
38
+ * Mailboxes of the tenant, sorted by address
39
+ * @type {Array<EmailMailboxClass>}
40
+ * @memberof ListEmailMailboxesResponseClass
41
+ */
42
+ 'items': Array<EmailMailboxClass>;
43
+ }
@@ -0,0 +1,15 @@
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 });
@@ -0,0 +1,56 @@
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 EmailMailboxClass
21
+ */
22
+ export interface EmailMailboxClass {
23
+ /**
24
+ * Email address of the mailbox, lower-cased. Use it as the `mailbox` filter when listing email threads or messages.
25
+ * @type {string}
26
+ * @memberof EmailMailboxClass
27
+ */
28
+ 'address': string;
29
+ /**
30
+ * Transport the mailbox belongs to: a Microsoft 365 mailbox reached through Graph, or the sender address of an SES tenant
31
+ * @type {string}
32
+ * @memberof EmailMailboxClass
33
+ */
34
+ 'provider': EmailMailboxClassProviderEnum;
35
+ /**
36
+ * Number of inbound messages in this mailbox. Delivery reports (bounces) are not counted.
37
+ * @type {number}
38
+ * @memberof EmailMailboxClass
39
+ */
40
+ 'inboundCount': number;
41
+ /**
42
+ * Number of outbound messages sent from this mailbox
43
+ * @type {number}
44
+ * @memberof EmailMailboxClass
45
+ */
46
+ 'outboundCount': number;
47
+ }
48
+
49
+ export const EmailMailboxClassProviderEnum = {
50
+ Ses: 'ses',
51
+ Msgraph: 'msgraph'
52
+ } as const;
53
+
54
+ export type EmailMailboxClassProviderEnum = typeof EmailMailboxClassProviderEnum[keyof typeof EmailMailboxClassProviderEnum];
55
+
56
+
@@ -59,11 +59,17 @@ export interface EmailMessageClass {
59
59
  */
60
60
  'reportedMessageCode'?: string;
61
61
  /**
62
- * Provider that received an inbound message
62
+ * Provider the message was sent or received through
63
63
  * @type {string}
64
64
  * @memberof EmailMessageClass
65
65
  */
66
66
  'provider'?: EmailMessageClassProviderEnum;
67
+ /**
68
+ * Mailbox the message belongs to: the Microsoft 365 mailbox it was sent from or arrived in, or the sender address for SES. Empty for an inbound email that matched nothing yet.
69
+ * @type {string}
70
+ * @memberof EmailMessageClass
71
+ */
72
+ 'mailbox'?: string;
67
73
  /**
68
74
  * Direction of the email
69
75
  * @type {string}
@@ -178,6 +184,12 @@ export interface EmailMessageClass {
178
184
  * @memberof EmailMessageClass
179
185
  */
180
186
  'entityNumber'?: string;
187
+ /**
188
+ * Latest workflow status of the email: the status of whichever workflow it triggered changed most recently. Counts EMAIL_RECEIVED workflows for an incoming email and EMAIL_BOUNCED workflows for an outgoing one. Not set when the email triggered no workflow.
189
+ * @type {string}
190
+ * @memberof EmailMessageClass
191
+ */
192
+ 'workflowStatus'?: EmailMessageClassWorkflowStatusEnum;
181
193
  }
182
194
 
183
195
  export const EmailMessageClassMatchStatusEnum = {
@@ -214,5 +226,13 @@ export const EmailMessageClassDeliveryStatusEnum = {
214
226
  } as const;
215
227
 
216
228
  export type EmailMessageClassDeliveryStatusEnum = typeof EmailMessageClassDeliveryStatusEnum[keyof typeof EmailMessageClassDeliveryStatusEnum];
229
+ export const EmailMessageClassWorkflowStatusEnum = {
230
+ InProgress: 'in_progress',
231
+ Done: 'done',
232
+ Failed: 'failed',
233
+ Cancelled: 'cancelled'
234
+ } as const;
235
+
236
+ export type EmailMessageClassWorkflowStatusEnum = typeof EmailMessageClassWorkflowStatusEnum[keyof typeof EmailMessageClassWorkflowStatusEnum];
217
237
 
218
238
 
@@ -74,6 +74,12 @@ export interface EmailMessageSummaryClass {
74
74
  * @memberof EmailMessageSummaryClass
75
75
  */
76
76
  'createdAt': string;
77
+ /**
78
+ * Latest workflow status of the email: the status of whichever workflow it triggered changed most recently. Counts EMAIL_RECEIVED workflows for an incoming email and EMAIL_BOUNCED workflows for an outgoing one. Not set when the email triggered no workflow.
79
+ * @type {string}
80
+ * @memberof EmailMessageSummaryClass
81
+ */
82
+ 'workflowStatus'?: EmailMessageSummaryClassWorkflowStatusEnum;
77
83
  }
78
84
 
79
85
  export const EmailMessageSummaryClassDirectionEnum = {
@@ -91,5 +97,13 @@ export const EmailMessageSummaryClassDeliveryStatusEnum = {
91
97
  } as const;
92
98
 
93
99
  export type EmailMessageSummaryClassDeliveryStatusEnum = typeof EmailMessageSummaryClassDeliveryStatusEnum[keyof typeof EmailMessageSummaryClassDeliveryStatusEnum];
100
+ export const EmailMessageSummaryClassWorkflowStatusEnum = {
101
+ InProgress: 'in_progress',
102
+ Done: 'done',
103
+ Failed: 'failed',
104
+ Cancelled: 'cancelled'
105
+ } as const;
106
+
107
+ export type EmailMessageSummaryClassWorkflowStatusEnum = typeof EmailMessageSummaryClassWorkflowStatusEnum[keyof typeof EmailMessageSummaryClassWorkflowStatusEnum];
94
108
 
95
109
 
@@ -58,6 +58,12 @@ export interface EmailThreadClass {
58
58
  * @memberof EmailThreadClass
59
59
  */
60
60
  'status': EmailThreadClassStatusEnum;
61
+ /**
62
+ * Mailbox the thread belongs to: the Microsoft 365 mailbox the conversation lives in, or the sender address for SES. Empty for a thread opened by an inbound email that matched nothing.
63
+ * @type {string}
64
+ * @memberof EmailThreadClass
65
+ */
66
+ 'mailbox'?: string;
61
67
  /**
62
68
  * User who created this thread
63
69
  * @type {string}
package/models/index.ts CHANGED
@@ -10,6 +10,7 @@ export * from './delete-layout-request-dto';
10
10
  export * from './delete-notification-template-request-dto';
11
11
  export * from './download-attachment-response-class';
12
12
  export * from './email-attachment-class';
13
+ export * from './email-mailbox-class';
13
14
  export * from './email-message-class';
14
15
  export * from './email-message-summary-class';
15
16
  export * from './email-subscription-class';
@@ -31,6 +32,7 @@ export * from './inline-response200';
31
32
  export * from './inline-response503';
32
33
  export * from './layout-class';
33
34
  export * from './list-email-attachments-response-class';
35
+ export * from './list-email-mailboxes-response-class';
34
36
  export * from './list-email-messages-response-class';
35
37
  export * from './list-email-subscriptions-response-class';
36
38
  export * from './list-email-threads-response-class';