@emilgroup/notification-sdk 0.8.1-beta.30 → 0.8.1-beta.32
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 +8 -0
- package/README.md +2 -2
- package/api/email-messages-api.ts +259 -24
- package/api/email-tracking-api.ts +32 -24
- package/api/email-verifications-api.ts +16 -8
- package/api/layouts-api.ts +56 -36
- package/api/msgraph-webhooks-api.ts +278 -0
- package/api/notification-templates-api.ts +56 -36
- package/api/notifications-api.ts +115 -4
- package/api.ts +2 -0
- package/dist/api/email-messages-api.d.ts +158 -24
- package/dist/api/email-messages-api.js +225 -22
- package/dist/api/email-tracking-api.d.ts +32 -24
- package/dist/api/email-tracking-api.js +30 -22
- 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/msgraph-webhooks-api.d.ts +168 -0
- package/dist/api/msgraph-webhooks-api.js +305 -0
- 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/api.d.ts +1 -0
- package/dist/api.js +1 -0
- 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 +49 -2
- package/dist/models/email-message-class.js +16 -2
- 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 +7 -0
- package/dist/models/index.js +7 -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/dist/models/send-notification-request-dto.d.ts +1 -0
- package/dist/models/send-notification-request-dto.js +2 -1
- package/dist/models/unassign-email-message-entity-response-class.d.ts +25 -0
- package/dist/models/unassign-email-message-entity-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 +53 -3
- package/models/grpc-send-email-request-dto.ts +144 -0
- package/models/index.ts +7 -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/models/send-notification-request-dto.ts +2 -1
- package/models/unassign-email-message-entity-response-class.ts +31 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -8,6 +8,7 @@ api/email-tracking-api.ts
|
|
|
8
8
|
api/email-verifications-api.ts
|
|
9
9
|
api/health-api.ts
|
|
10
10
|
api/layouts-api.ts
|
|
11
|
+
api/msgraph-webhooks-api.ts
|
|
11
12
|
api/notification-templates-api.ts
|
|
12
13
|
api/notifications-api.ts
|
|
13
14
|
base.ts
|
|
@@ -15,6 +16,8 @@ common.ts
|
|
|
15
16
|
configuration.ts
|
|
16
17
|
git_push.sh
|
|
17
18
|
index.ts
|
|
19
|
+
models/assign-email-message-entity-body-dto.ts
|
|
20
|
+
models/assign-email-message-entity-response-class.ts
|
|
18
21
|
models/complete-email-verification-dto.ts
|
|
19
22
|
models/complete-email-verification-response-class.ts
|
|
20
23
|
models/create-layout-request-dto.ts
|
|
@@ -33,10 +36,12 @@ models/get-layout-request-dto.ts
|
|
|
33
36
|
models/get-layout-response-class.ts
|
|
34
37
|
models/get-notification-template-request-dto.ts
|
|
35
38
|
models/get-notification-template-response-class.ts
|
|
39
|
+
models/grpc-send-email-request-dto.ts
|
|
36
40
|
models/html-template-class.ts
|
|
37
41
|
models/index.ts
|
|
38
42
|
models/initiate-email-verification-dto.ts
|
|
39
43
|
models/initiate-email-verification-response-class.ts
|
|
44
|
+
models/inline-attachment-dto.ts
|
|
40
45
|
models/inline-response200.ts
|
|
41
46
|
models/inline-response503.ts
|
|
42
47
|
models/layout-class.ts
|
|
@@ -47,8 +52,11 @@ models/list-layouts-response-class.ts
|
|
|
47
52
|
models/list-notification-templates-response-class.ts
|
|
48
53
|
models/notification-template-class.ts
|
|
49
54
|
models/s3-document-dto.ts
|
|
55
|
+
models/send-email-request-dto.ts
|
|
56
|
+
models/send-email-response-class.ts
|
|
50
57
|
models/send-notification-request-dto.ts
|
|
51
58
|
models/send-notification-response-class.ts
|
|
59
|
+
models/unassign-email-message-entity-response-class.ts
|
|
52
60
|
models/update-html-template-request-dto.ts
|
|
53
61
|
models/update-layout-request-dto.ts
|
|
54
62
|
models/update-layout-response-class.ts
|
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/notification-sdk@0.8.1-beta.
|
|
20
|
+
npm install @emilgroup/notification-sdk@0.8.1-beta.32 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/notification-sdk@0.8.1-beta.
|
|
24
|
+
yarn add @emilgroup/notification-sdk@0.8.1-beta.32
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import ``.
|
|
@@ -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 { AssignEmailMessageEntityBodyDto } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { AssignEmailMessageEntityResponseClass } from '../models';
|
|
27
|
+
// @ts-ignore
|
|
24
28
|
import { DownloadAttachmentResponseClass } from '../models';
|
|
25
29
|
// @ts-ignore
|
|
26
30
|
import { GetEmailMessageResponseClass } from '../models';
|
|
@@ -28,6 +32,8 @@ import { GetEmailMessageResponseClass } from '../models';
|
|
|
28
32
|
import { ListEmailAttachmentsResponseClass } from '../models';
|
|
29
33
|
// @ts-ignore
|
|
30
34
|
import { ListEmailMessagesResponseClass } from '../models';
|
|
35
|
+
// @ts-ignore
|
|
36
|
+
import { UnassignEmailMessageEntityResponseClass } from '../models';
|
|
31
37
|
/**
|
|
32
38
|
* EmailMessagesApi - axios parameter creator
|
|
33
39
|
* @export
|
|
@@ -35,7 +41,59 @@ import { ListEmailMessagesResponseClass } from '../models';
|
|
|
35
41
|
export const EmailMessagesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
42
|
return {
|
|
37
43
|
/**
|
|
38
|
-
*
|
|
44
|
+
* 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\"
|
|
45
|
+
* @summary Assign an email message to an entity
|
|
46
|
+
* @param {string} code
|
|
47
|
+
* @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
|
|
48
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
49
|
+
* @param {*} [options] Override http request option.
|
|
50
|
+
* @throws {RequiredError}
|
|
51
|
+
*/
|
|
52
|
+
assignEntity: async (code: string, assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
53
|
+
// verify required parameter 'code' is not null or undefined
|
|
54
|
+
assertParamExists('assignEntity', 'code', code)
|
|
55
|
+
// verify required parameter 'assignEmailMessageEntityBodyDto' is not null or undefined
|
|
56
|
+
assertParamExists('assignEntity', 'assignEmailMessageEntityBodyDto', assignEmailMessageEntityBodyDto)
|
|
57
|
+
const localVarPath = `/notificationservice/v1/email-messages/{code}/entity`
|
|
58
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
59
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
60
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
61
|
+
let baseOptions;
|
|
62
|
+
let baseAccessToken;
|
|
63
|
+
if (configuration) {
|
|
64
|
+
baseOptions = configuration.baseOptions;
|
|
65
|
+
baseAccessToken = configuration.accessToken;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
69
|
+
const localVarHeaderParameter = {} as any;
|
|
70
|
+
const localVarQueryParameter = {} as any;
|
|
71
|
+
|
|
72
|
+
// authentication bearer required
|
|
73
|
+
// http bearer authentication required
|
|
74
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
75
|
+
|
|
76
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
77
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
83
|
+
|
|
84
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
85
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
86
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
87
|
+
localVarRequestOptions.data = serializeDataIfNeeded(assignEmailMessageEntityBodyDto, localVarRequestOptions, configuration)
|
|
88
|
+
|
|
89
|
+
return {
|
|
90
|
+
url: toPathString(localVarUrlObj),
|
|
91
|
+
options: localVarRequestOptions,
|
|
92
|
+
};
|
|
93
|
+
},
|
|
94
|
+
/**
|
|
95
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
96
|
+
* @summary Download the email message attachment
|
|
39
97
|
* @param {string} code
|
|
40
98
|
* @param {number} attachmentId
|
|
41
99
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -83,7 +141,8 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
83
141
|
};
|
|
84
142
|
},
|
|
85
143
|
/**
|
|
86
|
-
*
|
|
144
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
145
|
+
* @summary Retrieve the email message
|
|
87
146
|
* @param {string} code
|
|
88
147
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
89
148
|
* @param {*} [options] Override http request option.
|
|
@@ -127,7 +186,8 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
127
186
|
};
|
|
128
187
|
},
|
|
129
188
|
/**
|
|
130
|
-
*
|
|
189
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
190
|
+
* @summary List the email message attachments
|
|
131
191
|
* @param {string} code
|
|
132
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
133
193
|
* @param {*} [options] Override http request option.
|
|
@@ -171,16 +231,16 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
171
231
|
};
|
|
172
232
|
},
|
|
173
233
|
/**
|
|
174
|
-
*
|
|
234
|
+
* 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\"
|
|
175
235
|
* @summary List email messages
|
|
176
236
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
177
237
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
178
238
|
* @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.
|
|
179
|
-
* @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>
|
|
239
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
180
240
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
181
241
|
* @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>
|
|
182
242
|
* @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>
|
|
183
|
-
* @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>
|
|
243
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
184
244
|
* @param {*} [options] Override http request option.
|
|
185
245
|
* @throws {RequiredError}
|
|
186
246
|
*/
|
|
@@ -237,6 +297,51 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
237
297
|
|
|
238
298
|
|
|
239
299
|
|
|
300
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
301
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
302
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
303
|
+
|
|
304
|
+
return {
|
|
305
|
+
url: toPathString(localVarUrlObj),
|
|
306
|
+
options: localVarRequestOptions,
|
|
307
|
+
};
|
|
308
|
+
},
|
|
309
|
+
/**
|
|
310
|
+
* Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
311
|
+
* @summary Unassign an email message from its entity
|
|
312
|
+
* @param {string} code
|
|
313
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
314
|
+
* @param {*} [options] Override http request option.
|
|
315
|
+
* @throws {RequiredError}
|
|
316
|
+
*/
|
|
317
|
+
unassignEntity: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
318
|
+
// verify required parameter 'code' is not null or undefined
|
|
319
|
+
assertParamExists('unassignEntity', 'code', code)
|
|
320
|
+
const localVarPath = `/notificationservice/v1/email-messages/{code}/entity`
|
|
321
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
322
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
323
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
324
|
+
let baseOptions;
|
|
325
|
+
let baseAccessToken;
|
|
326
|
+
if (configuration) {
|
|
327
|
+
baseOptions = configuration.baseOptions;
|
|
328
|
+
baseAccessToken = configuration.accessToken;
|
|
329
|
+
}
|
|
330
|
+
|
|
331
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
332
|
+
const localVarHeaderParameter = {} as any;
|
|
333
|
+
const localVarQueryParameter = {} as any;
|
|
334
|
+
|
|
335
|
+
// authentication bearer required
|
|
336
|
+
// http bearer authentication required
|
|
337
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
338
|
+
|
|
339
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
340
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
341
|
+
}
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
240
345
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
241
346
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
242
347
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -257,7 +362,21 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
257
362
|
const localVarAxiosParamCreator = EmailMessagesApiAxiosParamCreator(configuration)
|
|
258
363
|
return {
|
|
259
364
|
/**
|
|
260
|
-
*
|
|
365
|
+
* 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\"
|
|
366
|
+
* @summary Assign an email message to an entity
|
|
367
|
+
* @param {string} code
|
|
368
|
+
* @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
|
|
369
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
370
|
+
* @param {*} [options] Override http request option.
|
|
371
|
+
* @throws {RequiredError}
|
|
372
|
+
*/
|
|
373
|
+
async assignEntity(code: string, assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AssignEmailMessageEntityResponseClass>> {
|
|
374
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.assignEntity(code, assignEmailMessageEntityBodyDto, authorization, options);
|
|
375
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
376
|
+
},
|
|
377
|
+
/**
|
|
378
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
379
|
+
* @summary Download the email message attachment
|
|
261
380
|
* @param {string} code
|
|
262
381
|
* @param {number} attachmentId
|
|
263
382
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -269,7 +388,8 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
269
388
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
270
389
|
},
|
|
271
390
|
/**
|
|
272
|
-
*
|
|
391
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
392
|
+
* @summary Retrieve the email message
|
|
273
393
|
* @param {string} code
|
|
274
394
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
275
395
|
* @param {*} [options] Override http request option.
|
|
@@ -280,7 +400,8 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
280
400
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
281
401
|
},
|
|
282
402
|
/**
|
|
283
|
-
*
|
|
403
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
404
|
+
* @summary List the email message attachments
|
|
284
405
|
* @param {string} code
|
|
285
406
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
286
407
|
* @param {*} [options] Override http request option.
|
|
@@ -291,16 +412,16 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
291
412
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
292
413
|
},
|
|
293
414
|
/**
|
|
294
|
-
*
|
|
415
|
+
* 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\"
|
|
295
416
|
* @summary List email messages
|
|
296
417
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
297
418
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
298
419
|
* @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.
|
|
299
|
-
* @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>
|
|
420
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
300
421
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
301
422
|
* @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>
|
|
302
423
|
* @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>
|
|
303
|
-
* @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>
|
|
424
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
304
425
|
* @param {*} [options] Override http request option.
|
|
305
426
|
* @throws {RequiredError}
|
|
306
427
|
*/
|
|
@@ -308,6 +429,18 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
308
429
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
309
430
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
310
431
|
},
|
|
432
|
+
/**
|
|
433
|
+
* Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
434
|
+
* @summary Unassign an email message from its entity
|
|
435
|
+
* @param {string} code
|
|
436
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
437
|
+
* @param {*} [options] Override http request option.
|
|
438
|
+
* @throws {RequiredError}
|
|
439
|
+
*/
|
|
440
|
+
async unassignEntity(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UnassignEmailMessageEntityResponseClass>> {
|
|
441
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.unassignEntity(code, authorization, options);
|
|
442
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
443
|
+
},
|
|
311
444
|
}
|
|
312
445
|
};
|
|
313
446
|
|
|
@@ -319,7 +452,20 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
319
452
|
const localVarFp = EmailMessagesApiFp(configuration)
|
|
320
453
|
return {
|
|
321
454
|
/**
|
|
322
|
-
*
|
|
455
|
+
* 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\"
|
|
456
|
+
* @summary Assign an email message to an entity
|
|
457
|
+
* @param {string} code
|
|
458
|
+
* @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
|
|
459
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
460
|
+
* @param {*} [options] Override http request option.
|
|
461
|
+
* @throws {RequiredError}
|
|
462
|
+
*/
|
|
463
|
+
assignEntity(code: string, assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto, authorization?: string, options?: any): AxiosPromise<AssignEmailMessageEntityResponseClass> {
|
|
464
|
+
return localVarFp.assignEntity(code, assignEmailMessageEntityBodyDto, authorization, options).then((request) => request(axios, basePath));
|
|
465
|
+
},
|
|
466
|
+
/**
|
|
467
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
468
|
+
* @summary Download the email message attachment
|
|
323
469
|
* @param {string} code
|
|
324
470
|
* @param {number} attachmentId
|
|
325
471
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -330,7 +476,8 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
330
476
|
return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then((request) => request(axios, basePath));
|
|
331
477
|
},
|
|
332
478
|
/**
|
|
333
|
-
*
|
|
479
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
480
|
+
* @summary Retrieve the email message
|
|
334
481
|
* @param {string} code
|
|
335
482
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
336
483
|
* @param {*} [options] Override http request option.
|
|
@@ -340,7 +487,8 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
340
487
|
return localVarFp.getMessage(code, authorization, options).then((request) => request(axios, basePath));
|
|
341
488
|
},
|
|
342
489
|
/**
|
|
343
|
-
*
|
|
490
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
491
|
+
* @summary List the email message attachments
|
|
344
492
|
* @param {string} code
|
|
345
493
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
346
494
|
* @param {*} [options] Override http request option.
|
|
@@ -350,25 +498,64 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
350
498
|
return localVarFp.listAttachments(code, authorization, options).then((request) => request(axios, basePath));
|
|
351
499
|
},
|
|
352
500
|
/**
|
|
353
|
-
*
|
|
501
|
+
* 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\"
|
|
354
502
|
* @summary List email messages
|
|
355
503
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
356
504
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
357
505
|
* @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.
|
|
358
|
-
* @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>
|
|
506
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
359
507
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
360
508
|
* @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>
|
|
361
509
|
* @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>
|
|
362
|
-
* @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>
|
|
510
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
363
511
|
* @param {*} [options] Override http request option.
|
|
364
512
|
* @throws {RequiredError}
|
|
365
513
|
*/
|
|
366
514
|
listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass> {
|
|
367
515
|
return localVarFp.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
368
516
|
},
|
|
517
|
+
/**
|
|
518
|
+
* Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
519
|
+
* @summary Unassign an email message from its entity
|
|
520
|
+
* @param {string} code
|
|
521
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
522
|
+
* @param {*} [options] Override http request option.
|
|
523
|
+
* @throws {RequiredError}
|
|
524
|
+
*/
|
|
525
|
+
unassignEntity(code: string, authorization?: string, options?: any): AxiosPromise<UnassignEmailMessageEntityResponseClass> {
|
|
526
|
+
return localVarFp.unassignEntity(code, authorization, options).then((request) => request(axios, basePath));
|
|
527
|
+
},
|
|
369
528
|
};
|
|
370
529
|
};
|
|
371
530
|
|
|
531
|
+
/**
|
|
532
|
+
* Request parameters for assignEntity operation in EmailMessagesApi.
|
|
533
|
+
* @export
|
|
534
|
+
* @interface EmailMessagesApiAssignEntityRequest
|
|
535
|
+
*/
|
|
536
|
+
export interface EmailMessagesApiAssignEntityRequest {
|
|
537
|
+
/**
|
|
538
|
+
*
|
|
539
|
+
* @type {string}
|
|
540
|
+
* @memberof EmailMessagesApiAssignEntity
|
|
541
|
+
*/
|
|
542
|
+
readonly code: string
|
|
543
|
+
|
|
544
|
+
/**
|
|
545
|
+
*
|
|
546
|
+
* @type {AssignEmailMessageEntityBodyDto}
|
|
547
|
+
* @memberof EmailMessagesApiAssignEntity
|
|
548
|
+
*/
|
|
549
|
+
readonly assignEmailMessageEntityBodyDto: AssignEmailMessageEntityBodyDto
|
|
550
|
+
|
|
551
|
+
/**
|
|
552
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
553
|
+
* @type {string}
|
|
554
|
+
* @memberof EmailMessagesApiAssignEntity
|
|
555
|
+
*/
|
|
556
|
+
readonly authorization?: string
|
|
557
|
+
}
|
|
558
|
+
|
|
372
559
|
/**
|
|
373
560
|
* Request parameters for downloadAttachment operation in EmailMessagesApi.
|
|
374
561
|
* @export
|
|
@@ -467,7 +654,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
467
654
|
readonly pageToken?: string
|
|
468
655
|
|
|
469
656
|
/**
|
|
470
|
-
* 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>
|
|
657
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
471
658
|
* @type {string}
|
|
472
659
|
* @memberof EmailMessagesApiListEmailMessages
|
|
473
660
|
*/
|
|
@@ -495,13 +682,34 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
495
682
|
readonly expand?: string
|
|
496
683
|
|
|
497
684
|
/**
|
|
498
|
-
* 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>
|
|
685
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, threadCode, entityType, entityCode, entityNumber, direction, deliveryStatus, fromAddress, subject, notificationRequestId, sentAt, receivedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
499
686
|
* @type {string}
|
|
500
687
|
* @memberof EmailMessagesApiListEmailMessages
|
|
501
688
|
*/
|
|
502
689
|
readonly filters?: string
|
|
503
690
|
}
|
|
504
691
|
|
|
692
|
+
/**
|
|
693
|
+
* Request parameters for unassignEntity operation in EmailMessagesApi.
|
|
694
|
+
* @export
|
|
695
|
+
* @interface EmailMessagesApiUnassignEntityRequest
|
|
696
|
+
*/
|
|
697
|
+
export interface EmailMessagesApiUnassignEntityRequest {
|
|
698
|
+
/**
|
|
699
|
+
*
|
|
700
|
+
* @type {string}
|
|
701
|
+
* @memberof EmailMessagesApiUnassignEntity
|
|
702
|
+
*/
|
|
703
|
+
readonly code: string
|
|
704
|
+
|
|
705
|
+
/**
|
|
706
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
707
|
+
* @type {string}
|
|
708
|
+
* @memberof EmailMessagesApiUnassignEntity
|
|
709
|
+
*/
|
|
710
|
+
readonly authorization?: string
|
|
711
|
+
}
|
|
712
|
+
|
|
505
713
|
/**
|
|
506
714
|
* EmailMessagesApi - object-oriented interface
|
|
507
715
|
* @export
|
|
@@ -510,7 +718,20 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
510
718
|
*/
|
|
511
719
|
export class EmailMessagesApi extends BaseAPI {
|
|
512
720
|
/**
|
|
513
|
-
*
|
|
721
|
+
* 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\"
|
|
722
|
+
* @summary Assign an email message to an entity
|
|
723
|
+
* @param {EmailMessagesApiAssignEntityRequest} requestParameters Request parameters.
|
|
724
|
+
* @param {*} [options] Override http request option.
|
|
725
|
+
* @throws {RequiredError}
|
|
726
|
+
* @memberof EmailMessagesApi
|
|
727
|
+
*/
|
|
728
|
+
public assignEntity(requestParameters: EmailMessagesApiAssignEntityRequest, options?: AxiosRequestConfig) {
|
|
729
|
+
return EmailMessagesApiFp(this.configuration).assignEntity(requestParameters.code, requestParameters.assignEmailMessageEntityBodyDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
730
|
+
}
|
|
731
|
+
|
|
732
|
+
/**
|
|
733
|
+
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
734
|
+
* @summary Download the email message attachment
|
|
514
735
|
* @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
|
|
515
736
|
* @param {*} [options] Override http request option.
|
|
516
737
|
* @throws {RequiredError}
|
|
@@ -521,7 +742,8 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
521
742
|
}
|
|
522
743
|
|
|
523
744
|
/**
|
|
524
|
-
*
|
|
745
|
+
* Retrieves the details of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
746
|
+
* @summary Retrieve the email message
|
|
525
747
|
* @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
|
|
526
748
|
* @param {*} [options] Override http request option.
|
|
527
749
|
* @throws {RequiredError}
|
|
@@ -532,7 +754,8 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
532
754
|
}
|
|
533
755
|
|
|
534
756
|
/**
|
|
535
|
-
*
|
|
757
|
+
* Returns the attachments of the email message with the given code. **Required Permissions** \"notification-management.email-messages.view\"
|
|
758
|
+
* @summary List the email message attachments
|
|
536
759
|
* @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
|
|
537
760
|
* @param {*} [options] Override http request option.
|
|
538
761
|
* @throws {RequiredError}
|
|
@@ -543,7 +766,7 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
543
766
|
}
|
|
544
767
|
|
|
545
768
|
/**
|
|
546
|
-
*
|
|
769
|
+
* 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\"
|
|
547
770
|
* @summary List email messages
|
|
548
771
|
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
549
772
|
* @param {*} [options] Override http request option.
|
|
@@ -553,4 +776,16 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
553
776
|
public listEmailMessages(requestParameters: EmailMessagesApiListEmailMessagesRequest = {}, options?: AxiosRequestConfig) {
|
|
554
777
|
return EmailMessagesApiFp(this.configuration).listEmailMessages(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
555
778
|
}
|
|
779
|
+
|
|
780
|
+
/**
|
|
781
|
+
* Removes the entity link from the email message and marks it as unassigned. The message stays in its thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
782
|
+
* @summary Unassign an email message from its entity
|
|
783
|
+
* @param {EmailMessagesApiUnassignEntityRequest} requestParameters Request parameters.
|
|
784
|
+
* @param {*} [options] Override http request option.
|
|
785
|
+
* @throws {RequiredError}
|
|
786
|
+
* @memberof EmailMessagesApi
|
|
787
|
+
*/
|
|
788
|
+
public unassignEntity(requestParameters: EmailMessagesApiUnassignEntityRequest, options?: AxiosRequestConfig) {
|
|
789
|
+
return EmailMessagesApiFp(this.configuration).unassignEntity(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
790
|
+
}
|
|
556
791
|
}
|