@emilgroup/notification-sdk 0.8.1-beta.38 → 0.8.1-beta.4
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 -8
- package/README.md +2 -2
- package/api/email-messages-api.ts +24 -259
- package/api/email-tracking-api.ts +24 -32
- 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 -2
- package/dist/api/email-messages-api.d.ts +24 -158
- package/dist/api/email-messages-api.js +22 -225
- package/dist/api/email-tracking-api.d.ts +24 -32
- package/dist/api/email-tracking-api.js +22 -30
- 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 -1
- package/dist/api.js +0 -1
- package/dist/models/email-message-class.d.ts +2 -49
- package/dist/models/email-message-class.js +2 -16
- package/dist/models/index.d.ts +0 -7
- package/dist/models/index.js +0 -7
- package/dist/models/send-notification-request-dto.d.ts +0 -9
- package/dist/models/send-notification-request-dto.js +1 -2
- package/models/email-message-class.ts +3 -53
- package/models/index.ts +0 -7
- package/models/send-notification-request-dto.ts +1 -8
- package/package.json +1 -1
- package/api/msgraph-webhooks-api.ts +0 -278
- package/dist/api/msgraph-webhooks-api.d.ts +0 -168
- package/dist/api/msgraph-webhooks-api.js +0 -305
- package/dist/models/assign-email-message-entity-body-dto.d.ts +0 -43
- package/dist/models/assign-email-message-entity-body-dto.js +0 -22
- package/dist/models/assign-email-message-entity-response-class.d.ts +0 -25
- package/dist/models/assign-email-message-entity-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/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-message-entity-response-class.d.ts +0 -25
- package/dist/models/unassign-email-message-entity-response-class.js +0 -15
- package/models/assign-email-message-entity-body-dto.ts +0 -52
- package/models/assign-email-message-entity-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/send-email-request-dto.ts +0 -138
- package/models/send-email-response-class.ts +0 -30
- package/models/unassign-email-message-entity-response-class.ts +0 -31
|
@@ -12,31 +12,17 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
-
import { AssignEmailMessageEntityBodyDto } from '../models';
|
|
16
|
-
import { AssignEmailMessageEntityResponseClass } from '../models';
|
|
17
15
|
import { DownloadAttachmentResponseClass } from '../models';
|
|
18
16
|
import { GetEmailMessageResponseClass } from '../models';
|
|
19
17
|
import { ListEmailAttachmentsResponseClass } from '../models';
|
|
20
18
|
import { ListEmailMessagesResponseClass } from '../models';
|
|
21
|
-
import { UnassignEmailMessageEntityResponseClass } from '../models';
|
|
22
19
|
/**
|
|
23
20
|
* EmailMessagesApi - axios parameter creator
|
|
24
21
|
* @export
|
|
25
22
|
*/
|
|
26
23
|
export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
27
24
|
/**
|
|
28
|
-
*
|
|
29
|
-
* @summary Assign an email message to an entity
|
|
30
|
-
* @param {string} code
|
|
31
|
-
* @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
|
|
32
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
33
|
-
* @param {*} [options] Override http request option.
|
|
34
|
-
* @throws {RequiredError}
|
|
35
|
-
*/
|
|
36
|
-
assignEntity: (code: string, assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
|
-
/**
|
|
38
|
-
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
39
|
-
* @summary Download the email message attachment
|
|
25
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
40
26
|
* @param {string} code
|
|
41
27
|
* @param {number} attachmentId
|
|
42
28
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -45,8 +31,7 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
45
31
|
*/
|
|
46
32
|
downloadAttachment: (code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
33
|
/**
|
|
48
|
-
*
|
|
49
|
-
* @summary Retrieve the email message
|
|
34
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
50
35
|
* @param {string} code
|
|
51
36
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
52
37
|
* @param {*} [options] Override http request option.
|
|
@@ -54,8 +39,7 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
54
39
|
*/
|
|
55
40
|
getMessage: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
41
|
/**
|
|
57
|
-
*
|
|
58
|
-
* @summary List the email message attachments
|
|
42
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
59
43
|
* @param {string} code
|
|
60
44
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
61
45
|
* @param {*} [options] Override http request option.
|
|
@@ -63,29 +47,20 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
63
47
|
*/
|
|
64
48
|
listAttachments: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
49
|
/**
|
|
66
|
-
*
|
|
50
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
67
51
|
* @summary List email messages
|
|
68
52
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
69
53
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
70
54
|
* @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.
|
|
71
|
-
* @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,
|
|
55
|
+
* @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>
|
|
72
56
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
73
57
|
* @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>
|
|
74
58
|
* @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>
|
|
75
|
-
* @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,
|
|
59
|
+
* @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>
|
|
76
60
|
* @param {*} [options] Override http request option.
|
|
77
61
|
* @throws {RequiredError}
|
|
78
62
|
*/
|
|
79
63
|
listEmailMessages: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
80
|
-
/**
|
|
81
|
-
* Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
82
|
-
* @summary Unassign an email message from its entity
|
|
83
|
-
* @param {string} code
|
|
84
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
85
|
-
* @param {*} [options] Override http request option.
|
|
86
|
-
* @throws {RequiredError}
|
|
87
|
-
*/
|
|
88
|
-
unassignEntity: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
89
64
|
};
|
|
90
65
|
/**
|
|
91
66
|
* EmailMessagesApi - functional programming interface
|
|
@@ -93,18 +68,7 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
93
68
|
*/
|
|
94
69
|
export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
95
70
|
/**
|
|
96
|
-
*
|
|
97
|
-
* @summary Assign an email message to an entity
|
|
98
|
-
* @param {string} code
|
|
99
|
-
* @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
|
|
100
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
101
|
-
* @param {*} [options] Override http request option.
|
|
102
|
-
* @throws {RequiredError}
|
|
103
|
-
*/
|
|
104
|
-
assignEntity(code: string, assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AssignEmailMessageEntityResponseClass>>;
|
|
105
|
-
/**
|
|
106
|
-
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
107
|
-
* @summary Download the email message attachment
|
|
71
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
108
72
|
* @param {string} code
|
|
109
73
|
* @param {number} attachmentId
|
|
110
74
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -113,8 +77,7 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
113
77
|
*/
|
|
114
78
|
downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DownloadAttachmentResponseClass>>;
|
|
115
79
|
/**
|
|
116
|
-
*
|
|
117
|
-
* @summary Retrieve the email message
|
|
80
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
118
81
|
* @param {string} code
|
|
119
82
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
120
83
|
* @param {*} [options] Override http request option.
|
|
@@ -122,8 +85,7 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
122
85
|
*/
|
|
123
86
|
getMessage(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailMessageResponseClass>>;
|
|
124
87
|
/**
|
|
125
|
-
*
|
|
126
|
-
* @summary List the email message attachments
|
|
88
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
127
89
|
* @param {string} code
|
|
128
90
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
129
91
|
* @param {*} [options] Override http request option.
|
|
@@ -131,29 +93,20 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
131
93
|
*/
|
|
132
94
|
listAttachments(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailAttachmentsResponseClass>>;
|
|
133
95
|
/**
|
|
134
|
-
*
|
|
96
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
135
97
|
* @summary List email messages
|
|
136
98
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
137
99
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
138
100
|
* @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.
|
|
139
|
-
* @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,
|
|
101
|
+
* @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>
|
|
140
102
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
141
103
|
* @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>
|
|
142
104
|
* @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>
|
|
143
|
-
* @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,
|
|
105
|
+
* @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>
|
|
144
106
|
* @param {*} [options] Override http request option.
|
|
145
107
|
* @throws {RequiredError}
|
|
146
108
|
*/
|
|
147
109
|
listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailMessagesResponseClass>>;
|
|
148
|
-
/**
|
|
149
|
-
* Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
150
|
-
* @summary Unassign an email message from its entity
|
|
151
|
-
* @param {string} code
|
|
152
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
153
|
-
* @param {*} [options] Override http request option.
|
|
154
|
-
* @throws {RequiredError}
|
|
155
|
-
*/
|
|
156
|
-
unassignEntity(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UnassignEmailMessageEntityResponseClass>>;
|
|
157
110
|
};
|
|
158
111
|
/**
|
|
159
112
|
* EmailMessagesApi - factory interface
|
|
@@ -161,18 +114,7 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
161
114
|
*/
|
|
162
115
|
export declare const EmailMessagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
163
116
|
/**
|
|
164
|
-
*
|
|
165
|
-
* @summary Assign an email message to an entity
|
|
166
|
-
* @param {string} code
|
|
167
|
-
* @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
|
|
168
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
169
|
-
* @param {*} [options] Override http request option.
|
|
170
|
-
* @throws {RequiredError}
|
|
171
|
-
*/
|
|
172
|
-
assignEntity(code: string, assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto, authorization?: string, options?: any): AxiosPromise<AssignEmailMessageEntityResponseClass>;
|
|
173
|
-
/**
|
|
174
|
-
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
175
|
-
* @summary Download the email message attachment
|
|
117
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
176
118
|
* @param {string} code
|
|
177
119
|
* @param {number} attachmentId
|
|
178
120
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -181,8 +123,7 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
181
123
|
*/
|
|
182
124
|
downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: any): AxiosPromise<DownloadAttachmentResponseClass>;
|
|
183
125
|
/**
|
|
184
|
-
*
|
|
185
|
-
* @summary Retrieve the email message
|
|
126
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
186
127
|
* @param {string} code
|
|
187
128
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
188
129
|
* @param {*} [options] Override http request option.
|
|
@@ -190,8 +131,7 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
190
131
|
*/
|
|
191
132
|
getMessage(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailMessageResponseClass>;
|
|
192
133
|
/**
|
|
193
|
-
*
|
|
194
|
-
* @summary List the email message attachments
|
|
134
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
195
135
|
* @param {string} code
|
|
196
136
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
197
137
|
* @param {*} [options] Override http request option.
|
|
@@ -199,55 +139,21 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
199
139
|
*/
|
|
200
140
|
listAttachments(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailAttachmentsResponseClass>;
|
|
201
141
|
/**
|
|
202
|
-
*
|
|
142
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
203
143
|
* @summary List email messages
|
|
204
144
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
205
145
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
206
146
|
* @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.
|
|
207
|
-
* @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,
|
|
147
|
+
* @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>
|
|
208
148
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
209
149
|
* @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>
|
|
210
150
|
* @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>
|
|
211
|
-
* @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,
|
|
151
|
+
* @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>
|
|
212
152
|
* @param {*} [options] Override http request option.
|
|
213
153
|
* @throws {RequiredError}
|
|
214
154
|
*/
|
|
215
155
|
listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass>;
|
|
216
|
-
/**
|
|
217
|
-
* Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
218
|
-
* @summary Unassign an email message from its entity
|
|
219
|
-
* @param {string} code
|
|
220
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
221
|
-
* @param {*} [options] Override http request option.
|
|
222
|
-
* @throws {RequiredError}
|
|
223
|
-
*/
|
|
224
|
-
unassignEntity(code: string, authorization?: string, options?: any): AxiosPromise<UnassignEmailMessageEntityResponseClass>;
|
|
225
156
|
};
|
|
226
|
-
/**
|
|
227
|
-
* Request parameters for assignEntity operation in EmailMessagesApi.
|
|
228
|
-
* @export
|
|
229
|
-
* @interface EmailMessagesApiAssignEntityRequest
|
|
230
|
-
*/
|
|
231
|
-
export interface EmailMessagesApiAssignEntityRequest {
|
|
232
|
-
/**
|
|
233
|
-
*
|
|
234
|
-
* @type {string}
|
|
235
|
-
* @memberof EmailMessagesApiAssignEntity
|
|
236
|
-
*/
|
|
237
|
-
readonly code: string;
|
|
238
|
-
/**
|
|
239
|
-
*
|
|
240
|
-
* @type {AssignEmailMessageEntityBodyDto}
|
|
241
|
-
* @memberof EmailMessagesApiAssignEntity
|
|
242
|
-
*/
|
|
243
|
-
readonly assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto;
|
|
244
|
-
/**
|
|
245
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
246
|
-
* @type {string}
|
|
247
|
-
* @memberof EmailMessagesApiAssignEntity
|
|
248
|
-
*/
|
|
249
|
-
readonly authorization?: string;
|
|
250
|
-
}
|
|
251
157
|
/**
|
|
252
158
|
* Request parameters for downloadAttachment operation in EmailMessagesApi.
|
|
253
159
|
* @export
|
|
@@ -336,7 +242,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
336
242
|
*/
|
|
337
243
|
readonly pageToken?: string;
|
|
338
244
|
/**
|
|
339
|
-
* 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,
|
|
245
|
+
* 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>
|
|
340
246
|
* @type {string}
|
|
341
247
|
* @memberof EmailMessagesApiListEmailMessages
|
|
342
248
|
*/
|
|
@@ -360,31 +266,12 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
360
266
|
*/
|
|
361
267
|
readonly expand?: string;
|
|
362
268
|
/**
|
|
363
|
-
* 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,
|
|
269
|
+
* 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>
|
|
364
270
|
* @type {string}
|
|
365
271
|
* @memberof EmailMessagesApiListEmailMessages
|
|
366
272
|
*/
|
|
367
273
|
readonly filters?: string;
|
|
368
274
|
}
|
|
369
|
-
/**
|
|
370
|
-
* Request parameters for unassignEntity operation in EmailMessagesApi.
|
|
371
|
-
* @export
|
|
372
|
-
* @interface EmailMessagesApiUnassignEntityRequest
|
|
373
|
-
*/
|
|
374
|
-
export interface EmailMessagesApiUnassignEntityRequest {
|
|
375
|
-
/**
|
|
376
|
-
*
|
|
377
|
-
* @type {string}
|
|
378
|
-
* @memberof EmailMessagesApiUnassignEntity
|
|
379
|
-
*/
|
|
380
|
-
readonly code: string;
|
|
381
|
-
/**
|
|
382
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
383
|
-
* @type {string}
|
|
384
|
-
* @memberof EmailMessagesApiUnassignEntity
|
|
385
|
-
*/
|
|
386
|
-
readonly authorization?: string;
|
|
387
|
-
}
|
|
388
275
|
/**
|
|
389
276
|
* EmailMessagesApi - object-oriented interface
|
|
390
277
|
* @export
|
|
@@ -393,17 +280,7 @@ export interface EmailMessagesApiUnassignEntityRequest {
|
|
|
393
280
|
*/
|
|
394
281
|
export declare class EmailMessagesApi extends BaseAPI {
|
|
395
282
|
/**
|
|
396
|
-
*
|
|
397
|
-
* @summary Assign an email message to an entity
|
|
398
|
-
* @param {EmailMessagesApiAssignEntityRequest} requestParameters Request parameters.
|
|
399
|
-
* @param {*} [options] Override http request option.
|
|
400
|
-
* @throws {RequiredError}
|
|
401
|
-
* @memberof EmailMessagesApi
|
|
402
|
-
*/
|
|
403
|
-
assignEntity(requestParameters: EmailMessagesApiAssignEntityRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AssignEmailMessageEntityResponseClass, any, {}>>;
|
|
404
|
-
/**
|
|
405
|
-
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
406
|
-
* @summary Download the email message attachment
|
|
283
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
407
284
|
* @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
|
|
408
285
|
* @param {*} [options] Override http request option.
|
|
409
286
|
* @throws {RequiredError}
|
|
@@ -411,8 +288,7 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
411
288
|
*/
|
|
412
289
|
downloadAttachment(requestParameters: EmailMessagesApiDownloadAttachmentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DownloadAttachmentResponseClass, any, {}>>;
|
|
413
290
|
/**
|
|
414
|
-
*
|
|
415
|
-
* @summary Retrieve the email message
|
|
291
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
416
292
|
* @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
|
|
417
293
|
* @param {*} [options] Override http request option.
|
|
418
294
|
* @throws {RequiredError}
|
|
@@ -420,8 +296,7 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
420
296
|
*/
|
|
421
297
|
getMessage(requestParameters: EmailMessagesApiGetMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailMessageResponseClass, any, {}>>;
|
|
422
298
|
/**
|
|
423
|
-
*
|
|
424
|
-
* @summary List the email message attachments
|
|
299
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
425
300
|
* @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
|
|
426
301
|
* @param {*} [options] Override http request option.
|
|
427
302
|
* @throws {RequiredError}
|
|
@@ -429,7 +304,7 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
429
304
|
*/
|
|
430
305
|
listAttachments(requestParameters: EmailMessagesApiListAttachmentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailAttachmentsResponseClass, any, {}>>;
|
|
431
306
|
/**
|
|
432
|
-
*
|
|
307
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
433
308
|
* @summary List email messages
|
|
434
309
|
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
435
310
|
* @param {*} [options] Override http request option.
|
|
@@ -437,13 +312,4 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
437
312
|
* @memberof EmailMessagesApi
|
|
438
313
|
*/
|
|
439
314
|
listEmailMessages(requestParameters?: EmailMessagesApiListEmailMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailMessagesResponseClass, any, {}>>;
|
|
440
|
-
/**
|
|
441
|
-
* Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
442
|
-
* @summary Unassign an email message from its entity
|
|
443
|
-
* @param {EmailMessagesApiUnassignEntityRequest} requestParameters Request parameters.
|
|
444
|
-
* @param {*} [options] Override http request option.
|
|
445
|
-
* @throws {RequiredError}
|
|
446
|
-
* @memberof EmailMessagesApi
|
|
447
|
-
*/
|
|
448
|
-
unassignEntity(requestParameters: EmailMessagesApiUnassignEntityRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UnassignEmailMessageEntityResponseClass, any, {}>>;
|
|
449
315
|
}
|