@emilgroup/notification-sdk 0.8.1-beta.38 → 0.8.1-beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +0 -8
- package/README.md +2 -2
- package/api/email-messages-api.ts +24 -259
- package/api/email-tracking-api.ts +24 -32
- package/api/email-verifications-api.ts +8 -16
- package/api/layouts-api.ts +36 -56
- package/api/notification-templates-api.ts +36 -56
- package/api/notifications-api.ts +4 -115
- package/api.ts +0 -2
- package/dist/api/email-messages-api.d.ts +24 -158
- package/dist/api/email-messages-api.js +22 -225
- package/dist/api/email-tracking-api.d.ts +24 -32
- package/dist/api/email-tracking-api.js +22 -30
- package/dist/api/email-verifications-api.d.ts +8 -16
- package/dist/api/email-verifications-api.js +8 -16
- package/dist/api/layouts-api.d.ts +36 -56
- package/dist/api/layouts-api.js +32 -52
- package/dist/api/notification-templates-api.d.ts +36 -56
- package/dist/api/notification-templates-api.js +32 -52
- package/dist/api/notifications-api.d.ts +4 -65
- package/dist/api/notifications-api.js +4 -101
- package/dist/api.d.ts +0 -1
- package/dist/api.js +0 -1
- package/dist/models/email-message-class.d.ts +2 -49
- package/dist/models/email-message-class.js +2 -16
- package/dist/models/index.d.ts +0 -7
- package/dist/models/index.js +0 -7
- package/dist/models/send-notification-request-dto.d.ts +0 -9
- package/dist/models/send-notification-request-dto.js +1 -2
- package/models/email-message-class.ts +3 -53
- package/models/index.ts +0 -7
- package/models/send-notification-request-dto.ts +1 -8
- package/package.json +1 -1
- package/api/msgraph-webhooks-api.ts +0 -278
- package/dist/api/msgraph-webhooks-api.d.ts +0 -168
- package/dist/api/msgraph-webhooks-api.js +0 -305
- package/dist/models/assign-email-message-entity-body-dto.d.ts +0 -43
- package/dist/models/assign-email-message-entity-body-dto.js +0 -22
- package/dist/models/assign-email-message-entity-response-class.d.ts +0 -25
- package/dist/models/assign-email-message-entity-response-class.js +0 -15
- package/dist/models/grpc-send-email-request-dto.d.ts +0 -137
- package/dist/models/grpc-send-email-request-dto.js +0 -22
- package/dist/models/inline-attachment-dto.d.ts +0 -36
- package/dist/models/inline-attachment-dto.js +0 -15
- package/dist/models/send-email-request-dto.d.ts +0 -131
- package/dist/models/send-email-request-dto.js +0 -22
- package/dist/models/send-email-response-class.d.ts +0 -24
- package/dist/models/send-email-response-class.js +0 -15
- package/dist/models/unassign-email-message-entity-response-class.d.ts +0 -25
- package/dist/models/unassign-email-message-entity-response-class.js +0 -15
- package/models/assign-email-message-entity-body-dto.ts +0 -52
- package/models/assign-email-message-entity-response-class.ts +0 -31
- package/models/grpc-send-email-request-dto.ts +0 -144
- package/models/inline-attachment-dto.ts +0 -42
- package/models/send-email-request-dto.ts +0 -138
- package/models/send-email-response-class.ts +0 -30
- package/models/unassign-email-message-entity-response-class.ts +0 -31
package/.openapi-generator/FILES
CHANGED
|
@@ -8,7 +8,6 @@ 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
|
|
12
11
|
api/notification-templates-api.ts
|
|
13
12
|
api/notifications-api.ts
|
|
14
13
|
base.ts
|
|
@@ -16,8 +15,6 @@ common.ts
|
|
|
16
15
|
configuration.ts
|
|
17
16
|
git_push.sh
|
|
18
17
|
index.ts
|
|
19
|
-
models/assign-email-message-entity-body-dto.ts
|
|
20
|
-
models/assign-email-message-entity-response-class.ts
|
|
21
18
|
models/complete-email-verification-dto.ts
|
|
22
19
|
models/complete-email-verification-response-class.ts
|
|
23
20
|
models/create-layout-request-dto.ts
|
|
@@ -36,12 +33,10 @@ models/get-layout-request-dto.ts
|
|
|
36
33
|
models/get-layout-response-class.ts
|
|
37
34
|
models/get-notification-template-request-dto.ts
|
|
38
35
|
models/get-notification-template-response-class.ts
|
|
39
|
-
models/grpc-send-email-request-dto.ts
|
|
40
36
|
models/html-template-class.ts
|
|
41
37
|
models/index.ts
|
|
42
38
|
models/initiate-email-verification-dto.ts
|
|
43
39
|
models/initiate-email-verification-response-class.ts
|
|
44
|
-
models/inline-attachment-dto.ts
|
|
45
40
|
models/inline-response200.ts
|
|
46
41
|
models/inline-response503.ts
|
|
47
42
|
models/layout-class.ts
|
|
@@ -52,11 +47,8 @@ models/list-layouts-response-class.ts
|
|
|
52
47
|
models/list-notification-templates-response-class.ts
|
|
53
48
|
models/notification-template-class.ts
|
|
54
49
|
models/s3-document-dto.ts
|
|
55
|
-
models/send-email-request-dto.ts
|
|
56
|
-
models/send-email-response-class.ts
|
|
57
50
|
models/send-notification-request-dto.ts
|
|
58
51
|
models/send-notification-response-class.ts
|
|
59
|
-
models/unassign-email-message-entity-response-class.ts
|
|
60
52
|
models/update-html-template-request-dto.ts
|
|
61
53
|
models/update-layout-request-dto.ts
|
|
62
54
|
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.4 --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.4
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import ``.
|
|
@@ -21,10 +21,6 @@ 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
|
|
28
24
|
import { DownloadAttachmentResponseClass } from '../models';
|
|
29
25
|
// @ts-ignore
|
|
30
26
|
import { GetEmailMessageResponseClass } from '../models';
|
|
@@ -32,8 +28,6 @@ import { GetEmailMessageResponseClass } from '../models';
|
|
|
32
28
|
import { ListEmailAttachmentsResponseClass } from '../models';
|
|
33
29
|
// @ts-ignore
|
|
34
30
|
import { ListEmailMessagesResponseClass } from '../models';
|
|
35
|
-
// @ts-ignore
|
|
36
|
-
import { UnassignEmailMessageEntityResponseClass } from '../models';
|
|
37
31
|
/**
|
|
38
32
|
* EmailMessagesApi - axios parameter creator
|
|
39
33
|
* @export
|
|
@@ -41,59 +35,7 @@ import { UnassignEmailMessageEntityResponseClass } from '../models';
|
|
|
41
35
|
export const EmailMessagesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
42
36
|
return {
|
|
43
37
|
/**
|
|
44
|
-
*
|
|
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
|
|
38
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
97
39
|
* @param {string} code
|
|
98
40
|
* @param {number} attachmentId
|
|
99
41
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -141,8 +83,7 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
141
83
|
};
|
|
142
84
|
},
|
|
143
85
|
/**
|
|
144
|
-
*
|
|
145
|
-
* @summary Retrieve the email message
|
|
86
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
146
87
|
* @param {string} code
|
|
147
88
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
148
89
|
* @param {*} [options] Override http request option.
|
|
@@ -186,8 +127,7 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
186
127
|
};
|
|
187
128
|
},
|
|
188
129
|
/**
|
|
189
|
-
*
|
|
190
|
-
* @summary List the email message attachments
|
|
130
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
191
131
|
* @param {string} code
|
|
192
132
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
133
|
* @param {*} [options] Override http request option.
|
|
@@ -231,16 +171,16 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
231
171
|
};
|
|
232
172
|
},
|
|
233
173
|
/**
|
|
234
|
-
*
|
|
174
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
235
175
|
* @summary List email messages
|
|
236
176
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
237
177
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
238
178
|
* @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.
|
|
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,
|
|
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>
|
|
240
180
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
241
181
|
* @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>
|
|
242
182
|
* @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>
|
|
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,
|
|
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>
|
|
244
184
|
* @param {*} [options] Override http request option.
|
|
245
185
|
* @throws {RequiredError}
|
|
246
186
|
*/
|
|
@@ -297,51 +237,6 @@ export const EmailMessagesApiAxiosParamCreator = function (configuration?: Confi
|
|
|
297
237
|
|
|
298
238
|
|
|
299
239
|
|
|
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
|
-
|
|
345
240
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
346
241
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
347
242
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -362,21 +257,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
362
257
|
const localVarAxiosParamCreator = EmailMessagesApiAxiosParamCreator(configuration)
|
|
363
258
|
return {
|
|
364
259
|
/**
|
|
365
|
-
*
|
|
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
|
|
260
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
380
261
|
* @param {string} code
|
|
381
262
|
* @param {number} attachmentId
|
|
382
263
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -388,8 +269,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
388
269
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
389
270
|
},
|
|
390
271
|
/**
|
|
391
|
-
*
|
|
392
|
-
* @summary Retrieve the email message
|
|
272
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
393
273
|
* @param {string} code
|
|
394
274
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
395
275
|
* @param {*} [options] Override http request option.
|
|
@@ -400,8 +280,7 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
400
280
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
401
281
|
},
|
|
402
282
|
/**
|
|
403
|
-
*
|
|
404
|
-
* @summary List the email message attachments
|
|
283
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
405
284
|
* @param {string} code
|
|
406
285
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
407
286
|
* @param {*} [options] Override http request option.
|
|
@@ -412,16 +291,16 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
412
291
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
413
292
|
},
|
|
414
293
|
/**
|
|
415
|
-
*
|
|
294
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
416
295
|
* @summary List email messages
|
|
417
296
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
418
297
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
419
298
|
* @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.
|
|
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,
|
|
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>
|
|
421
300
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
422
301
|
* @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>
|
|
423
302
|
* @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>
|
|
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,
|
|
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>
|
|
425
304
|
* @param {*} [options] Override http request option.
|
|
426
305
|
* @throws {RequiredError}
|
|
427
306
|
*/
|
|
@@ -429,18 +308,6 @@ export const EmailMessagesApiFp = function(configuration?: Configuration) {
|
|
|
429
308
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
430
309
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
431
310
|
},
|
|
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
|
-
},
|
|
444
311
|
}
|
|
445
312
|
};
|
|
446
313
|
|
|
@@ -452,20 +319,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
452
319
|
const localVarFp = EmailMessagesApiFp(configuration)
|
|
453
320
|
return {
|
|
454
321
|
/**
|
|
455
|
-
*
|
|
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
|
|
322
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
469
323
|
* @param {string} code
|
|
470
324
|
* @param {number} attachmentId
|
|
471
325
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -476,8 +330,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
476
330
|
return localVarFp.downloadAttachment(code, attachmentId, authorization, options).then((request) => request(axios, basePath));
|
|
477
331
|
},
|
|
478
332
|
/**
|
|
479
|
-
*
|
|
480
|
-
* @summary Retrieve the email message
|
|
333
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
481
334
|
* @param {string} code
|
|
482
335
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
483
336
|
* @param {*} [options] Override http request option.
|
|
@@ -487,8 +340,7 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
487
340
|
return localVarFp.getMessage(code, authorization, options).then((request) => request(axios, basePath));
|
|
488
341
|
},
|
|
489
342
|
/**
|
|
490
|
-
*
|
|
491
|
-
* @summary List the email message attachments
|
|
343
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
492
344
|
* @param {string} code
|
|
493
345
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
494
346
|
* @param {*} [options] Override http request option.
|
|
@@ -498,64 +350,25 @@ export const EmailMessagesApiFactory = function (configuration?: Configuration,
|
|
|
498
350
|
return localVarFp.listAttachments(code, authorization, options).then((request) => request(axios, basePath));
|
|
499
351
|
},
|
|
500
352
|
/**
|
|
501
|
-
*
|
|
353
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
502
354
|
* @summary List email messages
|
|
503
355
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
504
356
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
505
357
|
* @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.
|
|
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,
|
|
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>
|
|
507
359
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
508
360
|
* @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>
|
|
509
361
|
* @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>
|
|
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,
|
|
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>
|
|
511
363
|
* @param {*} [options] Override http request option.
|
|
512
364
|
* @throws {RequiredError}
|
|
513
365
|
*/
|
|
514
366
|
listEmailMessages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailMessagesResponseClass> {
|
|
515
367
|
return localVarFp.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
516
368
|
},
|
|
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
|
-
},
|
|
528
369
|
};
|
|
529
370
|
};
|
|
530
371
|
|
|
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
|
-
|
|
559
372
|
/**
|
|
560
373
|
* Request parameters for downloadAttachment operation in EmailMessagesApi.
|
|
561
374
|
* @export
|
|
@@ -654,7 +467,7 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
654
467
|
readonly pageToken?: string
|
|
655
468
|
|
|
656
469
|
/**
|
|
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,
|
|
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>
|
|
658
471
|
* @type {string}
|
|
659
472
|
* @memberof EmailMessagesApiListEmailMessages
|
|
660
473
|
*/
|
|
@@ -682,34 +495,13 @@ export interface EmailMessagesApiListEmailMessagesRequest {
|
|
|
682
495
|
readonly expand?: string
|
|
683
496
|
|
|
684
497
|
/**
|
|
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,
|
|
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>
|
|
686
499
|
* @type {string}
|
|
687
500
|
* @memberof EmailMessagesApiListEmailMessages
|
|
688
501
|
*/
|
|
689
502
|
readonly filters?: string
|
|
690
503
|
}
|
|
691
504
|
|
|
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
|
-
|
|
713
505
|
/**
|
|
714
506
|
* EmailMessagesApi - object-oriented interface
|
|
715
507
|
* @export
|
|
@@ -718,20 +510,7 @@ export interface EmailMessagesApiUnassignEntityRequest {
|
|
|
718
510
|
*/
|
|
719
511
|
export class EmailMessagesApi extends BaseAPI {
|
|
720
512
|
/**
|
|
721
|
-
*
|
|
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
|
|
513
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
735
514
|
* @param {EmailMessagesApiDownloadAttachmentRequest} requestParameters Request parameters.
|
|
736
515
|
* @param {*} [options] Override http request option.
|
|
737
516
|
* @throws {RequiredError}
|
|
@@ -742,8 +521,7 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
742
521
|
}
|
|
743
522
|
|
|
744
523
|
/**
|
|
745
|
-
*
|
|
746
|
-
* @summary Retrieve the email message
|
|
524
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
747
525
|
* @param {EmailMessagesApiGetMessageRequest} requestParameters Request parameters.
|
|
748
526
|
* @param {*} [options] Override http request option.
|
|
749
527
|
* @throws {RequiredError}
|
|
@@ -754,8 +532,7 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
754
532
|
}
|
|
755
533
|
|
|
756
534
|
/**
|
|
757
|
-
*
|
|
758
|
-
* @summary List the email message attachments
|
|
535
|
+
* undefined **Required Permissions** \"notification-management.email-messages.view\"
|
|
759
536
|
* @param {EmailMessagesApiListAttachmentsRequest} requestParameters Request parameters.
|
|
760
537
|
* @param {*} [options] Override http request option.
|
|
761
538
|
* @throws {RequiredError}
|
|
@@ -766,7 +543,7 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
766
543
|
}
|
|
767
544
|
|
|
768
545
|
/**
|
|
769
|
-
*
|
|
546
|
+
* Lists all email messages with optional filters **Required Permissions** \"notification-management.email-messages.view\"
|
|
770
547
|
* @summary List email messages
|
|
771
548
|
* @param {EmailMessagesApiListEmailMessagesRequest} requestParameters Request parameters.
|
|
772
549
|
* @param {*} [options] Override http request option.
|
|
@@ -776,16 +553,4 @@ export class EmailMessagesApi extends BaseAPI {
|
|
|
776
553
|
public listEmailMessages(requestParameters: EmailMessagesApiListEmailMessagesRequest = {}, options?: AxiosRequestConfig) {
|
|
777
554
|
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));
|
|
778
555
|
}
|
|
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
|
-
}
|
|
791
556
|
}
|