@emilgroup/notification-sdk 0.8.1-beta.38 → 0.8.1-beta.39
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 +4 -3
- package/README.md +2 -2
- package/api/email-messages-api.ts +0 -223
- package/api/email-tracking-api.ts +231 -8
- package/dist/api/email-messages-api.d.ts +0 -122
- package/dist/api/email-messages-api.js +0 -191
- package/dist/api/email-tracking-api.d.ts +130 -8
- package/dist/api/email-tracking-api.js +197 -6
- package/dist/models/{assign-email-message-entity-body-dto.d.ts → assign-email-thread-entity-body-dto.d.ts} +9 -9
- package/dist/models/{assign-email-message-entity-body-dto.js → assign-email-thread-entity-body-dto.js} +2 -2
- package/dist/models/{assign-email-message-entity-response-class.d.ts → assign-email-thread-entity-response-class.d.ts} +7 -7
- package/dist/models/email-message-class.d.ts +4 -9
- package/dist/models/email-thread-class.d.ts +6 -5
- package/dist/models/entity-ref-class.d.ts +37 -0
- package/dist/models/entity-ref-class.js +22 -0
- package/dist/models/grpc-send-email-request-dto.d.ts +1 -1
- package/dist/models/index.d.ts +4 -3
- package/dist/models/index.js +4 -3
- package/dist/models/send-email-request-dto.d.ts +1 -1
- package/dist/models/send-notification-request-dto.d.ts +1 -1
- package/dist/models/{unassign-email-message-entity-response-class.d.ts → unassign-email-thread-entity-response-class.d.ts} +7 -7
- package/models/{assign-email-message-entity-body-dto.ts → assign-email-thread-entity-body-dto.ts} +9 -9
- package/models/{assign-email-message-entity-response-class.ts → assign-email-thread-entity-response-class.ts} +7 -7
- package/models/email-message-class.ts +4 -9
- package/models/email-thread-class.ts +6 -5
- package/models/entity-ref-class.ts +46 -0
- package/models/grpc-send-email-request-dto.ts +1 -1
- package/models/index.ts +4 -3
- package/models/send-email-request-dto.ts +1 -1
- package/models/send-notification-request-dto.ts +1 -1
- package/models/{unassign-email-message-entity-response-class.ts → unassign-email-thread-entity-response-class.ts} +7 -7
- package/package.json +1 -1
- /package/dist/models/{assign-email-message-entity-response-class.js → assign-email-thread-entity-response-class.js} +0 -0
- /package/dist/models/{unassign-email-message-entity-response-class.js → unassign-email-thread-entity-response-class.js} +0 -0
|
@@ -92,59 +92,6 @@ var base_1 = require("../base");
|
|
|
92
92
|
var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
|
-
/**
|
|
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
95
|
/**
|
|
149
96
|
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
150
97
|
* @summary Download the email message attachment
|
|
@@ -365,54 +312,6 @@ var EmailMessagesApiAxiosParamCreator = function (configuration) {
|
|
|
365
312
|
});
|
|
366
313
|
});
|
|
367
314
|
},
|
|
368
|
-
/**
|
|
369
|
-
* 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\"
|
|
370
|
-
* @summary Unassign an email message from its entity
|
|
371
|
-
* @param {string} code
|
|
372
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
373
|
-
* @param {*} [options] Override http request option.
|
|
374
|
-
* @throws {RequiredError}
|
|
375
|
-
*/
|
|
376
|
-
unassignEntity: function (code, authorization, options) {
|
|
377
|
-
if (options === void 0) { options = {}; }
|
|
378
|
-
return __awaiter(_this, void 0, void 0, function () {
|
|
379
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
380
|
-
return __generator(this, function (_a) {
|
|
381
|
-
switch (_a.label) {
|
|
382
|
-
case 0:
|
|
383
|
-
// verify required parameter 'code' is not null or undefined
|
|
384
|
-
(0, common_1.assertParamExists)('unassignEntity', 'code', code);
|
|
385
|
-
localVarPath = "/notificationservice/v1/email-messages/{code}/entity"
|
|
386
|
-
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
387
|
-
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
388
|
-
if (configuration) {
|
|
389
|
-
baseOptions = configuration.baseOptions;
|
|
390
|
-
baseAccessToken = configuration.accessToken;
|
|
391
|
-
}
|
|
392
|
-
localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), options);
|
|
393
|
-
localVarHeaderParameter = {};
|
|
394
|
-
localVarQueryParameter = {};
|
|
395
|
-
// authentication bearer required
|
|
396
|
-
// http bearer authentication required
|
|
397
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
398
|
-
case 1:
|
|
399
|
-
// authentication bearer required
|
|
400
|
-
// http bearer authentication required
|
|
401
|
-
_a.sent();
|
|
402
|
-
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
403
|
-
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
404
|
-
}
|
|
405
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
406
|
-
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
407
|
-
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
408
|
-
return [2 /*return*/, {
|
|
409
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
410
|
-
options: localVarRequestOptions,
|
|
411
|
-
}];
|
|
412
|
-
}
|
|
413
|
-
});
|
|
414
|
-
});
|
|
415
|
-
},
|
|
416
315
|
};
|
|
417
316
|
};
|
|
418
317
|
exports.EmailMessagesApiAxiosParamCreator = EmailMessagesApiAxiosParamCreator;
|
|
@@ -423,28 +322,6 @@ exports.EmailMessagesApiAxiosParamCreator = EmailMessagesApiAxiosParamCreator;
|
|
|
423
322
|
var EmailMessagesApiFp = function (configuration) {
|
|
424
323
|
var localVarAxiosParamCreator = (0, exports.EmailMessagesApiAxiosParamCreator)(configuration);
|
|
425
324
|
return {
|
|
426
|
-
/**
|
|
427
|
-
* 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\"
|
|
428
|
-
* @summary Assign an email message to an entity
|
|
429
|
-
* @param {string} code
|
|
430
|
-
* @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
|
|
431
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
432
|
-
* @param {*} [options] Override http request option.
|
|
433
|
-
* @throws {RequiredError}
|
|
434
|
-
*/
|
|
435
|
-
assignEntity: function (code, assignEmailMessageEntityBodyDto, authorization, options) {
|
|
436
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
437
|
-
var localVarAxiosArgs;
|
|
438
|
-
return __generator(this, function (_a) {
|
|
439
|
-
switch (_a.label) {
|
|
440
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.assignEntity(code, assignEmailMessageEntityBodyDto, authorization, options)];
|
|
441
|
-
case 1:
|
|
442
|
-
localVarAxiosArgs = _a.sent();
|
|
443
|
-
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
444
|
-
}
|
|
445
|
-
});
|
|
446
|
-
});
|
|
447
|
-
},
|
|
448
325
|
/**
|
|
449
326
|
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
450
327
|
* @summary Download the email message attachment
|
|
@@ -536,27 +413,6 @@ var EmailMessagesApiFp = function (configuration) {
|
|
|
536
413
|
});
|
|
537
414
|
});
|
|
538
415
|
},
|
|
539
|
-
/**
|
|
540
|
-
* 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\"
|
|
541
|
-
* @summary Unassign an email message from its entity
|
|
542
|
-
* @param {string} code
|
|
543
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
544
|
-
* @param {*} [options] Override http request option.
|
|
545
|
-
* @throws {RequiredError}
|
|
546
|
-
*/
|
|
547
|
-
unassignEntity: function (code, authorization, options) {
|
|
548
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
549
|
-
var localVarAxiosArgs;
|
|
550
|
-
return __generator(this, function (_a) {
|
|
551
|
-
switch (_a.label) {
|
|
552
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.unassignEntity(code, authorization, options)];
|
|
553
|
-
case 1:
|
|
554
|
-
localVarAxiosArgs = _a.sent();
|
|
555
|
-
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
556
|
-
}
|
|
557
|
-
});
|
|
558
|
-
});
|
|
559
|
-
},
|
|
560
416
|
};
|
|
561
417
|
};
|
|
562
418
|
exports.EmailMessagesApiFp = EmailMessagesApiFp;
|
|
@@ -567,18 +423,6 @@ exports.EmailMessagesApiFp = EmailMessagesApiFp;
|
|
|
567
423
|
var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
568
424
|
var localVarFp = (0, exports.EmailMessagesApiFp)(configuration);
|
|
569
425
|
return {
|
|
570
|
-
/**
|
|
571
|
-
* 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\"
|
|
572
|
-
* @summary Assign an email message to an entity
|
|
573
|
-
* @param {string} code
|
|
574
|
-
* @param {AssignEmailMessageEntityBodyDto} assignEmailMessageEntityBodyDto
|
|
575
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
576
|
-
* @param {*} [options] Override http request option.
|
|
577
|
-
* @throws {RequiredError}
|
|
578
|
-
*/
|
|
579
|
-
assignEntity: function (code, assignEmailMessageEntityBodyDto, authorization, options) {
|
|
580
|
-
return localVarFp.assignEntity(code, assignEmailMessageEntityBodyDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
581
|
-
},
|
|
582
426
|
/**
|
|
583
427
|
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
584
428
|
* @summary Download the email message attachment
|
|
@@ -630,17 +474,6 @@ var EmailMessagesApiFactory = function (configuration, basePath, axios) {
|
|
|
630
474
|
listEmailMessages: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
631
475
|
return localVarFp.listEmailMessages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
632
476
|
},
|
|
633
|
-
/**
|
|
634
|
-
* 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\"
|
|
635
|
-
* @summary Unassign an email message from its entity
|
|
636
|
-
* @param {string} code
|
|
637
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
638
|
-
* @param {*} [options] Override http request option.
|
|
639
|
-
* @throws {RequiredError}
|
|
640
|
-
*/
|
|
641
|
-
unassignEntity: function (code, authorization, options) {
|
|
642
|
-
return localVarFp.unassignEntity(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
643
|
-
},
|
|
644
477
|
};
|
|
645
478
|
};
|
|
646
479
|
exports.EmailMessagesApiFactory = EmailMessagesApiFactory;
|
|
@@ -655,18 +488,6 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
655
488
|
function EmailMessagesApi() {
|
|
656
489
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
657
490
|
}
|
|
658
|
-
/**
|
|
659
|
-
* 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\"
|
|
660
|
-
* @summary Assign an email message to an entity
|
|
661
|
-
* @param {EmailMessagesApiAssignEntityRequest} requestParameters Request parameters.
|
|
662
|
-
* @param {*} [options] Override http request option.
|
|
663
|
-
* @throws {RequiredError}
|
|
664
|
-
* @memberof EmailMessagesApi
|
|
665
|
-
*/
|
|
666
|
-
EmailMessagesApi.prototype.assignEntity = function (requestParameters, options) {
|
|
667
|
-
var _this = this;
|
|
668
|
-
return (0, exports.EmailMessagesApiFp)(this.configuration).assignEntity(requestParameters.code, requestParameters.assignEmailMessageEntityBodyDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
669
|
-
};
|
|
670
491
|
/**
|
|
671
492
|
* Returns a download URL for the given attachment of the email message. **Required Permissions** \"notification-management.email-messages.view\"
|
|
672
493
|
* @summary Download the email message attachment
|
|
@@ -716,18 +537,6 @@ var EmailMessagesApi = /** @class */ (function (_super) {
|
|
|
716
537
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
717
538
|
return (0, exports.EmailMessagesApiFp)(this.configuration).listEmailMessages(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
718
539
|
};
|
|
719
|
-
/**
|
|
720
|
-
* 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\"
|
|
721
|
-
* @summary Unassign an email message from its entity
|
|
722
|
-
* @param {EmailMessagesApiUnassignEntityRequest} requestParameters Request parameters.
|
|
723
|
-
* @param {*} [options] Override http request option.
|
|
724
|
-
* @throws {RequiredError}
|
|
725
|
-
* @memberof EmailMessagesApi
|
|
726
|
-
*/
|
|
727
|
-
EmailMessagesApi.prototype.unassignEntity = function (requestParameters, options) {
|
|
728
|
-
var _this = this;
|
|
729
|
-
return (0, exports.EmailMessagesApiFp)(this.configuration).unassignEntity(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
730
|
-
};
|
|
731
540
|
return EmailMessagesApi;
|
|
732
541
|
}(base_1.BaseAPI));
|
|
733
542
|
exports.EmailMessagesApi = EmailMessagesApi;
|
|
@@ -12,14 +12,27 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { AssignEmailThreadEntityBodyDto } from '../models';
|
|
16
|
+
import { AssignEmailThreadEntityResponseClass } from '../models';
|
|
15
17
|
import { GetEmailThreadResponseClass } from '../models';
|
|
16
18
|
import { ListEmailMessagesResponseClass } from '../models';
|
|
17
19
|
import { ListEmailThreadsResponseClass } from '../models';
|
|
20
|
+
import { UnassignEmailThreadEntityResponseClass } from '../models';
|
|
18
21
|
/**
|
|
19
22
|
* EmailTrackingApi - axios parameter creator
|
|
20
23
|
* @export
|
|
21
24
|
*/
|
|
22
25
|
export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
|
+
/**
|
|
27
|
+
* Links the email thread, and every message in it, to the given entity, identified by code or by number (the code wins when both are set). Replaces the current link. The entity must exist. Messages that arrive in the thread later are linked to the same entity. **Required Permissions** \"notification-management.email-messages.update\"
|
|
28
|
+
* @summary Assign an email thread to an entity
|
|
29
|
+
* @param {string} code
|
|
30
|
+
* @param {AssignEmailThreadEntityBodyDto} assignEmailThreadEntityBodyDto
|
|
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, assignEmailThreadEntityBodyDto: AssignEmailThreadEntityBodyDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
23
36
|
/**
|
|
24
37
|
* Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
25
38
|
* @summary Close the email thread
|
|
@@ -57,21 +70,40 @@ export declare const EmailTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
57
70
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
71
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
72
|
* @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.
|
|
60
|
-
* @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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
73
|
+
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
61
74
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
62
75
|
* @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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
63
76
|
* @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: messages<i>
|
|
64
|
-
* @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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
77
|
+
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
65
78
|
* @param {*} [options] Override http request option.
|
|
66
79
|
* @throws {RequiredError}
|
|
67
80
|
*/
|
|
68
81
|
listThreads: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
82
|
+
/**
|
|
83
|
+
* Removes the entity link from the email thread and every message in it, and marks the messages as unassigned. **Required Permissions** \"notification-management.email-messages.update\"
|
|
84
|
+
* @summary Unassign an email thread from its entity
|
|
85
|
+
* @param {string} code
|
|
86
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
87
|
+
* @param {*} [options] Override http request option.
|
|
88
|
+
* @throws {RequiredError}
|
|
89
|
+
*/
|
|
90
|
+
unassignEntity: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
91
|
};
|
|
70
92
|
/**
|
|
71
93
|
* EmailTrackingApi - functional programming interface
|
|
72
94
|
* @export
|
|
73
95
|
*/
|
|
74
96
|
export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
|
|
97
|
+
/**
|
|
98
|
+
* Links the email thread, and every message in it, to the given entity, identified by code or by number (the code wins when both are set). Replaces the current link. The entity must exist. Messages that arrive in the thread later are linked to the same entity. **Required Permissions** \"notification-management.email-messages.update\"
|
|
99
|
+
* @summary Assign an email thread to an entity
|
|
100
|
+
* @param {string} code
|
|
101
|
+
* @param {AssignEmailThreadEntityBodyDto} assignEmailThreadEntityBodyDto
|
|
102
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
103
|
+
* @param {*} [options] Override http request option.
|
|
104
|
+
* @throws {RequiredError}
|
|
105
|
+
*/
|
|
106
|
+
assignEntity(code: string, assignEmailThreadEntityBodyDto: AssignEmailThreadEntityBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AssignEmailThreadEntityResponseClass>>;
|
|
75
107
|
/**
|
|
76
108
|
* Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
77
109
|
* @summary Close the email thread
|
|
@@ -109,21 +141,40 @@ export declare const EmailTrackingApiFp: (configuration?: Configuration) => {
|
|
|
109
141
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
110
142
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
111
143
|
* @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.
|
|
112
|
-
* @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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
144
|
+
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
113
145
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
114
146
|
* @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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
115
147
|
* @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: messages<i>
|
|
116
|
-
* @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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
148
|
+
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
117
149
|
* @param {*} [options] Override http request option.
|
|
118
150
|
* @throws {RequiredError}
|
|
119
151
|
*/
|
|
120
152
|
listThreads(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEmailThreadsResponseClass>>;
|
|
153
|
+
/**
|
|
154
|
+
* Removes the entity link from the email thread and every message in it, and marks the messages as unassigned. **Required Permissions** \"notification-management.email-messages.update\"
|
|
155
|
+
* @summary Unassign an email thread from its entity
|
|
156
|
+
* @param {string} code
|
|
157
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
158
|
+
* @param {*} [options] Override http request option.
|
|
159
|
+
* @throws {RequiredError}
|
|
160
|
+
*/
|
|
161
|
+
unassignEntity(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UnassignEmailThreadEntityResponseClass>>;
|
|
121
162
|
};
|
|
122
163
|
/**
|
|
123
164
|
* EmailTrackingApi - factory interface
|
|
124
165
|
* @export
|
|
125
166
|
*/
|
|
126
167
|
export declare const EmailTrackingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
168
|
+
/**
|
|
169
|
+
* Links the email thread, and every message in it, to the given entity, identified by code or by number (the code wins when both are set). Replaces the current link. The entity must exist. Messages that arrive in the thread later are linked to the same entity. **Required Permissions** \"notification-management.email-messages.update\"
|
|
170
|
+
* @summary Assign an email thread to an entity
|
|
171
|
+
* @param {string} code
|
|
172
|
+
* @param {AssignEmailThreadEntityBodyDto} assignEmailThreadEntityBodyDto
|
|
173
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
174
|
+
* @param {*} [options] Override http request option.
|
|
175
|
+
* @throws {RequiredError}
|
|
176
|
+
*/
|
|
177
|
+
assignEntity(code: string, assignEmailThreadEntityBodyDto: AssignEmailThreadEntityBodyDto, authorization?: string, options?: any): AxiosPromise<AssignEmailThreadEntityResponseClass>;
|
|
127
178
|
/**
|
|
128
179
|
* Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
129
180
|
* @summary Close the email thread
|
|
@@ -161,16 +212,50 @@ export declare const EmailTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
161
212
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
162
213
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
163
214
|
* @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.
|
|
164
|
-
* @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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
215
|
+
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
165
216
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
166
217
|
* @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, entityType, entityCode, subject, status, createdAt, updatedAt</i>
|
|
167
218
|
* @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: messages<i>
|
|
168
|
-
* @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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
219
|
+
* @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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
169
220
|
* @param {*} [options] Override http request option.
|
|
170
221
|
* @throws {RequiredError}
|
|
171
222
|
*/
|
|
172
223
|
listThreads(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListEmailThreadsResponseClass>;
|
|
224
|
+
/**
|
|
225
|
+
* Removes the entity link from the email thread and every message in it, and marks the messages as unassigned. **Required Permissions** \"notification-management.email-messages.update\"
|
|
226
|
+
* @summary Unassign an email thread from its entity
|
|
227
|
+
* @param {string} code
|
|
228
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
229
|
+
* @param {*} [options] Override http request option.
|
|
230
|
+
* @throws {RequiredError}
|
|
231
|
+
*/
|
|
232
|
+
unassignEntity(code: string, authorization?: string, options?: any): AxiosPromise<UnassignEmailThreadEntityResponseClass>;
|
|
173
233
|
};
|
|
234
|
+
/**
|
|
235
|
+
* Request parameters for assignEntity operation in EmailTrackingApi.
|
|
236
|
+
* @export
|
|
237
|
+
* @interface EmailTrackingApiAssignEntityRequest
|
|
238
|
+
*/
|
|
239
|
+
export interface EmailTrackingApiAssignEntityRequest {
|
|
240
|
+
/**
|
|
241
|
+
*
|
|
242
|
+
* @type {string}
|
|
243
|
+
* @memberof EmailTrackingApiAssignEntity
|
|
244
|
+
*/
|
|
245
|
+
readonly code: string;
|
|
246
|
+
/**
|
|
247
|
+
*
|
|
248
|
+
* @type {AssignEmailThreadEntityBodyDto}
|
|
249
|
+
* @memberof EmailTrackingApiAssignEntity
|
|
250
|
+
*/
|
|
251
|
+
readonly assignEmailThreadEntityBodyDto: AssignEmailThreadEntityBodyDto;
|
|
252
|
+
/**
|
|
253
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
254
|
+
* @type {string}
|
|
255
|
+
* @memberof EmailTrackingApiAssignEntity
|
|
256
|
+
*/
|
|
257
|
+
readonly authorization?: string;
|
|
258
|
+
}
|
|
174
259
|
/**
|
|
175
260
|
* Request parameters for closeThread operation in EmailTrackingApi.
|
|
176
261
|
* @export
|
|
@@ -277,7 +362,7 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
277
362
|
*/
|
|
278
363
|
readonly pageToken?: string;
|
|
279
364
|
/**
|
|
280
|
-
* 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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
365
|
+
* 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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
281
366
|
* @type {string}
|
|
282
367
|
* @memberof EmailTrackingApiListThreads
|
|
283
368
|
*/
|
|
@@ -301,12 +386,31 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
301
386
|
*/
|
|
302
387
|
readonly expand?: string;
|
|
303
388
|
/**
|
|
304
|
-
* 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, entityType, entityCode, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
389
|
+
* 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, entityType, entityCode, entityNumber, subject, status, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
305
390
|
* @type {string}
|
|
306
391
|
* @memberof EmailTrackingApiListThreads
|
|
307
392
|
*/
|
|
308
393
|
readonly filters?: string;
|
|
309
394
|
}
|
|
395
|
+
/**
|
|
396
|
+
* Request parameters for unassignEntity operation in EmailTrackingApi.
|
|
397
|
+
* @export
|
|
398
|
+
* @interface EmailTrackingApiUnassignEntityRequest
|
|
399
|
+
*/
|
|
400
|
+
export interface EmailTrackingApiUnassignEntityRequest {
|
|
401
|
+
/**
|
|
402
|
+
*
|
|
403
|
+
* @type {string}
|
|
404
|
+
* @memberof EmailTrackingApiUnassignEntity
|
|
405
|
+
*/
|
|
406
|
+
readonly code: string;
|
|
407
|
+
/**
|
|
408
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
409
|
+
* @type {string}
|
|
410
|
+
* @memberof EmailTrackingApiUnassignEntity
|
|
411
|
+
*/
|
|
412
|
+
readonly authorization?: string;
|
|
413
|
+
}
|
|
310
414
|
/**
|
|
311
415
|
* EmailTrackingApi - object-oriented interface
|
|
312
416
|
* @export
|
|
@@ -314,6 +418,15 @@ export interface EmailTrackingApiListThreadsRequest {
|
|
|
314
418
|
* @extends {BaseAPI}
|
|
315
419
|
*/
|
|
316
420
|
export declare class EmailTrackingApi extends BaseAPI {
|
|
421
|
+
/**
|
|
422
|
+
* Links the email thread, and every message in it, to the given entity, identified by code or by number (the code wins when both are set). Replaces the current link. The entity must exist. Messages that arrive in the thread later are linked to the same entity. **Required Permissions** \"notification-management.email-messages.update\"
|
|
423
|
+
* @summary Assign an email thread to an entity
|
|
424
|
+
* @param {EmailTrackingApiAssignEntityRequest} requestParameters Request parameters.
|
|
425
|
+
* @param {*} [options] Override http request option.
|
|
426
|
+
* @throws {RequiredError}
|
|
427
|
+
* @memberof EmailTrackingApi
|
|
428
|
+
*/
|
|
429
|
+
assignEntity(requestParameters: EmailTrackingApiAssignEntityRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AssignEmailThreadEntityResponseClass, any, {}>>;
|
|
317
430
|
/**
|
|
318
431
|
* Closes the email thread with the given code and returns the updated thread. **Required Permissions** \"notification-management.email-messages.update\"
|
|
319
432
|
* @summary Close the email thread
|
|
@@ -350,4 +463,13 @@ export declare class EmailTrackingApi extends BaseAPI {
|
|
|
350
463
|
* @memberof EmailTrackingApi
|
|
351
464
|
*/
|
|
352
465
|
listThreads(requestParameters?: EmailTrackingApiListThreadsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListEmailThreadsResponseClass, any, {}>>;
|
|
466
|
+
/**
|
|
467
|
+
* Removes the entity link from the email thread and every message in it, and marks the messages as unassigned. **Required Permissions** \"notification-management.email-messages.update\"
|
|
468
|
+
* @summary Unassign an email thread from its entity
|
|
469
|
+
* @param {EmailTrackingApiUnassignEntityRequest} requestParameters Request parameters.
|
|
470
|
+
* @param {*} [options] Override http request option.
|
|
471
|
+
* @throws {RequiredError}
|
|
472
|
+
* @memberof EmailTrackingApi
|
|
473
|
+
*/
|
|
474
|
+
unassignEntity(requestParameters: EmailTrackingApiUnassignEntityRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UnassignEmailThreadEntityResponseClass, any, {}>>;
|
|
353
475
|
}
|