@emilgroup/notification-sdk 0.8.1-beta.56 → 0.8.1-beta.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +0 -23
- package/README.md +2 -2
- package/api/email-messages-api.ts +28 -40
- package/api/email-tracking-api.ts +40 -271
- package/api/email-verifications-api.ts +8 -16
- package/api/layouts-api.ts +36 -56
- package/api/notification-templates-api.ts +36 -56
- package/api/notifications-api.ts +4 -115
- package/api.ts +0 -6
- package/dist/api/email-messages-api.d.ts +28 -40
- package/dist/api/email-messages-api.js +25 -37
- package/dist/api/email-tracking-api.d.ts +40 -170
- package/dist/api/email-tracking-api.js +34 -233
- package/dist/api/email-verifications-api.d.ts +8 -16
- package/dist/api/email-verifications-api.js +8 -16
- package/dist/api/layouts-api.d.ts +36 -56
- package/dist/api/layouts-api.js +32 -52
- package/dist/api/notification-templates-api.d.ts +36 -56
- package/dist/api/notification-templates-api.js +32 -52
- package/dist/api/notifications-api.d.ts +4 -65
- package/dist/api/notifications-api.js +4 -101
- package/dist/api.d.ts +0 -3
- package/dist/api.js +0 -3
- package/dist/models/email-message-class.d.ts +7 -73
- package/dist/models/email-message-class.js +3 -22
- package/dist/models/email-thread-class.d.ts +5 -37
- package/dist/models/index.d.ts +0 -20
- package/dist/models/index.js +0 -20
- package/dist/models/send-notification-request-dto.d.ts +1 -10
- package/dist/models/send-notification-request-dto.js +1 -2
- package/models/email-message-class.ts +8 -78
- package/models/email-thread-class.ts +5 -37
- package/models/index.ts +0 -20
- package/models/send-notification-request-dto.ts +2 -9
- package/package.json +1 -1
- package/api/email-mailboxes-api.ts +0 -148
- package/api/email-subscriptions-api.ts +0 -769
- package/api/msgraph-webhooks-api.ts +0 -278
- package/dist/api/email-mailboxes-api.d.ts +0 -87
- package/dist/api/email-mailboxes-api.js +0 -218
- package/dist/api/email-subscriptions-api.d.ts +0 -432
- package/dist/api/email-subscriptions-api.js +0 -722
- package/dist/api/msgraph-webhooks-api.d.ts +0 -168
- package/dist/api/msgraph-webhooks-api.js +0 -305
- package/dist/models/assign-email-thread-entity-body-dto.d.ts +0 -43
- package/dist/models/assign-email-thread-entity-body-dto.js +0 -22
- package/dist/models/assign-email-thread-entity-response-class.d.ts +0 -25
- package/dist/models/assign-email-thread-entity-response-class.js +0 -15
- package/dist/models/catch-up-email-subscription-response-class.d.ts +0 -24
- package/dist/models/catch-up-email-subscription-response-class.js +0 -15
- package/dist/models/catch-up-email-subscriptions-request-dto.d.ts +0 -24
- package/dist/models/catch-up-email-subscriptions-request-dto.js +0 -15
- package/dist/models/catch-up-email-subscriptions-response-class.d.ts +0 -30
- package/dist/models/catch-up-email-subscriptions-response-class.js +0 -15
- package/dist/models/email-mailbox-class.d.ts +0 -47
- package/dist/models/email-mailbox-class.js +0 -20
- package/dist/models/email-message-summary-class.d.ts +0 -98
- package/dist/models/email-message-summary-class.js +0 -33
- package/dist/models/email-subscription-class.d.ts +0 -110
- package/dist/models/email-subscription-class.js +0 -23
- package/dist/models/entity-ref-class.d.ts +0 -37
- package/dist/models/entity-ref-class.js +0 -22
- package/dist/models/get-email-subscription-response-class.d.ts +0 -25
- package/dist/models/get-email-subscription-response-class.js +0 -15
- package/dist/models/grpc-send-email-request-dto.d.ts +0 -137
- package/dist/models/grpc-send-email-request-dto.js +0 -22
- package/dist/models/inline-attachment-dto.d.ts +0 -36
- package/dist/models/inline-attachment-dto.js +0 -15
- package/dist/models/list-email-mailboxes-response-class.d.ts +0 -43
- package/dist/models/list-email-mailboxes-response-class.js +0 -15
- package/dist/models/list-email-subscriptions-response-class.d.ts +0 -43
- package/dist/models/list-email-subscriptions-response-class.js +0 -15
- package/dist/models/reconcile-email-subscriptions-request-dto.d.ts +0 -24
- package/dist/models/reconcile-email-subscriptions-request-dto.js +0 -15
- package/dist/models/reconcile-email-subscriptions-response-class.d.ts +0 -48
- package/dist/models/reconcile-email-subscriptions-response-class.js +0 -15
- package/dist/models/renew-email-subscription-response-class.d.ts +0 -25
- package/dist/models/renew-email-subscription-response-class.js +0 -15
- package/dist/models/send-email-request-dto.d.ts +0 -131
- package/dist/models/send-email-request-dto.js +0 -22
- package/dist/models/send-email-response-class.d.ts +0 -24
- package/dist/models/send-email-response-class.js +0 -15
- package/dist/models/unassign-email-thread-entity-response-class.d.ts +0 -25
- package/dist/models/unassign-email-thread-entity-response-class.js +0 -15
- package/models/assign-email-thread-entity-body-dto.ts +0 -52
- package/models/assign-email-thread-entity-response-class.ts +0 -31
- package/models/catch-up-email-subscription-response-class.ts +0 -30
- package/models/catch-up-email-subscriptions-request-dto.ts +0 -30
- package/models/catch-up-email-subscriptions-response-class.ts +0 -36
- package/models/email-mailbox-class.ts +0 -56
- package/models/email-message-summary-class.ts +0 -109
- package/models/email-subscription-class.ts +0 -119
- package/models/entity-ref-class.ts +0 -46
- package/models/get-email-subscription-response-class.ts +0 -31
- package/models/grpc-send-email-request-dto.ts +0 -144
- package/models/inline-attachment-dto.ts +0 -42
- package/models/list-email-mailboxes-response-class.ts +0 -49
- package/models/list-email-subscriptions-response-class.ts +0 -49
- package/models/reconcile-email-subscriptions-request-dto.ts +0 -30
- package/models/reconcile-email-subscriptions-response-class.ts +0 -54
- package/models/renew-email-subscription-response-class.ts +0 -31
- package/models/send-email-request-dto.ts +0 -138
- package/models/send-email-response-class.ts +0 -30
- package/models/unassign-email-thread-entity-response-class.ts +0 -31
|
@@ -12,30 +12,16 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
-
import { AssignEmailThreadEntityBodyDto } from '../models';
|
|
16
|
-
import { AssignEmailThreadEntityResponseClass } from '../models';
|
|
17
15
|
import { GetEmailThreadResponseClass } from '../models';
|
|
18
16
|
import { ListEmailMessagesResponseClass } from '../models';
|
|
19
17
|
import { ListEmailThreadsResponseClass } from '../models';
|
|
20
|
-
import { UnassignEmailThreadEntityResponseClass } from '../models';
|
|
21
18
|
/**
|
|
22
19
|
* EmailTrackingApi - axios parameter creator
|
|
23
20
|
* @export
|
|
24
21
|
*/
|
|
25
22
|
export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
23
|
/**
|
|
27
|
-
*
|
|
28
|
-
* @summary Assign an email thread to an entity
|
|
29
|
-
* @param {string} code
|
|
30
|
-
* @param {AssignEmailThreadEntityBodyDto} assignEmailThreadEntityBodyDto
|
|
31
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
32
|
-
* @param {*} [options] Override http request option.
|
|
33
|
-
* @throws {RequiredError}
|
|
34
|
-
*/
|
|
35
|
-
assignEntity: (code: string, assignEmailThreadEntityBodyDto: AssignEmailThreadEntityBodyDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36
|
-
/**
|
|
37
|
-
* Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
38
|
-
* @summary Close the email thread
|
|
24
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
39
25
|
* @param {string} code
|
|
40
26
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
41
27
|
* @param {*} [options] Override http request option.
|
|
@@ -43,8 +29,7 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
43
29
|
*/
|
|
44
30
|
closeThread: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
31
|
/**
|
|
46
|
-
*
|
|
47
|
-
* @summary Retrieve the email thread
|
|
32
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
48
33
|
* @param {string} code
|
|
49
34
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
50
35
|
* @param {*} [options] Override http request option.
|
|
@@ -52,42 +37,33 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
52
37
|
*/
|
|
53
38
|
getThread: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
39
|
/**
|
|
55
|
-
*
|
|
40
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
56
41
|
* @summary List email messages
|
|
57
42
|
* @param {string} code
|
|
58
43
|
* @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,
|
|
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,
|
|
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,
|
|
44
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
45
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
46
|
+
* @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>
|
|
62
47
|
* @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
48
|
* @param {*} [options] Override http request option.
|
|
64
49
|
* @throws {RequiredError}
|
|
65
50
|
*/
|
|
66
51
|
listMessages: (code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
52
|
/**
|
|
68
|
-
*
|
|
53
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
69
54
|
* @summary List email threads
|
|
70
55
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
71
56
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
72
57
|
* @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,
|
|
58
|
+
* @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, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
74
59
|
* @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,
|
|
60
|
+
* @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>
|
|
76
61
|
* @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,
|
|
62
|
+
* @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, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
78
63
|
* @param {*} [options] Override http request option.
|
|
79
64
|
* @throws {RequiredError}
|
|
80
65
|
*/
|
|
81
66
|
listThreads: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
82
|
-
/**
|
|
83
|
-
* Removes the entity link from the email thread and every message in it, and marks the messages as unassigned. **Required Permissions** \"notification-management.email-messages.update\"
|
|
84
|
-
* @summary Unassign an email thread from its entity
|
|
85
|
-
* @param {string} code
|
|
86
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
87
|
-
* @param {*} [options] Override http request option.
|
|
88
|
-
* @throws {RequiredError}
|
|
89
|
-
*/
|
|
90
|
-
unassignEntity: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
91
67
|
};
|
|
92
68
|
/**
|
|
93
69
|
* EmailTrackingApi - functional programming interface
|
|
@@ -95,18 +71,7 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
95
71
|
*/
|
|
96
72
|
export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
|
|
97
73
|
/**
|
|
98
|
-
*
|
|
99
|
-
* @summary Assign an email thread to an entity
|
|
100
|
-
* @param {string} code
|
|
101
|
-
* @param {AssignEmailThreadEntityBodyDto} assignEmailThreadEntityBodyDto
|
|
102
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
103
|
-
* @param {*} [options] Override http request option.
|
|
104
|
-
* @throws {RequiredError}
|
|
105
|
-
*/
|
|
106
|
-
assignEntity(code: string, assignEmailThreadEntityBodyDto: AssignEmailThreadEntityBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AssignEmailThreadEntityResponseClass>>;
|
|
107
|
-
/**
|
|
108
|
-
* Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
109
|
-
* @summary Close the email thread
|
|
74
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
110
75
|
* @param {string} code
|
|
111
76
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
112
77
|
* @param {*} [options] Override http request option.
|
|
@@ -114,8 +79,7 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
|
|
|
114
79
|
*/
|
|
115
80
|
closeThread(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailThreadResponseClass>>;
|
|
116
81
|
/**
|
|
117
|
-
*
|
|
118
|
-
* @summary Retrieve the email thread
|
|
82
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
119
83
|
* @param {string} code
|
|
120
84
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
121
85
|
* @param {*} [options] Override http request option.
|
|
@@ -123,42 +87,33 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
|
|
|
123
87
|
*/
|
|
124
88
|
getThread(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailThreadResponseClass>>;
|
|
125
89
|
/**
|
|
126
|
-
*
|
|
90
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
127
91
|
* @summary List email messages
|
|
128
92
|
* @param {string} code
|
|
129
93
|
* @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,
|
|
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,
|
|
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,
|
|
94
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
95
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
96
|
+
* @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>
|
|
133
97
|
* @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
98
|
* @param {*} [options] Override http request option.
|
|
135
99
|
* @throws {RequiredError}
|
|
136
100
|
*/
|
|
137
101
|
listMessages(code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>>;
|
|
138
102
|
/**
|
|
139
|
-
*
|
|
103
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
140
104
|
* @summary List email threads
|
|
141
105
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
142
106
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
143
107
|
* @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,
|
|
108
|
+
* @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, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
145
109
|
* @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,
|
|
110
|
+
* @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>
|
|
147
111
|
* @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,
|
|
112
|
+
* @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, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
149
113
|
* @param {*} [options] Override http request option.
|
|
150
114
|
* @throws {RequiredError}
|
|
151
115
|
*/
|
|
152
116
|
listThreads(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailThreadsResponseClass>>;
|
|
153
|
-
/**
|
|
154
|
-
* Removes the entity link from the email thread and every message in it, and marks the messages as unassigned. **Required Permissions** \"notification-management.email-messages.update\"
|
|
155
|
-
* @summary Unassign an email thread from its entity
|
|
156
|
-
* @param {string} code
|
|
157
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
158
|
-
* @param {*} [options] Override http request option.
|
|
159
|
-
* @throws {RequiredError}
|
|
160
|
-
*/
|
|
161
|
-
unassignEntity(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UnassignEmailThreadEntityResponseClass>>;
|
|
162
117
|
};
|
|
163
118
|
/**
|
|
164
119
|
* EmailTrackingApi - factory interface
|
|
@@ -166,18 +121,7 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
|
|
|
166
121
|
*/
|
|
167
122
|
export declare const EmailTrackingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
168
123
|
/**
|
|
169
|
-
*
|
|
170
|
-
* @summary Assign an email thread to an entity
|
|
171
|
-
* @param {string} code
|
|
172
|
-
* @param {AssignEmailThreadEntityBodyDto} assignEmailThreadEntityBodyDto
|
|
173
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
174
|
-
* @param {*} [options] Override http request option.
|
|
175
|
-
* @throws {RequiredError}
|
|
176
|
-
*/
|
|
177
|
-
assignEntity(code: string, assignEmailThreadEntityBodyDto: AssignEmailThreadEntityBodyDto, authorization?: string, options?: any): AxiosPromise<AssignEmailThreadEntityResponseClass>;
|
|
178
|
-
/**
|
|
179
|
-
* Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
180
|
-
* @summary Close the email thread
|
|
124
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
181
125
|
* @param {string} code
|
|
182
126
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
183
127
|
* @param {*} [options] Override http request option.
|
|
@@ -185,8 +129,7 @@ export declare const EmailTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
185
129
|
*/
|
|
186
130
|
closeThread(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailThreadResponseClass>;
|
|
187
131
|
/**
|
|
188
|
-
*
|
|
189
|
-
* @summary Retrieve the email thread
|
|
132
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
190
133
|
* @param {string} code
|
|
191
134
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
192
135
|
* @param {*} [options] Override http request option.
|
|
@@ -194,68 +137,34 @@ export declare const EmailTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
194
137
|
*/
|
|
195
138
|
getThread(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailThreadResponseClass>;
|
|
196
139
|
/**
|
|
197
|
-
*
|
|
140
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
198
141
|
* @summary List email messages
|
|
199
142
|
* @param {string} code
|
|
200
143
|
* @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,
|
|
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,
|
|
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,
|
|
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, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
145
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
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, threadCode, direction, deliveryStatus, fromAddress, subject, sentAt, receivedAt, createdAt, updatedAt</i>
|
|
204
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: attachments<i>
|
|
205
148
|
* @param {*} [options] Override http request option.
|
|
206
149
|
* @throws {RequiredError}
|
|
207
150
|
*/
|
|
208
151
|
listMessages(code: string, authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass>;
|
|
209
152
|
/**
|
|
210
|
-
*
|
|
153
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
211
154
|
* @summary List email threads
|
|
212
155
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
213
156
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
214
157
|
* @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,
|
|
158
|
+
* @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, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
216
159
|
* @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,
|
|
160
|
+
* @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>
|
|
218
161
|
* @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,
|
|
162
|
+
* @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, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
220
163
|
* @param {*} [options] Override http request option.
|
|
221
164
|
* @throws {RequiredError}
|
|
222
165
|
*/
|
|
223
166
|
listThreads(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailThreadsResponseClass>;
|
|
224
|
-
/**
|
|
225
|
-
* Removes the entity link from the email thread and every message in it, and marks the messages as unassigned. **Required Permissions** \"notification-management.email-messages.update\"
|
|
226
|
-
* @summary Unassign an email thread from its entity
|
|
227
|
-
* @param {string} code
|
|
228
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
229
|
-
* @param {*} [options] Override http request option.
|
|
230
|
-
* @throws {RequiredError}
|
|
231
|
-
*/
|
|
232
|
-
unassignEntity(code: string, authorization?: string, options?: any): AxiosPromise<UnassignEmailThreadEntityResponseClass>;
|
|
233
167
|
};
|
|
234
|
-
/**
|
|
235
|
-
* Request parameters for assignEntity operation in EmailTrackingApi.
|
|
236
|
-
* @export
|
|
237
|
-
* @interface EmailTrackingApiAssignEntityRequest
|
|
238
|
-
*/
|
|
239
|
-
export interface EmailTrackingApiAssignEntityRequest {
|
|
240
|
-
/**
|
|
241
|
-
*
|
|
242
|
-
* @type {string}
|
|
243
|
-
* @memberof EmailTrackingApiAssignEntity
|
|
244
|
-
*/
|
|
245
|
-
readonly code: string;
|
|
246
|
-
/**
|
|
247
|
-
*
|
|
248
|
-
* @type {AssignEmailThreadEntityBodyDto}
|
|
249
|
-
* @memberof EmailTrackingApiAssignEntity
|
|
250
|
-
*/
|
|
251
|
-
readonly assignEmailThreadEntityBodyDto: AssignEmailThreadEntityBodyDto;
|
|
252
|
-
/**
|
|
253
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
254
|
-
* @type {string}
|
|
255
|
-
* @memberof EmailTrackingApiAssignEntity
|
|
256
|
-
*/
|
|
257
|
-
readonly authorization?: string;
|
|
258
|
-
}
|
|
259
168
|
/**
|
|
260
169
|
* Request parameters for closeThread operation in EmailTrackingApi.
|
|
261
170
|
* @export
|
|
@@ -313,19 +222,19 @@ export interface EmailTrackingApiListMessagesRequest {
|
|
|
313
222
|
*/
|
|
314
223
|
readonly authorization?: string;
|
|
315
224
|
/**
|
|
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,
|
|
225
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
317
226
|
* @type {string}
|
|
318
227
|
* @memberof EmailTrackingApiListMessages
|
|
319
228
|
*/
|
|
320
229
|
readonly filter?: string;
|
|
321
230
|
/**
|
|
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,
|
|
231
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
323
232
|
* @type {string}
|
|
324
233
|
* @memberof EmailTrackingApiListMessages
|
|
325
234
|
*/
|
|
326
235
|
readonly filters?: string;
|
|
327
236
|
/**
|
|
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,
|
|
237
|
+
* 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>
|
|
329
238
|
* @type {string}
|
|
330
239
|
* @memberof EmailTrackingApiListMessages
|
|
331
240
|
*/
|
|
@@ -362,7 +271,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
362
271
|
*/
|
|
363
272
|
readonly pageToken?: string;
|
|
364
273
|
/**
|
|
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,
|
|
274
|
+
* 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, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
366
275
|
* @type {string}
|
|
367
276
|
* @memberof EmailTrackingApiListThreads
|
|
368
277
|
*/
|
|
@@ -374,7 +283,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
374
283
|
*/
|
|
375
284
|
readonly search?: string;
|
|
376
285
|
/**
|
|
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,
|
|
286
|
+
* 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>
|
|
378
287
|
* @type {string}
|
|
379
288
|
* @memberof EmailTrackingApiListThreads
|
|
380
289
|
*/
|
|
@@ -386,31 +295,12 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
386
295
|
*/
|
|
387
296
|
readonly expand?: string;
|
|
388
297
|
/**
|
|
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,
|
|
298
|
+
* 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, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
390
299
|
* @type {string}
|
|
391
300
|
* @memberof EmailTrackingApiListThreads
|
|
392
301
|
*/
|
|
393
302
|
readonly filters?: string;
|
|
394
303
|
}
|
|
395
|
-
/**
|
|
396
|
-
* Request parameters for unassignEntity operation in EmailTrackingApi.
|
|
397
|
-
* @export
|
|
398
|
-
* @interface EmailTrackingApiUnassignEntityRequest
|
|
399
|
-
*/
|
|
400
|
-
export interface EmailTrackingApiUnassignEntityRequest {
|
|
401
|
-
/**
|
|
402
|
-
*
|
|
403
|
-
* @type {string}
|
|
404
|
-
* @memberof EmailTrackingApiUnassignEntity
|
|
405
|
-
*/
|
|
406
|
-
readonly code: string;
|
|
407
|
-
/**
|
|
408
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
409
|
-
* @type {string}
|
|
410
|
-
* @memberof EmailTrackingApiUnassignEntity
|
|
411
|
-
*/
|
|
412
|
-
readonly authorization?: string;
|
|
413
|
-
}
|
|
414
304
|
/**
|
|
415
305
|
* EmailTrackingApi - object-oriented interface
|
|
416
306
|
* @export
|
|
@@ -419,17 +309,7 @@ export interface EmailTrackingApiUnassignEntityRequest {
|
|
|
419
309
|
*/
|
|
420
310
|
export declare class EmailTrackingApi extends BaseAPI {
|
|
421
311
|
/**
|
|
422
|
-
*
|
|
423
|
-
* @summary Assign an email thread to an entity
|
|
424
|
-
* @param {EmailTrackingApiAssignEntityRequest} requestParameters Request parameters.
|
|
425
|
-
* @param {*} [options] Override http request option.
|
|
426
|
-
* @throws {RequiredError}
|
|
427
|
-
* @memberof EmailTrackingApi
|
|
428
|
-
*/
|
|
429
|
-
assignEntity(requestParameters: EmailTrackingApiAssignEntityRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AssignEmailThreadEntityResponseClass, any, {}>>;
|
|
430
|
-
/**
|
|
431
|
-
* Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
432
|
-
* @summary Close the email thread
|
|
312
|
+
* undefined **Required Permissions** \"notification-management.email-messages.update\"
|
|
433
313
|
* @param {EmailTrackingApiCloseThreadRequest} requestParameters Request parameters.
|
|
434
314
|
* @param {*} [options] Override http request option.
|
|
435
315
|
* @throws {RequiredError}
|
|
@@ -437,8 +317,7 @@ export declare class EmailTrackingApi extends BaseAPI {
|
|
|
437
317
|
*/
|
|
438
318
|
closeThread(requestParameters: EmailTrackingApiCloseThreadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailThreadResponseClass, any, {}>>;
|
|
439
319
|
/**
|
|
440
|
-
*
|
|
441
|
-
* @summary Retrieve the email thread
|
|
320
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
442
321
|
* @param {EmailTrackingApiGetThreadRequest} requestParameters Request parameters.
|
|
443
322
|
* @param {*} [options] Override http request option.
|
|
444
323
|
* @throws {RequiredError}
|
|
@@ -446,7 +325,7 @@ export declare class EmailTrackingApi extends BaseAPI {
|
|
|
446
325
|
*/
|
|
447
326
|
getThread(requestParameters: EmailTrackingApiGetThreadRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailThreadResponseClass, any, {}>>;
|
|
448
327
|
/**
|
|
449
|
-
*
|
|
328
|
+
* Lists all email messages for a thread **Required Permissions** \"notification-management.email-messages.view\"
|
|
450
329
|
* @summary List email messages
|
|
451
330
|
* @param {EmailTrackingApiListMessagesRequest} requestParameters Request parameters.
|
|
452
331
|
* @param {*} [options] Override http request option.
|
|
@@ -455,7 +334,7 @@ export declare class EmailTrackingApi extends BaseAPI {
|
|
|
455
334
|
*/
|
|
456
335
|
listMessages(requestParameters: EmailTrackingApiListMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailMessagesResponseClass, any, {}>>;
|
|
457
336
|
/**
|
|
458
|
-
*
|
|
337
|
+
* Lists all email threads with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
459
338
|
* @summary List email threads
|
|
460
339
|
* @param {EmailTrackingApiListThreadsRequest} requestParameters Request parameters.
|
|
461
340
|
* @param {*} [options] Override http request option.
|
|
@@ -463,13 +342,4 @@ export declare class EmailTrackingApi extends BaseAPI {
|
|
|
463
342
|
* @memberof EmailTrackingApi
|
|
464
343
|
*/
|
|
465
344
|
listThreads(requestParameters?: EmailTrackingApiListThreadsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailThreadsResponseClass, any, {}>>;
|
|
466
|
-
/**
|
|
467
|
-
* Removes the entity link from the email thread and every message in it, and marks the messages as unassigned. **Required Permissions** \"notification-management.email-messages.update\"
|
|
468
|
-
* @summary Unassign an email thread from its entity
|
|
469
|
-
* @param {EmailTrackingApiUnassignEntityRequest} requestParameters Request parameters.
|
|
470
|
-
* @param {*} [options] Override http request option.
|
|
471
|
-
* @throws {RequiredError}
|
|
472
|
-
* @memberof EmailTrackingApi
|
|
473
|
-
*/
|
|
474
|
-
unassignEntity(requestParameters: EmailTrackingApiUnassignEntityRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UnassignEmailThreadEntityResponseClass, any, {}>>;
|
|
475
345
|
}
|