@emilgroup/notification-sdk 0.8.1-beta.29 → 0.8.1-beta.30
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 -7
- package/README.md +2 -2
- package/api/email-messages-api.ts +24 -156
- 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 -102
- package/dist/api/email-messages-api.js +22 -133
- 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 -6
- package/dist/models/index.js +0 -6
- package/dist/models/send-notification-request-dto.d.ts +0 -1
- package/dist/models/send-notification-request-dto.js +1 -2
- package/models/email-message-class.ts +3 -53
- package/models/index.ts +0 -6
- package/models/send-notification-request-dto.ts +1 -2
- 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/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
|
@@ -12,8 +12,6 @@
|
|
|
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';
|
|
@@ -24,18 +22,7 @@ import { ListEmailMessagesResponseClass } from '../models';
|
|
|
24
22
|
*/
|
|
25
23
|
export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
24
|
/**
|
|
27
|
-
*
|
|
28
|
-
* @summary Assign an email message to an entity
|
|
29
|
-
* @param {string} code
|
|
30
|
-
* @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
|
|
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, assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36
|
-
/**
|
|
37
|
-
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
38
|
-
* @summary Download the email message attachment
|
|
25
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
39
26
|
* @param {string} code
|
|
40
27
|
* @param {number} attachmentId
|
|
41
28
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -44,8 +31,7 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
44
31
|
*/
|
|
45
32
|
downloadAttachment: (code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
33
|
/**
|
|
47
|
-
*
|
|
48
|
-
* @summary Retrieve the email message
|
|
34
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
49
35
|
* @param {string} code
|
|
50
36
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
51
37
|
* @param {*} [options] Override http request option.
|
|
@@ -53,8 +39,7 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
53
39
|
*/
|
|
54
40
|
getMessage: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
41
|
/**
|
|
56
|
-
*
|
|
57
|
-
* @summary List the email message attachments
|
|
42
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
58
43
|
* @param {string} code
|
|
59
44
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
60
45
|
* @param {*} [options] Override http request option.
|
|
@@ -62,16 +47,16 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
62
47
|
*/
|
|
63
48
|
listAttachments: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
49
|
/**
|
|
65
|
-
*
|
|
50
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
66
51
|
* @summary List email messages
|
|
67
52
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
68
53
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
69
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.
|
|
70
|
-
* @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>
|
|
71
56
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
72
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>
|
|
73
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>
|
|
74
|
-
* @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>
|
|
75
60
|
* @param {*} [options] Override http request option.
|
|
76
61
|
* @throws {RequiredError}
|
|
77
62
|
*/
|
|
@@ -83,18 +68,7 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
83
68
|
*/
|
|
84
69
|
export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
85
70
|
/**
|
|
86
|
-
*
|
|
87
|
-
* @summary Assign an email message to an entity
|
|
88
|
-
* @param {string} code
|
|
89
|
-
* @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
|
|
90
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
91
|
-
* @param {*} [options] Override http request option.
|
|
92
|
-
* @throws {RequiredError}
|
|
93
|
-
*/
|
|
94
|
-
assignEntity(code: string, assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AssignEmailMessageEntityResponseClass>>;
|
|
95
|
-
/**
|
|
96
|
-
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
97
|
-
* @summary Download the email message attachment
|
|
71
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
98
72
|
* @param {string} code
|
|
99
73
|
* @param {number} attachmentId
|
|
100
74
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -103,8 +77,7 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
103
77
|
*/
|
|
104
78
|
downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DownloadAttachmentResponseClass>>;
|
|
105
79
|
/**
|
|
106
|
-
*
|
|
107
|
-
* @summary Retrieve the email message
|
|
80
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
108
81
|
* @param {string} code
|
|
109
82
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
110
83
|
* @param {*} [options] Override http request option.
|
|
@@ -112,8 +85,7 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
112
85
|
*/
|
|
113
86
|
getMessage(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailMessageResponseClass>>;
|
|
114
87
|
/**
|
|
115
|
-
*
|
|
116
|
-
* @summary List the email message attachments
|
|
88
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
117
89
|
* @param {string} code
|
|
118
90
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
119
91
|
* @param {*} [options] Override http request option.
|
|
@@ -121,16 +93,16 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
121
93
|
*/
|
|
122
94
|
listAttachments(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailAttachmentsResponseClass>>;
|
|
123
95
|
/**
|
|
124
|
-
*
|
|
96
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
125
97
|
* @summary List email messages
|
|
126
98
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
127
99
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
128
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.
|
|
129
|
-
* @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>
|
|
130
102
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
131
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>
|
|
132
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>
|
|
133
|
-
* @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>
|
|
134
106
|
* @param {*} [options] Override http request option.
|
|
135
107
|
* @throws {RequiredError}
|
|
136
108
|
*/
|
|
@@ -142,18 +114,7 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
142
114
|
*/
|
|
143
115
|
export declare const EmailMessagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
144
116
|
/**
|
|
145
|
-
*
|
|
146
|
-
* @summary Assign an email message to an entity
|
|
147
|
-
* @param {string} code
|
|
148
|
-
* @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
|
|
149
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
150
|
-
* @param {*} [options] Override http request option.
|
|
151
|
-
* @throws {RequiredError}
|
|
152
|
-
*/
|
|
153
|
-
assignEntity(code: string, assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto, authorization?: string, options?: any): AxiosPromise<AssignEmailMessageEntityResponseClass>;
|
|
154
|
-
/**
|
|
155
|
-
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
156
|
-
* @summary Download the email message attachment
|
|
117
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
157
118
|
* @param {string} code
|
|
158
119
|
* @param {number} attachmentId
|
|
159
120
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -162,8 +123,7 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
162
123
|
*/
|
|
163
124
|
downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: any): AxiosPromise<DownloadAttachmentResponseClass>;
|
|
164
125
|
/**
|
|
165
|
-
*
|
|
166
|
-
* @summary Retrieve the email message
|
|
126
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
167
127
|
* @param {string} code
|
|
168
128
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
169
129
|
* @param {*} [options] Override http request option.
|
|
@@ -171,8 +131,7 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
171
131
|
*/
|
|
172
132
|
getMessage(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailMessageResponseClass>;
|
|
173
133
|
/**
|
|
174
|
-
*
|
|
175
|
-
* @summary List the email message attachments
|
|
134
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
176
135
|
* @param {string} code
|
|
177
136
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
178
137
|
* @param {*} [options] Override http request option.
|
|
@@ -180,46 +139,21 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
180
139
|
*/
|
|
181
140
|
listAttachments(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailAttachmentsResponseClass>;
|
|
182
141
|
/**
|
|
183
|
-
*
|
|
142
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
184
143
|
* @summary List email messages
|
|
185
144
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
186
145
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
187
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.
|
|
188
|
-
* @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>
|
|
189
148
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
190
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>
|
|
191
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>
|
|
192
|
-
* @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>
|
|
193
152
|
* @param {*} [options] Override http request option.
|
|
194
153
|
* @throws {RequiredError}
|
|
195
154
|
*/
|
|
196
155
|
listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass>;
|
|
197
156
|
};
|
|
198
|
-
/**
|
|
199
|
-
* Request parameters for assignEntity operation in EmailMessagesApi.
|
|
200
|
-
* @export
|
|
201
|
-
* @interface EmailMessagesApiAssignEntityRequest
|
|
202
|
-
*/
|
|
203
|
-
export interface EmailMessagesApiAssignEntityRequest {
|
|
204
|
-
/**
|
|
205
|
-
*
|
|
206
|
-
* @type {string}
|
|
207
|
-
* @memberof EmailMessagesApiAssignEntity
|
|
208
|
-
*/
|
|
209
|
-
readonly code: string;
|
|
210
|
-
/**
|
|
211
|
-
*
|
|
212
|
-
* @type {AssignEmailMessageEntityBodyDto}
|
|
213
|
-
* @memberof EmailMessagesApiAssignEntity
|
|
214
|
-
*/
|
|
215
|
-
readonly assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto;
|
|
216
|
-
/**
|
|
217
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
218
|
-
* @type {string}
|
|
219
|
-
* @memberof EmailMessagesApiAssignEntity
|
|
220
|
-
*/
|
|
221
|
-
readonly authorization?: string;
|
|
222
|
-
}
|
|
223
157
|
/**
|
|
224
158
|
* Request parameters for downloadAttachment operation in EmailMessagesApi.
|
|
225
159
|
* @export
|
|
@@ -308,7 +242,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
308
242
|
*/
|
|
309
243
|
readonly pageToken?: string;
|
|
310
244
|
/**
|
|
311
|
-
* 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>
|
|
312
246
|
* @type {string}
|
|
313
247
|
* @memberof EmailMessagesApiListEmailMessages
|
|
314
248
|
*/
|
|
@@ -332,7 +266,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
332
266
|
*/
|
|
333
267
|
readonly expand?: string;
|
|
334
268
|
/**
|
|
335
|
-
* 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>
|
|
336
270
|
* @type {string}
|
|
337
271
|
* @memberof EmailMessagesApiListEmailMessages
|
|
338
272
|
*/
|
|
@@ -346,17 +280,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
346
280
|
*/
|
|
347
281
|
export declare class EmailMessagesApi extends BaseAPI {
|
|
348
282
|
/**
|
|
349
|
-
*
|
|
350
|
-
* @summary Assign an email message to an entity
|
|
351
|
-
* @param {EmailMessagesApiAssignEntityRequest} requestParameters Request parameters.
|
|
352
|
-
* @param {*} [options] Override http request option.
|
|
353
|
-
* @throws {RequiredError}
|
|
354
|
-
* @memberof EmailMessagesApi
|
|
355
|
-
*/
|
|
356
|
-
assignEntity(requestParameters: EmailMessagesApiAssignEntityRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AssignEmailMessageEntityResponseClass, any, {}>>;
|
|
357
|
-
/**
|
|
358
|
-
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
359
|
-
* @summary Download the email message attachment
|
|
283
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
360
284
|
* @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
|
|
361
285
|
* @param {*} [options] Override http request option.
|
|
362
286
|
* @throws {RequiredError}
|
|
@@ -364,8 +288,7 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
364
288
|
*/
|
|
365
289
|
downloadAttachment(requestParameters: EmailMessagesApiDownloadAttachmentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DownloadAttachmentResponseClass, any, {}>>;
|
|
366
290
|
/**
|
|
367
|
-
*
|
|
368
|
-
* @summary Retrieve the email message
|
|
291
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
369
292
|
* @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
|
|
370
293
|
* @param {*} [options] Override http request option.
|
|
371
294
|
* @throws {RequiredError}
|
|
@@ -373,8 +296,7 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
373
296
|
*/
|
|
374
297
|
getMessage(requestParameters: EmailMessagesApiGetMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailMessageResponseClass, any, {}>>;
|
|
375
298
|
/**
|
|
376
|
-
*
|
|
377
|
-
* @summary List the email message attachments
|
|
299
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
378
300
|
* @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
|
|
379
301
|
* @param {*} [options] Override http request option.
|
|
380
302
|
* @throws {RequiredError}
|
|
@@ -382,7 +304,7 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
382
304
|
*/
|
|
383
305
|
listAttachments(requestParameters: EmailMessagesApiListAttachmentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailAttachmentsResponseClass, any, {}>>;
|
|
384
306
|
/**
|
|
385
|
-
*
|
|
307
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
386
308
|
* @summary List email messages
|
|
387
309
|
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
388
310
|
* @param {*} [options] Override http request option.
|
|
@@ -93,61 +93,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
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: function (code, assignEmailMessageEntityBodyDto, authorization, options) {
|
|
105
|
-
if (options === void 0) { options = {}; }
|
|
106
|
-
return __awaiter(_this, void 0, void 0, function () {
|
|
107
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
108
|
-
return __generator(this, function (_a) {
|
|
109
|
-
switch (_a.label) {
|
|
110
|
-
case 0:
|
|
111
|
-
// verify required parameter 'code' is not null or undefined
|
|
112
|
-
(0, common_1.assertParamExists)('assignEntity', 'code', code);
|
|
113
|
-
// verify required parameter 'assignEmailMessageEntityBodyDto' is not null or undefined
|
|
114
|
-
(0, common_1.assertParamExists)('assignEntity', 'assignEmailMessageEntityBodyDto', assignEmailMessageEntityBodyDto);
|
|
115
|
-
localVarPath = "/notificationservice/v1/email-messages/{code}/entity"
|
|
116
|
-
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
117
|
-
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
118
|
-
if (configuration) {
|
|
119
|
-
baseOptions = configuration.baseOptions;
|
|
120
|
-
baseAccessToken = configuration.accessToken;
|
|
121
|
-
}
|
|
122
|
-
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
|
|
123
|
-
localVarHeaderParameter = {};
|
|
124
|
-
localVarQueryParameter = {};
|
|
125
|
-
// authentication bearer required
|
|
126
|
-
// http bearer authentication required
|
|
127
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
128
|
-
case 1:
|
|
129
|
-
// authentication bearer required
|
|
130
|
-
// http bearer authentication required
|
|
131
|
-
_a.sent();
|
|
132
|
-
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
133
|
-
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
134
|
-
}
|
|
135
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
136
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
137
|
-
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
138
|
-
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
139
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(assignEmailMessageEntityBodyDto, localVarRequestOptions, configuration);
|
|
140
|
-
return [2 /*return*/, {
|
|
141
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
142
|
-
options: localVarRequestOptions,
|
|
143
|
-
}];
|
|
144
|
-
}
|
|
145
|
-
});
|
|
146
|
-
});
|
|
147
|
-
},
|
|
148
|
-
/**
|
|
149
|
-
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
150
|
-
* @summary Download the email message attachment
|
|
96
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
151
97
|
* @param {string} code
|
|
152
98
|
* @param {number} attachmentId
|
|
153
99
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -198,8 +144,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
198
144
|
});
|
|
199
145
|
},
|
|
200
146
|
/**
|
|
201
|
-
*
|
|
202
|
-
* @summary Retrieve the email message
|
|
147
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
203
148
|
* @param {string} code
|
|
204
149
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
205
150
|
* @param {*} [options] Override http request option.
|
|
@@ -246,8 +191,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
246
191
|
});
|
|
247
192
|
},
|
|
248
193
|
/**
|
|
249
|
-
*
|
|
250
|
-
* @summary List the email message attachments
|
|
194
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
251
195
|
* @param {string} code
|
|
252
196
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
253
197
|
* @param {*} [options] Override http request option.
|
|
@@ -294,16 +238,16 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
294
238
|
});
|
|
295
239
|
},
|
|
296
240
|
/**
|
|
297
|
-
*
|
|
241
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
298
242
|
* @summary List email messages
|
|
299
243
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
300
244
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
301
245
|
* @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.
|
|
302
|
-
* @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,
|
|
246
|
+
* @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>
|
|
303
247
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
304
248
|
* @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>
|
|
305
249
|
* @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>
|
|
306
|
-
* @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,
|
|
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, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
307
251
|
* @param {*} [options] Override http request option.
|
|
308
252
|
* @throws {RequiredError}
|
|
309
253
|
*/
|
|
@@ -376,30 +320,7 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
376
320
|
var localVarAxiosParamCreator = (0, exports.EmailMessagesApiAxiosParamCreator)(configuration);
|
|
377
321
|
return {
|
|
378
322
|
/**
|
|
379
|
-
*
|
|
380
|
-
* @summary Assign an email message to an entity
|
|
381
|
-
* @param {string} code
|
|
382
|
-
* @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
|
|
383
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
384
|
-
* @param {*} [options] Override http request option.
|
|
385
|
-
* @throws {RequiredError}
|
|
386
|
-
*/
|
|
387
|
-
assignEntity: function (code, assignEmailMessageEntityBodyDto, authorization, options) {
|
|
388
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
389
|
-
var localVarAxiosArgs;
|
|
390
|
-
return __generator(this, function (_a) {
|
|
391
|
-
switch (_a.label) {
|
|
392
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.assignEntity(code, assignEmailMessageEntityBodyDto, authorization, options)];
|
|
393
|
-
case 1:
|
|
394
|
-
localVarAxiosArgs = _a.sent();
|
|
395
|
-
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
396
|
-
}
|
|
397
|
-
});
|
|
398
|
-
});
|
|
399
|
-
},
|
|
400
|
-
/**
|
|
401
|
-
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
402
|
-
* @summary Download the email message attachment
|
|
323
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
403
324
|
* @param {string} code
|
|
404
325
|
* @param {number} attachmentId
|
|
405
326
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -420,8 +341,7 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
420
341
|
});
|
|
421
342
|
},
|
|
422
343
|
/**
|
|
423
|
-
*
|
|
424
|
-
* @summary Retrieve the email message
|
|
344
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
425
345
|
* @param {string} code
|
|
426
346
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
427
347
|
* @param {*} [options] Override http request option.
|
|
@@ -441,8 +361,7 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
441
361
|
});
|
|
442
362
|
},
|
|
443
363
|
/**
|
|
444
|
-
*
|
|
445
|
-
* @summary List the email message attachments
|
|
364
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
446
365
|
* @param {string} code
|
|
447
366
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
448
367
|
* @param {*} [options] Override http request option.
|
|
@@ -462,16 +381,16 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
462
381
|
});
|
|
463
382
|
},
|
|
464
383
|
/**
|
|
465
|
-
*
|
|
384
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
466
385
|
* @summary List email messages
|
|
467
386
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
468
387
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
469
388
|
* @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.
|
|
470
|
-
* @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,
|
|
389
|
+
* @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>
|
|
471
390
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
472
391
|
* @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>
|
|
473
392
|
* @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>
|
|
474
|
-
* @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,
|
|
393
|
+
* @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>
|
|
475
394
|
* @param {*} [options] Override http request option.
|
|
476
395
|
* @throws {RequiredError}
|
|
477
396
|
*/
|
|
@@ -499,20 +418,7 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
499
418
|
var localVarFp = (0, exports.EmailMessagesApiFp)(configuration);
|
|
500
419
|
return {
|
|
501
420
|
/**
|
|
502
|
-
*
|
|
503
|
-
* @summary Assign an email message to an entity
|
|
504
|
-
* @param {string} code
|
|
505
|
-
* @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
|
|
506
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
507
|
-
* @param {*} [options] Override http request option.
|
|
508
|
-
* @throws {RequiredError}
|
|
509
|
-
*/
|
|
510
|
-
assignEntity: function (code, assignEmailMessageEntityBodyDto, authorization, options) {
|
|
511
|
-
return localVarFp.assignEntity(code, assignEmailMessageEntityBodyDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
512
|
-
},
|
|
513
|
-
/**
|
|
514
|
-
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
515
|
-
* @summary Download the email message attachment
|
|
421
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
516
422
|
* @param {string} code
|
|
517
423
|
* @param {number} attachmentId
|
|
518
424
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -523,8 +429,7 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
523
429
|
return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
524
430
|
},
|
|
525
431
|
/**
|
|
526
|
-
*
|
|
527
|
-
* @summary Retrieve the email message
|
|
432
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
528
433
|
* @param {string} code
|
|
529
434
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
530
435
|
* @param {*} [options] Override http request option.
|
|
@@ -534,8 +439,7 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
534
439
|
return localVarFp.getMessage(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
535
440
|
},
|
|
536
441
|
/**
|
|
537
|
-
*
|
|
538
|
-
* @summary List the email message attachments
|
|
442
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
539
443
|
* @param {string} code
|
|
540
444
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
541
445
|
* @param {*} [options] Override http request option.
|
|
@@ -545,16 +449,16 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
545
449
|
return localVarFp.listAttachments(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
546
450
|
},
|
|
547
451
|
/**
|
|
548
|
-
*
|
|
452
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
549
453
|
* @summary List email messages
|
|
550
454
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
551
455
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
552
456
|
* @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.
|
|
553
|
-
* @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,
|
|
457
|
+
* @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>
|
|
554
458
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
555
459
|
* @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>
|
|
556
460
|
* @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>
|
|
557
|
-
* @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,
|
|
461
|
+
* @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>
|
|
558
462
|
* @param {*} [options] Override http request option.
|
|
559
463
|
* @throws {RequiredError}
|
|
560
464
|
*/
|
|
@@ -576,20 +480,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
576
480
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
577
481
|
}
|
|
578
482
|
/**
|
|
579
|
-
*
|
|
580
|
-
* @summary Assign an email message to an entity
|
|
581
|
-
* @param {EmailMessagesApiAssignEntityRequest} requestParameters Request parameters.
|
|
582
|
-
* @param {*} [options] Override http request option.
|
|
583
|
-
* @throws {RequiredError}
|
|
584
|
-
* @memberof EmailMessagesApi
|
|
585
|
-
*/
|
|
586
|
-
EmailMessagesApi.prototype.assignEntity = function (requestParameters, options) {
|
|
587
|
-
var _this = this;
|
|
588
|
-
return (0, exports.EmailMessagesApiFp)(this.configuration).assignEntity(requestParameters.code, requestParameters.assignEmailMessageEntityBodyDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
589
|
-
};
|
|
590
|
-
/**
|
|
591
|
-
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
592
|
-
* @summary Download the email message attachment
|
|
483
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
593
484
|
* @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
|
|
594
485
|
* @param {*} [options] Override http request option.
|
|
595
486
|
* @throws {RequiredError}
|
|
@@ -600,8 +491,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
600
491
|
return (0, exports.EmailMessagesApiFp)(this.configuration).downloadAttachment(requestParameters.code, requestParameters.attachmentId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
601
492
|
};
|
|
602
493
|
/**
|
|
603
|
-
*
|
|
604
|
-
* @summary Retrieve the email message
|
|
494
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
605
495
|
* @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
|
|
606
496
|
* @param {*} [options] Override http request option.
|
|
607
497
|
* @throws {RequiredError}
|
|
@@ -612,8 +502,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
612
502
|
return (0, exports.EmailMessagesApiFp)(this.configuration).getMessage(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
613
503
|
};
|
|
614
504
|
/**
|
|
615
|
-
*
|
|
616
|
-
* @summary List the email message attachments
|
|
505
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
617
506
|
* @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
|
|
618
507
|
* @param {*} [options] Override http request option.
|
|
619
508
|
* @throws {RequiredError}
|
|
@@ -624,7 +513,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
624
513
|
return (0, exports.EmailMessagesApiFp)(this.configuration).listAttachments(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
625
514
|
};
|
|
626
515
|
/**
|
|
627
|
-
*
|
|
516
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
628
517
|
* @summary List email messages
|
|
629
518
|
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
630
519
|
* @param {*} [options] Override http request option.
|