@emilgroup/notification-sdk 0.8.1-beta.41 → 0.8.1-beta.43
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 +4 -0
- package/README.md +2 -2
- package/api/email-mailboxes-api.ts +148 -0
- package/api/email-messages-api.ts +12 -12
- package/api/email-tracking-api.ts +28 -28
- package/api.ts +2 -0
- package/base.ts +36 -15
- package/configuration.ts +11 -0
- package/dist/api/email-mailboxes-api.d.ts +87 -0
- package/dist/api/email-mailboxes-api.js +218 -0
- package/dist/api/email-messages-api.d.ts +12 -12
- package/dist/api/email-messages-api.js +9 -9
- package/dist/api/email-tracking-api.d.ts +28 -28
- package/dist/api/email-tracking-api.js +22 -22
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- 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-mailbox-class.d.ts +47 -0
- package/dist/models/email-mailbox-class.js +20 -0
- package/dist/models/email-message-class.d.ts +21 -3
- package/dist/models/email-message-class.js +7 -2
- package/dist/models/email-message-summary-class.d.ts +98 -0
- package/dist/models/email-message-summary-class.js +33 -0
- package/dist/models/email-thread-class.d.ts +31 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/list-email-mailboxes-response-class.d.ts +43 -0
- package/dist/models/list-email-mailboxes-response-class.js +15 -0
- package/models/email-mailbox-class.ts +56 -0
- package/models/email-message-class.ts +22 -3
- package/models/email-message-summary-class.ts +109 -0
- package/models/email-thread-class.ts +31 -0
- package/models/index.ts +3 -0
- package/models/list-email-mailboxes-response-class.ts +49 -0
- package/package.json +1 -1
|
@@ -56,25 +56,25 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
56
56
|
* @summary List email messages
|
|
57
57
|
* @param {string} code
|
|
58
58
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
59
|
-
* @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>
|
|
60
|
-
* @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>
|
|
61
|
-
* @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>
|
|
59
|
+
* @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>
|
|
60
|
+
* @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>
|
|
61
|
+
* @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>
|
|
62
62
|
* @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>
|
|
63
63
|
* @param {*} [options] Override http request option.
|
|
64
64
|
* @throws {RequiredError}
|
|
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), 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\"
|
|
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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, 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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, 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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
78
78
|
* @param {*} [options] Override http request option.
|
|
79
79
|
* @throws {RequiredError}
|
|
80
80
|
*/
|
|
@@ -127,25 +127,25 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
|
|
|
127
127
|
* @summary List email messages
|
|
128
128
|
* @param {string} code
|
|
129
129
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
130
|
-
* @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>
|
|
131
|
-
* @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>
|
|
132
|
-
* @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>
|
|
130
|
+
* @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>
|
|
131
|
+
* @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>
|
|
132
|
+
* @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>
|
|
133
133
|
* @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>
|
|
134
134
|
* @param {*} [options] Override http request option.
|
|
135
135
|
* @throws {RequiredError}
|
|
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), 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\"
|
|
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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, 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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, 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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
149
149
|
* @param {*} [options] Override http request option.
|
|
150
150
|
* @throws {RequiredError}
|
|
151
151
|
*/
|
|
@@ -198,25 +198,25 @@ export declare const EmailTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
198
198
|
* @summary List email messages
|
|
199
199
|
* @param {string} code
|
|
200
200
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
201
|
-
* @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>
|
|
202
|
-
* @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>
|
|
203
|
-
* @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>
|
|
201
|
+
* @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>
|
|
202
|
+
* @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>
|
|
203
|
+
* @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>
|
|
204
204
|
* @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>
|
|
205
205
|
* @param {*} [options] Override http request option.
|
|
206
206
|
* @throws {RequiredError}
|
|
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), 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\"
|
|
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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, 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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, 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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, latestFromAddress, latestToAddresses, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
220
220
|
* @param {*} [options] Override http request option.
|
|
221
221
|
* @throws {RequiredError}
|
|
222
222
|
*/
|
|
@@ -313,19 +313,19 @@ export interface EmailTrackingApiListMessagesRequest {
|
|
|
313
313
|
*/
|
|
314
314
|
readonly authorization?: string;
|
|
315
315
|
/**
|
|
316
|
-
* 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>
|
|
316
|
+
* 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>
|
|
317
317
|
* @type {string}
|
|
318
318
|
* @memberof EmailTrackingApiListMessages
|
|
319
319
|
*/
|
|
320
320
|
readonly filter?: string;
|
|
321
321
|
/**
|
|
322
|
-
* 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>
|
|
322
|
+
* 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>
|
|
323
323
|
* @type {string}
|
|
324
324
|
* @memberof EmailTrackingApiListMessages
|
|
325
325
|
*/
|
|
326
326
|
readonly filters?: string;
|
|
327
327
|
/**
|
|
328
|
-
* 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>
|
|
328
|
+
* 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>
|
|
329
329
|
* @type {string}
|
|
330
330
|
* @memberof EmailTrackingApiListMessages
|
|
331
331
|
*/
|
|
@@ -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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, 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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, 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, mailbox, messageCount, lastMessageAt, latestDirection, latestDeliveryStatus, latestWorkflowStatus, 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), 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\"
|
|
459
459
|
* @summary List email threads
|
|
460
460
|
* @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
|
|
461
461
|
* @param {*} [options] Override http request option.
|
|
@@ -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. 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), 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, 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, 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, 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. 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), 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, 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, 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, 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. 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), 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, 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, 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, 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. 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), 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
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);
|
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.
|
|
@@ -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
|
+
};
|