@emilgroup/notification-sdk 0.8.1-beta.27 → 0.8.1-beta.29
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 +6 -0
- package/README.md +2 -2
- package/api/email-messages-api.ts +148 -16
- package/api/email-tracking-api.ts +24 -16
- package/api/email-verifications-api.ts +16 -8
- package/api/layouts-api.ts +56 -36
- package/api/notification-templates-api.ts +56 -36
- package/api/notifications-api.ts +115 -4
- package/dist/api/email-messages-api.d.ts +94 -16
- package/dist/api/email-messages-api.js +127 -16
- package/dist/api/email-tracking-api.d.ts +24 -16
- package/dist/api/email-tracking-api.js +24 -16
- package/dist/api/email-verifications-api.d.ts +16 -8
- package/dist/api/email-verifications-api.js +16 -8
- package/dist/api/layouts-api.d.ts +56 -36
- package/dist/api/layouts-api.js +52 -32
- package/dist/api/notification-templates-api.d.ts +56 -36
- package/dist/api/notification-templates-api.js +52 -32
- package/dist/api/notifications-api.d.ts +65 -4
- package/dist/api/notifications-api.js +101 -4
- package/dist/models/assign-email-message-entity-body-dto.d.ts +43 -0
- package/dist/models/assign-email-message-entity-body-dto.js +22 -0
- package/dist/models/assign-email-message-entity-response-class.d.ts +25 -0
- package/dist/models/assign-email-message-entity-response-class.js +15 -0
- package/dist/models/email-message-class.d.ts +2 -1
- package/dist/models/email-message-class.js +2 -1
- package/dist/models/grpc-send-email-request-dto.d.ts +137 -0
- package/dist/models/grpc-send-email-request-dto.js +22 -0
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/dist/models/inline-attachment-dto.d.ts +36 -0
- package/dist/models/inline-attachment-dto.js +15 -0
- package/dist/models/send-email-request-dto.d.ts +131 -0
- package/dist/models/send-email-request-dto.js +22 -0
- package/dist/models/send-email-response-class.d.ts +24 -0
- package/dist/models/send-email-response-class.js +15 -0
- package/models/assign-email-message-entity-body-dto.ts +52 -0
- package/models/assign-email-message-entity-response-class.ts +31 -0
- package/models/email-message-class.ts +3 -2
- package/models/grpc-send-email-request-dto.ts +144 -0
- package/models/index.ts +6 -0
- package/models/inline-attachment-dto.ts +42 -0
- package/models/send-email-request-dto.ts +138 -0
- package/models/send-email-response-class.ts +30 -0
- package/package.json +1 -1
package/api/notifications-api.ts
CHANGED
|
@@ -21,6 +21,10 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
21
21
|
// @ts-ignore
|
|
22
22
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
23
|
// @ts-ignore
|
|
24
|
+
import { SendEmailRequestDto } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { SendEmailResponseClass } from '../models';
|
|
27
|
+
// @ts-ignore
|
|
24
28
|
import { SendNotificationRequestDto } from '../models';
|
|
25
29
|
// @ts-ignore
|
|
26
30
|
import { SendNotificationResponseClass } from '../models';
|
|
@@ -31,7 +35,55 @@ import { SendNotificationResponseClass } from '../models';
|
|
|
31
35
|
export const NotificationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
36
|
return {
|
|
33
37
|
/**
|
|
34
|
-
*
|
|
38
|
+
* Sends an email with a caller-supplied HTML and/or text body, delivered as given. Attachments can reference documents already in S3 or be sent inline as base64. **Required Permissions** none
|
|
39
|
+
* @summary Send an email without a template
|
|
40
|
+
* @param {SendEmailRequestDto} sendEmailRequestDto
|
|
41
|
+
* @param {string} [authorization] Bearer Token
|
|
42
|
+
* @param {*} [options] Override http request option.
|
|
43
|
+
* @throws {RequiredError}
|
|
44
|
+
*/
|
|
45
|
+
sendEmail: async (sendEmailRequestDto: SendEmailRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
46
|
+
// verify required parameter 'sendEmailRequestDto' is not null or undefined
|
|
47
|
+
assertParamExists('sendEmail', 'sendEmailRequestDto', sendEmailRequestDto)
|
|
48
|
+
const localVarPath = `/notificationservice/v1/notifications/emails`;
|
|
49
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
50
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
51
|
+
let baseOptions;
|
|
52
|
+
let baseAccessToken;
|
|
53
|
+
if (configuration) {
|
|
54
|
+
baseOptions = configuration.baseOptions;
|
|
55
|
+
baseAccessToken = configuration.accessToken;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
59
|
+
const localVarHeaderParameter = {} as any;
|
|
60
|
+
const localVarQueryParameter = {} as any;
|
|
61
|
+
|
|
62
|
+
// authentication bearer required
|
|
63
|
+
// http bearer authentication required
|
|
64
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
65
|
+
|
|
66
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
67
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
73
|
+
|
|
74
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
75
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
76
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
77
|
+
localVarRequestOptions.data = serializeDataIfNeeded(sendEmailRequestDto, localVarRequestOptions, configuration)
|
|
78
|
+
|
|
79
|
+
return {
|
|
80
|
+
url: toPathString(localVarUrlObj),
|
|
81
|
+
options: localVarRequestOptions,
|
|
82
|
+
};
|
|
83
|
+
},
|
|
84
|
+
/**
|
|
85
|
+
* Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
|
|
86
|
+
* @summary Send a notification
|
|
35
87
|
* @param {SendNotificationRequestDto} sendNotificationRequestDto
|
|
36
88
|
* @param {string} [authorization] Bearer Token
|
|
37
89
|
* @param {*} [options] Override http request option.
|
|
@@ -87,7 +139,20 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
|
|
|
87
139
|
const localVarAxiosParamCreator = NotificationsApiAxiosParamCreator(configuration)
|
|
88
140
|
return {
|
|
89
141
|
/**
|
|
90
|
-
*
|
|
142
|
+
* Sends an email with a caller-supplied HTML and/or text body, delivered as given. Attachments can reference documents already in S3 or be sent inline as base64. **Required Permissions** none
|
|
143
|
+
* @summary Send an email without a template
|
|
144
|
+
* @param {SendEmailRequestDto} sendEmailRequestDto
|
|
145
|
+
* @param {string} [authorization] Bearer Token
|
|
146
|
+
* @param {*} [options] Override http request option.
|
|
147
|
+
* @throws {RequiredError}
|
|
148
|
+
*/
|
|
149
|
+
async sendEmail(sendEmailRequestDto: SendEmailRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SendEmailResponseClass>> {
|
|
150
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.sendEmail(sendEmailRequestDto, authorization, options);
|
|
151
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
152
|
+
},
|
|
153
|
+
/**
|
|
154
|
+
* Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
|
|
155
|
+
* @summary Send a notification
|
|
91
156
|
* @param {SendNotificationRequestDto} sendNotificationRequestDto
|
|
92
157
|
* @param {string} [authorization] Bearer Token
|
|
93
158
|
* @param {*} [options] Override http request option.
|
|
@@ -108,7 +173,19 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
|
|
|
108
173
|
const localVarFp = NotificationsApiFp(configuration)
|
|
109
174
|
return {
|
|
110
175
|
/**
|
|
111
|
-
*
|
|
176
|
+
* Sends an email with a caller-supplied HTML and/or text body, delivered as given. Attachments can reference documents already in S3 or be sent inline as base64. **Required Permissions** none
|
|
177
|
+
* @summary Send an email without a template
|
|
178
|
+
* @param {SendEmailRequestDto} sendEmailRequestDto
|
|
179
|
+
* @param {string} [authorization] Bearer Token
|
|
180
|
+
* @param {*} [options] Override http request option.
|
|
181
|
+
* @throws {RequiredError}
|
|
182
|
+
*/
|
|
183
|
+
sendEmail(sendEmailRequestDto: SendEmailRequestDto, authorization?: string, options?: any): AxiosPromise<SendEmailResponseClass> {
|
|
184
|
+
return localVarFp.sendEmail(sendEmailRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
185
|
+
},
|
|
186
|
+
/**
|
|
187
|
+
* Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
|
|
188
|
+
* @summary Send a notification
|
|
112
189
|
* @param {SendNotificationRequestDto} sendNotificationRequestDto
|
|
113
190
|
* @param {string} [authorization] Bearer Token
|
|
114
191
|
* @param {*} [options] Override http request option.
|
|
@@ -120,6 +197,27 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
|
|
|
120
197
|
};
|
|
121
198
|
};
|
|
122
199
|
|
|
200
|
+
/**
|
|
201
|
+
* Request parameters for sendEmail operation in NotificationsApi.
|
|
202
|
+
* @export
|
|
203
|
+
* @interface NotificationsApiSendEmailRequest
|
|
204
|
+
*/
|
|
205
|
+
export interface NotificationsApiSendEmailRequest {
|
|
206
|
+
/**
|
|
207
|
+
*
|
|
208
|
+
* @type {SendEmailRequestDto}
|
|
209
|
+
* @memberof NotificationsApiSendEmail
|
|
210
|
+
*/
|
|
211
|
+
readonly sendEmailRequestDto: SendEmailRequestDto
|
|
212
|
+
|
|
213
|
+
/**
|
|
214
|
+
* Bearer Token
|
|
215
|
+
* @type {string}
|
|
216
|
+
* @memberof NotificationsApiSendEmail
|
|
217
|
+
*/
|
|
218
|
+
readonly authorization?: string
|
|
219
|
+
}
|
|
220
|
+
|
|
123
221
|
/**
|
|
124
222
|
* Request parameters for sendNotification operation in NotificationsApi.
|
|
125
223
|
* @export
|
|
@@ -149,7 +247,20 @@ export interface NotificationsApiSendNotificationRequest {
|
|
|
149
247
|
*/
|
|
150
248
|
export class NotificationsApi extends BaseAPI {
|
|
151
249
|
/**
|
|
152
|
-
*
|
|
250
|
+
* Sends an email with a caller-supplied HTML and/or text body, delivered as given. Attachments can reference documents already in S3 or be sent inline as base64. **Required Permissions** none
|
|
251
|
+
* @summary Send an email without a template
|
|
252
|
+
* @param {NotificationsApiSendEmailRequest} requestParameters Request parameters.
|
|
253
|
+
* @param {*} [options] Override http request option.
|
|
254
|
+
* @throws {RequiredError}
|
|
255
|
+
* @memberof NotificationsApi
|
|
256
|
+
*/
|
|
257
|
+
public sendEmail(requestParameters: NotificationsApiSendEmailRequest, options?: AxiosRequestConfig) {
|
|
258
|
+
return NotificationsApiFp(this.configuration).sendEmail(requestParameters.sendEmailRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
/**
|
|
262
|
+
* Sends an email using the notification template identified by `templateSlug`. Provide `entityType` and `entityCode` to track replies in an email thread. **Required Permissions** none
|
|
263
|
+
* @summary Send a notification
|
|
153
264
|
* @param {NotificationsApiSendNotificationRequest} requestParameters Request parameters.
|
|
154
265
|
* @param {*} [options] Override http request option.
|
|
155
266
|
* @throws {RequiredError}
|
|
@@ -12,6 +12,8 @@
|
|
|
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';
|
|
15
17
|
import { DownloadAttachmentResponseClass } from '../models';
|
|
16
18
|
import { GetEmailMessageResponseClass } from '../models';
|
|
17
19
|
import { ListEmailAttachmentsResponseClass } from '../models';
|
|
@@ -22,7 +24,18 @@ import { ListEmailMessagesResponseClass } from '../models';
|
|
|
22
24
|
*/
|
|
23
25
|
export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
26
|
/**
|
|
25
|
-
*
|
|
27
|
+
* Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
|
|
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
|
|
26
39
|
* @param {string} code
|
|
27
40
|
* @param {number} attachmentId
|
|
28
41
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -31,7 +44,8 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
31
44
|
*/
|
|
32
45
|
downloadAttachment: (code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
46
|
/**
|
|
34
|
-
*
|
|
47
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
48
|
+
* @summary Retrieve the email message
|
|
35
49
|
* @param {string} code
|
|
36
50
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
37
51
|
* @param {*} [options] Override http request option.
|
|
@@ -39,7 +53,8 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
39
53
|
*/
|
|
40
54
|
getMessage: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41
55
|
/**
|
|
42
|
-
*
|
|
56
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
57
|
+
* @summary List the email message attachments
|
|
43
58
|
* @param {string} code
|
|
44
59
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
45
60
|
* @param {*} [options] Override http request option.
|
|
@@ -47,7 +62,7 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
47
62
|
*/
|
|
48
63
|
listAttachments: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
64
|
/**
|
|
50
|
-
*
|
|
65
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
51
66
|
* @summary List email messages
|
|
52
67
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
53
68
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -68,7 +83,18 @@ export declare const EmailMessagesApiAxiosParamCreator: (configuration?: Configu
|
|
|
68
83
|
*/
|
|
69
84
|
export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
70
85
|
/**
|
|
71
|
-
*
|
|
86
|
+
* Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
|
|
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
|
|
72
98
|
* @param {string} code
|
|
73
99
|
* @param {number} attachmentId
|
|
74
100
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -77,7 +103,8 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
77
103
|
*/
|
|
78
104
|
downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DownloadAttachmentResponseClass>>;
|
|
79
105
|
/**
|
|
80
|
-
*
|
|
106
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
107
|
+
* @summary Retrieve the email message
|
|
81
108
|
* @param {string} code
|
|
82
109
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
83
110
|
* @param {*} [options] Override http request option.
|
|
@@ -85,7 +112,8 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
85
112
|
*/
|
|
86
113
|
getMessage(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEmailMessageResponseClass>>;
|
|
87
114
|
/**
|
|
88
|
-
*
|
|
115
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
116
|
+
* @summary List the email message attachments
|
|
89
117
|
* @param {string} code
|
|
90
118
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
91
119
|
* @param {*} [options] Override http request option.
|
|
@@ -93,7 +121,7 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
93
121
|
*/
|
|
94
122
|
listAttachments(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailAttachmentsResponseClass>>;
|
|
95
123
|
/**
|
|
96
|
-
*
|
|
124
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
97
125
|
* @summary List email messages
|
|
98
126
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
99
127
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -114,7 +142,18 @@ export declare const EmailMessagesApiFp: (configuration?: Configuration) => {
|
|
|
114
142
|
*/
|
|
115
143
|
export declare const EmailMessagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
116
144
|
/**
|
|
117
|
-
*
|
|
145
|
+
* Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
|
|
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
|
|
118
157
|
* @param {string} code
|
|
119
158
|
* @param {number} attachmentId
|
|
120
159
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -123,7 +162,8 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
123
162
|
*/
|
|
124
163
|
downloadAttachment(code: string, attachmentId: number, authorization?: string, options?: any): AxiosPromise<DownloadAttachmentResponseClass>;
|
|
125
164
|
/**
|
|
126
|
-
*
|
|
165
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
166
|
+
* @summary Retrieve the email message
|
|
127
167
|
* @param {string} code
|
|
128
168
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
129
169
|
* @param {*} [options] Override http request option.
|
|
@@ -131,7 +171,8 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
131
171
|
*/
|
|
132
172
|
getMessage(code: string, authorization?: string, options?: any): AxiosPromise<GetEmailMessageResponseClass>;
|
|
133
173
|
/**
|
|
134
|
-
*
|
|
174
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
175
|
+
* @summary List the email message attachments
|
|
135
176
|
* @param {string} code
|
|
136
177
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
137
178
|
* @param {*} [options] Override http request option.
|
|
@@ -139,7 +180,7 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
139
180
|
*/
|
|
140
181
|
listAttachments(code: string, authorization?: string, options?: any): AxiosPromise<ListEmailAttachmentsResponseClass>;
|
|
141
182
|
/**
|
|
142
|
-
*
|
|
183
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
143
184
|
* @summary List email messages
|
|
144
185
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
145
186
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -154,6 +195,31 @@ export declare const EmailMessagesApiFactory: (configuration?: Configuration, ba
|
|
|
154
195
|
*/
|
|
155
196
|
listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass>;
|
|
156
197
|
};
|
|
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
|
+
}
|
|
157
223
|
/**
|
|
158
224
|
* Request parameters for downloadAttachment operation in EmailMessagesApi.
|
|
159
225
|
* @export
|
|
@@ -280,7 +346,17 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
280
346
|
*/
|
|
281
347
|
export declare class EmailMessagesApi extends BaseAPI {
|
|
282
348
|
/**
|
|
283
|
-
*
|
|
349
|
+
* Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
|
|
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
|
|
284
360
|
* @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
|
|
285
361
|
* @param {*} [options] Override http request option.
|
|
286
362
|
* @throws {RequiredError}
|
|
@@ -288,7 +364,8 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
288
364
|
*/
|
|
289
365
|
downloadAttachment(requestParameters: EmailMessagesApiDownloadAttachmentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DownloadAttachmentResponseClass, any, {}>>;
|
|
290
366
|
/**
|
|
291
|
-
*
|
|
367
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
368
|
+
* @summary Retrieve the email message
|
|
292
369
|
* @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
|
|
293
370
|
* @param {*} [options] Override http request option.
|
|
294
371
|
* @throws {RequiredError}
|
|
@@ -296,7 +373,8 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
296
373
|
*/
|
|
297
374
|
getMessage(requestParameters: EmailMessagesApiGetMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEmailMessageResponseClass, any, {}>>;
|
|
298
375
|
/**
|
|
299
|
-
*
|
|
376
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
377
|
+
* @summary List the email message attachments
|
|
300
378
|
* @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
|
|
301
379
|
* @param {*} [options] Override http request option.
|
|
302
380
|
* @throws {RequiredError}
|
|
@@ -304,7 +382,7 @@ export declare class EmailMessagesApi extends BaseAPI {
|
|
|
304
382
|
*/
|
|
305
383
|
listAttachments(requestParameters: EmailMessagesApiListAttachmentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailAttachmentsResponseClass, any, {}>>;
|
|
306
384
|
/**
|
|
307
|
-
*
|
|
385
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
308
386
|
* @summary List email messages
|
|
309
387
|
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
310
388
|
* @param {*} [options] Override http request option.
|
|
@@ -93,7 +93,61 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
*
|
|
96
|
+
* Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
|
|
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
|
|
97
151
|
* @param {string} code
|
|
98
152
|
* @param {number} attachmentId
|
|
99
153
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -144,7 +198,8 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
144
198
|
});
|
|
145
199
|
},
|
|
146
200
|
/**
|
|
147
|
-
*
|
|
201
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
202
|
+
* @summary Retrieve the email message
|
|
148
203
|
* @param {string} code
|
|
149
204
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
150
205
|
* @param {*} [options] Override http request option.
|
|
@@ -191,7 +246,8 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
191
246
|
});
|
|
192
247
|
},
|
|
193
248
|
/**
|
|
194
|
-
*
|
|
249
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
250
|
+
* @summary List the email message attachments
|
|
195
251
|
* @param {string} code
|
|
196
252
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
197
253
|
* @param {*} [options] Override http request option.
|
|
@@ -238,7 +294,7 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
238
294
|
});
|
|
239
295
|
},
|
|
240
296
|
/**
|
|
241
|
-
*
|
|
297
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
242
298
|
* @summary List email messages
|
|
243
299
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
244
300
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -320,7 +376,30 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
320
376
|
var localVarAxiosParamCreator = (0, exports.EmailMessagesApiAxiosParamCreator)(configuration);
|
|
321
377
|
return {
|
|
322
378
|
/**
|
|
323
|
-
*
|
|
379
|
+
* Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
|
|
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
|
|
324
403
|
* @param {string} code
|
|
325
404
|
* @param {number} attachmentId
|
|
326
405
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -341,7 +420,8 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
341
420
|
});
|
|
342
421
|
},
|
|
343
422
|
/**
|
|
344
|
-
*
|
|
423
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
424
|
+
* @summary Retrieve the email message
|
|
345
425
|
* @param {string} code
|
|
346
426
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
347
427
|
* @param {*} [options] Override http request option.
|
|
@@ -361,7 +441,8 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
361
441
|
});
|
|
362
442
|
},
|
|
363
443
|
/**
|
|
364
|
-
*
|
|
444
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
445
|
+
* @summary List the email message attachments
|
|
365
446
|
* @param {string} code
|
|
366
447
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
367
448
|
* @param {*} [options] Override http request option.
|
|
@@ -381,7 +462,7 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
381
462
|
});
|
|
382
463
|
},
|
|
383
464
|
/**
|
|
384
|
-
*
|
|
465
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
385
466
|
* @summary List email messages
|
|
386
467
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
387
468
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -418,7 +499,20 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
418
499
|
var localVarFp = (0, exports.EmailMessagesApiFp)(configuration);
|
|
419
500
|
return {
|
|
420
501
|
/**
|
|
421
|
-
*
|
|
502
|
+
* Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
|
|
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
|
|
422
516
|
* @param {string} code
|
|
423
517
|
* @param {number} attachmentId
|
|
424
518
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -429,7 +523,8 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
429
523
|
return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
430
524
|
},
|
|
431
525
|
/**
|
|
432
|
-
*
|
|
526
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
527
|
+
* @summary Retrieve the email message
|
|
433
528
|
* @param {string} code
|
|
434
529
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
435
530
|
* @param {*} [options] Override http request option.
|
|
@@ -439,7 +534,8 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
439
534
|
return localVarFp.getMessage(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
440
535
|
},
|
|
441
536
|
/**
|
|
442
|
-
*
|
|
537
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
538
|
+
* @summary List the email message attachments
|
|
443
539
|
* @param {string} code
|
|
444
540
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
445
541
|
* @param {*} [options] Override http request option.
|
|
@@ -449,7 +545,7 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
449
545
|
return localVarFp.listAttachments(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
450
546
|
},
|
|
451
547
|
/**
|
|
452
|
-
*
|
|
548
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
453
549
|
* @summary List email messages
|
|
454
550
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
455
551
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
@@ -480,7 +576,20 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
480
576
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
481
577
|
}
|
|
482
578
|
/**
|
|
483
|
-
*
|
|
579
|
+
* Links the email message to the given entity, identified by code or by number (the code wins when both are set), and moves it into that entity\'s open thread. The entity must exist. **Required Permissions** \"notification-management.email-messages.update\"
|
|
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
|
|
484
593
|
* @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
|
|
485
594
|
* @param {*} [options] Override http request option.
|
|
486
595
|
* @throws {RequiredError}
|
|
@@ -491,7 +600,8 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
491
600
|
return (0, exports.EmailMessagesApiFp)(this.configuration).downloadAttachment(requestParameters.code, requestParameters.attachmentId, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
492
601
|
};
|
|
493
602
|
/**
|
|
494
|
-
*
|
|
603
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
604
|
+
* @summary Retrieve the email message
|
|
495
605
|
* @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
|
|
496
606
|
* @param {*} [options] Override http request option.
|
|
497
607
|
* @throws {RequiredError}
|
|
@@ -502,7 +612,8 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
502
612
|
return (0, exports.EmailMessagesApiFp)(this.configuration).getMessage(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
503
613
|
};
|
|
504
614
|
/**
|
|
505
|
-
*
|
|
615
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
616
|
+
* @summary List the email message attachments
|
|
506
617
|
* @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
|
|
507
618
|
* @param {*} [options] Override http request option.
|
|
508
619
|
* @throws {RequiredError}
|
|
@@ -513,7 +624,7 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
513
624
|
return (0, exports.EmailMessagesApiFp)(this.configuration).listAttachments(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
514
625
|
};
|
|
515
626
|
/**
|
|
516
|
-
*
|
|
627
|
+
* Returns a list of sent and received email messages. For more information about pagination, read the Pagination documentation. **Required Permissions** \"notification-management.email-messages.view\"
|
|
517
628
|
* @summary List email messages
|
|
518
629
|
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
519
630
|
* @param {*} [options] Override http request option.
|